Class: Couchbase::Management::QueryIndexManager::CreateIndexOptions

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

Returns a new instance of CreateIndexOptions.

Yield Parameters:



193
194
195
196
# File 'lib/couchbase/management/query_index_manager.rb', line 193

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



190
191
192
# File 'lib/couchbase/management/query_index_manager.rb', line 190

def collection_name
  @collection_name
end

#conditionString

Returns condition to apply to the index.

Returns:

  • (String)

    condition to apply to the index



184
185
186
# File 'lib/couchbase/management/query_index_manager.rb', line 184

def condition
  @condition
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.



178
179
180
# File 'lib/couchbase/management/query_index_manager.rb', line 178

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



172
173
174
# File 'lib/couchbase/management/query_index_manager.rb', line 172

def ignore_if_exists
  @ignore_if_exists
end

#num_replicasInteger

Returns the number of replicas that this index should have.

Returns:

  • (Integer)

    the number of replicas that this index should have



175
176
177
# File 'lib/couchbase/management/query_index_manager.rb', line 175

def num_replicas
  @num_replicas
end

#scope_nameString

Returns the name of the scope.

Returns:

  • (String)

    the name of the scope



187
188
189
# File 'lib/couchbase/management/query_index_manager.rb', line 187

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



181
182
183
# File 'lib/couchbase/management/query_index_manager.rb', line 181

def timeout
  @timeout
end