Class: Couchbase::Management::QueryIndex

Inherits:
Object
  • Object
show all
Defined in:
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:



337
338
339
# File 'lib/couchbase/management/query_index_manager.rb', line 337

def initialize
  yield self if block_given?
end

Instance Attribute Details

#bucketString?

Returns the name of the bucket.

Returns:

  • (String, nil)

    the name of the bucket



307
308
309
# File 'lib/couchbase/management/query_index_manager.rb', line 307

def bucket
  @bucket
end

#collectionString?

Returns the name of the collection.

Returns:

  • (String, nil)

    the name of the collection



313
314
315
# File 'lib/couchbase/management/query_index_manager.rb', line 313

def collection
  @collection
end

#conditionString

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.



334
335
336
# File 'lib/couchbase/management/query_index_manager.rb', line 334

def condition
  @condition
end

#index_keyArray<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.



326
327
328
# File 'lib/couchbase/management/query_index_manager.rb', line 326

def index_key
  @index_key
end

#is_primaryBoolean Also known as: primary?

Returns true if this is a primary index.

Returns:

  • (Boolean)

    true if this is a primary index



297
298
299
# File 'lib/couchbase/management/query_index_manager.rb', line 297

def is_primary
  @is_primary
end

#key_spaceString

Returns the key space for the index, typically the bucket name.

Returns:

  • (String)

    the key space for the index, typically the bucket name.



316
317
318
# File 'lib/couchbase/management/query_index_manager.rb', line 316

def key_space
  @key_space
end

#nameString

Returns name of the index.

Returns:

  • (String)

    name of the index



294
295
296
# File 'lib/couchbase/management/query_index_manager.rb', line 294

def name
  @name
end

#name_spaceString

Returns the namespace for the index. A namespace is a resource pool that contains multiple key spaces.

Returns:

  • (String)

    the namespace for the index. A namespace is a resource pool that contains multiple key spaces.



319
320
321
# File 'lib/couchbase/management/query_index_manager.rb', line 319

def name_space
  @name_space
end

#scopeString?

Returns the name of the scope.

Returns:

  • (String, nil)

    the name of the scope



310
311
312
# File 'lib/couchbase/management/query_index_manager.rb', line 310

def scope
  @scope
end

#stateSymbol

Returns state.

Returns:

  • (Symbol)

    state



304
305
306
# File 'lib/couchbase/management/query_index_manager.rb', line 304

def state
  @state
end

#type:gsi, :view

Returns type of the index.

Returns:

  • (:gsi, :view)

    type of the index



301
302
303
# File 'lib/couchbase/management/query_index_manager.rb', line 301

def type
  @type
end