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]

547
548
549
 
# File 'lib/couchbase/management/query_index_manager.rb', line 547

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


520
521
522
 
# File 'lib/couchbase/management/query_index_manager.rb', line 520

def bucket
  @bucket
end

#collection ⇒ String?

Returns the name of the collection.

Returns:

  • (String, nil) —

    the name of the collection


526
527
528
 
# File 'lib/couchbase/management/query_index_manager.rb', line 526

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.


541
542
543
 
# File 'lib/couchbase/management/query_index_manager.rb', line 541

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.


533
534
535
 
# File 'lib/couchbase/management/query_index_manager.rb', line 533

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


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

def is_primary
  @is_primary
end

#name ⇒ String

Returns name of the index.

Returns:

  • (String) —

    name of the index


507
508
509
 
# File 'lib/couchbase/management/query_index_manager.rb', line 507

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


544
545
546
 
# File 'lib/couchbase/management/query_index_manager.rb', line 544

def partition
  @partition
end

#scope ⇒ String?

Returns the name of the scope.

Returns:

  • (String, nil) —

    the name of the scope


523
524
525
 
# File 'lib/couchbase/management/query_index_manager.rb', line 523

def scope
  @scope
end

#state ⇒ Symbol

Returns state.

Returns:

  • (Symbol) —

    state


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

def state
  @state
end

#type ⇒ :gsi, :view

Returns type of the index.

Returns:

  • (:gsi, :view) —

    type of the index


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

def type
  @type
end