Class: Couchbase::Management::SearchIndex
- Inherits:
-
Object
- Object
- Couchbase::Management::SearchIndex
- Defined in:
- lib/couchbase/management/search_index_manager.rb
Instance Attribute Summary collapse
-
#name ⇒ String
Name of the index.
-
#params ⇒ Hash
Index properties such as store type and mappings.
-
#plan_params ⇒ Hash
Plan properties such a number of replicas and number of partitions.
-
#source_name ⇒ String
Name of the source of the data for the index (e.g. bucket name).
-
#source_params ⇒ Hash
Extra parameters for the source.
-
#source_type ⇒ String
Type of the data source.
-
#source_uuid ⇒ String
The UUID of the ata source, this can be used to more tightly tie the index to a source.
-
#type ⇒ String
Type of the index.
-
#uuid ⇒ String
UUID is required for update.
Instance Method Summary collapse
-
#initialize {|self| ... } ⇒ SearchIndex
constructor
A new instance of SearchIndex.
Constructor Details
#initialize {|self| ... } ⇒ SearchIndex
Returns a new instance of SearchIndex.
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
#name ⇒ String
Returns name of the index.
375 376 377 |
# File 'lib/couchbase/management/search_index_manager.rb', line 375 def name @name end |
#params ⇒ Hash
Returns 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_params ⇒ Hash
Returns 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_name ⇒ String
Returns 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_params ⇒ Hash
Returns 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_type ⇒ String
Returns 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_uuid ⇒ String
Returns 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 |
#type ⇒ String
Returns type of the index.
378 379 380 |
# File 'lib/couchbase/management/search_index_manager.rb', line 378 def type @type end |
#uuid ⇒ String
Returns 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 |