Class: Couchbase::Management::QueryIndexManager::CreatePrimaryIndexOptions

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| ... } ⇒ CreatePrimaryIndexOptions

Returns a new instance of CreatePrimaryIndexOptions.

Yield Parameters:



222
223
224
225
# File 'lib/couchbase/management/query_index_manager.rb', line 222

def initialize
  @ignore_if_exists = false
  yield self if block_given?
end

Instance Attribute Details

#collection_nameString

Returns the name of the collection.

Returns:

  • (String)

    the name of the collection



219
220
221
# File 'lib/couchbase/management/query_index_manager.rb', line 219

def collection_name
  @collection_name
end

#deferredBoolean

Returns whether the index should be created as a deferred index.

Returns:

  • (Boolean)

    whether the index should be created as a deferred index.



210
211
212
# File 'lib/couchbase/management/query_index_manager.rb', line 210

def deferred
  @deferred
end

#ignore_if_existsBoolean

Returns do not raise error if the index already exist.

Returns:

  • (Boolean)

    do not raise error if the index already exist



204
205
206
# File 'lib/couchbase/management/query_index_manager.rb', line 204

def ignore_if_exists
  @ignore_if_exists
end

#index_nameString

Returns name of the index.

Returns:

  • (String)

    name of the index



201
202
203
# File 'lib/couchbase/management/query_index_manager.rb', line 201

def index_name
  @index_name
end

#num_replicasInteger

Returns the number of replicas that this index should have.

Returns:

  • (Integer)

    the number of replicas that this index should have



207
208
209
# File 'lib/couchbase/management/query_index_manager.rb', line 207

def num_replicas
  @num_replicas
end

#scope_nameString

Returns the name of the scope.

Returns:

  • (String)

    the name of the scope



216
217
218
# File 'lib/couchbase/management/query_index_manager.rb', line 216

def scope_name
  @scope_name
end

#timeoutInteger

Returns the time in milliseconds allowed for the operation to complete.

Returns:

  • (Integer)

    the time in milliseconds allowed for the operation to complete



213
214
215
# File 'lib/couchbase/management/query_index_manager.rb', line 213

def timeout
  @timeout
end