Class: Couchbase::Management::Options::Query::DropIndex

Inherits:
Options::Base
  • Object
show all
Defined in:
lib/couchbase/management/query_index_manager.rb

Overview

Options for QueryIndexManager#drop_index

Instance Attribute Summary collapse

Attributes inherited from Options::Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(ignore_if_does_not_exist: false, scope_name: nil, collection_name: nil, timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|self| ... } ⇒ DropIndex

Creates an instance of options for QueryIndexManager#drop_index

Parameters:

  • ignore_if_does_not_exist (Boolean) (defaults to: false) —

    do not raise error if the index does not exist

  • scope_name (String, nil) (defaults to: nil) —

    the name of the scope

  • collection_name (String, nil) (defaults to: nil) —

    the name of the collection

  • timeout (Integer, #in_milliseconds, nil) (defaults to: nil) —

    the time in milliseconds allowed for the operation to complete

  • retry_strategy (Proc, nil) (defaults to: nil) —

    the custom retry strategy, if set

  • client_context (Hash, nil) (defaults to: nil) —

    the client context data, if set

  • parent_span (Span, nil) (defaults to: nil) —

    if set holds the parent span, that should be used for this request

Yield Parameters:



197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/couchbase/management/query_index_manager.rb', line 197

def initialize(ignore_if_does_not_exist: false,
               scope_name: nil,
               collection_name: nil,
               timeout: nil,
               retry_strategy: nil,
               client_context: nil,
               parent_span: nil)
  super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)
  @ignore_if_does_not_exist = ignore_if_does_not_exist
  @scope_name = scope_name
  @collection_name = collection_name
  yield self if block_given?
end

Instance Attribute Details

#collection_name ⇒ String?

Returns:

  • (String, nil) 


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

def collection_name
  @collection_name
end

#ignore_if_does_not_exist ⇒ Boolean

Returns:

  • (Boolean) 


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

def ignore_if_does_not_exist
  @ignore_if_does_not_exist
end

#scope_name ⇒ String?

Returns:

  • (String, nil) 


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

def scope_name
  @scope_name
end

Instance Method Details

#to_backend ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



212
213
214
215
216
217
218
219
 
# File 'lib/couchbase/management/query_index_manager.rb', line 212

def to_backend
  {
    timeout: Utils::Time.extract_duration(@timeout),
    ignore_if_does_not_exist: @ignore_if_does_not_exist,
    scope_name: @scope_name,
    collection_name: @collection_name,
  }
end