Class: Couchbase::Management::SearchIndex

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/management/search_index_manager.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|self| ... } ⇒ SearchIndex

Returns a new instance of SearchIndex.

Yield Parameters:



402
403
404
405
406
# File 'lib/couchbase/management/search_index_manager.rb', line 402

def initialize
  @type = "fulltext-index"
  @source_type = "couchbase"
  yield self if block_given?
end

Instance Attribute Details

#nameString

Returns name of the index.

Returns:

  • (String)

    name of the index



375
376
377
# File 'lib/couchbase/management/search_index_manager.rb', line 375

def name
  @name
end

#paramsHash

Returns index properties such as store type and mappings.

Returns:

  • (Hash)

    index properties such as store type and mappings



384
385
386
# File 'lib/couchbase/management/search_index_manager.rb', line 384

def params
  @params
end

#plan_paramsHash

Returns plan properties such a number of replicas and number of partitions.

Returns:

  • (Hash)

    plan properties such a number of replicas and number of partitions



399
400
401
# File 'lib/couchbase/management/search_index_manager.rb', line 399

def plan_params
  @plan_params
end

#source_nameString

Returns name of the source of the data for the index (e.g. bucket name).

Returns:

  • (String)

    name of the source of the data for the index (e.g. bucket name)



387
388
389
# File 'lib/couchbase/management/search_index_manager.rb', line 387

def source_name
  @source_name
end

#source_paramsHash

Returns extra parameters for the source. These are usually things like advanced connection and tuning.

Returns:

  • (Hash)

    extra parameters for the source. These are usually things like advanced connection and tuning.



396
397
398
# File 'lib/couchbase/management/search_index_manager.rb', line 396

def source_params
  @source_params
end

#source_typeString

Returns type of the data source.

Returns:

  • (String)

    type of the data source



390
391
392
# File 'lib/couchbase/management/search_index_manager.rb', line 390

def source_type
  @source_type
end

#source_uuidString

Returns the UUID of the ata source, this can be used to more tightly tie the index to a source.

Returns:

  • (String)

    the UUID of the ata source, this can be used to more tightly tie the index to a source



393
394
395
# File 'lib/couchbase/management/search_index_manager.rb', line 393

def source_uuid
  @source_uuid
end

#typeString

Returns type of the index.

Returns:

  • (String)

    type of the index



378
379
380
# File 'lib/couchbase/management/search_index_manager.rb', line 378

def type
  @type
end

#uuidString

Returns UUID is required for update. It provides means of ensuring consistency.

Returns:

  • (String)

    UUID is required for update. It provides means of ensuring consistency.



381
382
383
# File 'lib/couchbase/management/search_index_manager.rb', line 381

def uuid
  @uuid
end