Class: Couchbase::Management::QueryIndex

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/management/query_index_manager.rb,
/Users/sergey.auseyau/code/couchbase-ruby-client/lib/couchbase/management/query_index_manager.rb more...

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of QueryIndex.

Yield Parameters:

[View source]

517
518
519
 
# File 'lib/couchbase/management/query_index_manager.rb', line 517

def initialize
  yield self if block_given?
end

Instance Attribute Details

#bucket ⇒ String?

Returns the name of the bucket.

Returns:

  • (String, nil) —

    the name of the bucket


490
491
492
 
# File 'lib/couchbase/management/query_index_manager.rb', line 490

def bucket
  @bucket
end

#collection ⇒ String?

Returns the name of the collection.

Returns:

  • (String, nil) —

    the name of the collection


496
497
498
 
# File 'lib/couchbase/management/query_index_manager.rb', line 496

def collection
  @collection
end

#condition ⇒ String

Note:

that the query service can present the condition in a slightly different manner from when you declared the index. For instance it will wrap expressions with parentheses and show the fields in an escaped format (surrounded by backticks).

Returns the string representation of the index’s condition (the WHERE clause of the index), or an empty Optional if no condition was set.

Returns:

  • (String) —

    the string representation of the index’s condition (the WHERE clause of the index), or an empty Optional if no condition was set.


511
512
513
 
# File 'lib/couchbase/management/query_index_manager.rb', line 511

def condition
  @condition
end

#index_key ⇒ Array<String>

Note:

the query service can present the key in a slightly different manner from when you declared the index: for instance, it will show the indexed fields in an escaped format (surrounded by backticks).

Returns an array of Strings that represent the index key(s). The array is empty in the case of a PRIMARY INDEX.

Returns:

  • (Array<String>) —

    an array of Strings that represent the index key(s). The array is empty in the case of a PRIMARY INDEX.


503
504
505
 
# File 'lib/couchbase/management/query_index_manager.rb', line 503

def index_key
  @index_key
end

#is_primary ⇒ Boolean Also known as: primary?

Returns true if this is a primary index.

Returns:

  • (Boolean) —

    true if this is a primary index


480
481
482
 
# File 'lib/couchbase/management/query_index_manager.rb', line 480

def is_primary
  @is_primary
end

#name ⇒ String

Returns name of the index.

Returns:

  • (String) —

    name of the index


477
478
479
 
# File 'lib/couchbase/management/query_index_manager.rb', line 477

def name
  @name
end

#partition ⇒ String

Returns the string representation of the index’s partition.

Returns:

  • (String) —

    the string representation of the index’s partition


514
515
516
 
# File 'lib/couchbase/management/query_index_manager.rb', line 514

def partition
  @partition
end

#scope ⇒ String?

Returns the name of the scope.

Returns:

  • (String, nil) —

    the name of the scope


493
494
495
 
# File 'lib/couchbase/management/query_index_manager.rb', line 493

def scope
  @scope
end

#state ⇒ Symbol

Returns state.

Returns:

  • (Symbol) —

    state


487
488
489
 
# File 'lib/couchbase/management/query_index_manager.rb', line 487

def state
  @state
end

#type ⇒ :gsi, :view

Returns type of the index.

Returns:

  • (:gsi, :view) —

    type of the index


484
485
486
 
# File 'lib/couchbase/management/query_index_manager.rb', line 484

def type
  @type
end