Class: Couchbase::Management::QueryIndex

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of QueryIndex.

Yield Parameters:



614
615
616
 
# File 'lib/couchbase/management/query_index_manager.rb', line 614

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



587
588
589
 
# File 'lib/couchbase/management/query_index_manager.rb', line 587

def bucket
  @bucket
end

#collection ⇒ String?

Returns the name of the collection.

Returns:

  • (String, nil) —

    the name of the collection



593
594
595
 
# File 'lib/couchbase/management/query_index_manager.rb', line 593

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.



608
609
610
 
# File 'lib/couchbase/management/query_index_manager.rb', line 608

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.



600
601
602
 
# File 'lib/couchbase/management/query_index_manager.rb', line 600

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



577
578
579
 
# File 'lib/couchbase/management/query_index_manager.rb', line 577

def is_primary
  @is_primary
end

#name ⇒ String

Returns name of the index.

Returns:

  • (String) —

    name of the index



574
575
576
 
# File 'lib/couchbase/management/query_index_manager.rb', line 574

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



611
612
613
 
# File 'lib/couchbase/management/query_index_manager.rb', line 611

def partition
  @partition
end

#scope ⇒ String?

Returns the name of the scope.

Returns:

  • (String, nil) —

    the name of the scope



590
591
592
 
# File 'lib/couchbase/management/query_index_manager.rb', line 590

def scope
  @scope
end

#state ⇒ Symbol

Returns state.

Returns:

  • (Symbol) —

    state



584
585
586
 
# File 'lib/couchbase/management/query_index_manager.rb', line 584

def state
  @state
end

#type ⇒ :gsi, :view

Returns type of the index.

Returns:

  • (:gsi, :view) —

    type of the index



581
582
583
 
# File 'lib/couchbase/management/query_index_manager.rb', line 581

def type
  @type
end