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:

[View source]

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

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

Instance Attribute Details

#condition ⇒ String

Returns condition to apply to the index.

Returns:

  • (String) —

    condition to apply to the index


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

def condition
  @condition
end

#deferred ⇒ Boolean

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

Returns:

  • (Boolean) —

    whether the index should be created as a deferred index.


165
166
167
 
# File 'lib/couchbase/management/query_index_manager.rb', line 165

def deferred
  @deferred
end

#ignore_if_exists ⇒ Boolean

Returns do not raise error if the index already exist.

Returns:

  • (Boolean) —

    do not raise error if the index already exist


159
160
161
 
# File 'lib/couchbase/management/query_index_manager.rb', line 159

def ignore_if_exists
  @ignore_if_exists
end

#num_replicas ⇒ Integer

Returns the number of replicas that this index should have.

Returns:

  • (Integer) —

    the number of replicas that this index should have


162
163
164
 
# File 'lib/couchbase/management/query_index_manager.rb', line 162

def num_replicas
  @num_replicas
end

#timeout ⇒ Integer

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

Returns:

  • (Integer) —

    the time in milliseconds allowed for the operation to complete


168
169
170
 
# File 'lib/couchbase/management/query_index_manager.rb', line 168

def timeout
  @timeout
end