class Mongo::Index::View
A class representing a view of indexes.
@since 2.0.0
Constants
- KEY
-
The index key field.
@since 2.0.0
- NAME
-
The index name field.
@since 2.0.0
- OPTIONS
-
The mappings of Ruby index options to server options.
@since 2.0.0
Attributes
@return [ Integer ] batch_size
The size of the batch of results
when sending the listIndexes command.
@return [ Collection
] collection The indexes collection.
Public Class Methods
Source
# File lib/mongo/index/view.rb, line 271 def initialize(collection, options = {}) @collection = collection @batch_size = options[:batch_size] @options = options end
Create the new index view.
@example Create the new index view.
View::Index.new(collection)
@param [ Collection
] collection The collection. @param [ Hash ] options Options
for getting a list of indexes.
Only relevant for when the listIndexes command is used with server versions >=2.8.
@option options [ Integer ] :batch_size The batch size for results
returned from the listIndexes command.
@since 2.0.0
Public Instance Methods
Source
# File lib/mongo/index/view.rb, line 173 def create_many(*models) client.send(:with_session, @options) do |session| server = next_primary(nil, session) models = models.flatten options = {} if models && !models.last.key?(:key) options = models.pop end # While server versions 3.4 and newer generally perform option # validation, there was a bug on server versions 4.2.0 - 4.2.5 where # the server would accept the commitQuorum option and use it internally # (see SERVER-47193). As a result, the drivers specifications require # drivers to perform validation and raise an error when the commitQuorum # option is passed to servers that don't support it. description = server.with_connection { |connection| connection.description } if description.max_wire_version < 9 && options[:commit_quorum] raise Error::UnsupportedOption.commit_quorum_error end indexes = normalize_models(models, server) indexes.each do |index| if index[:bucketSize] || index['bucketSize'] client.log_warn("Haystack indexes (bucketSize index option) are deprecated as of MongoDB 4.4") end end spec = { indexes: indexes, db_name: database.name, coll_name: collection.name, session: session, commit_quorum: options[:commit_quorum] } spec[:write_concern] = write_concern if description.features.collation_enabled? Operation::CreateIndex.new(spec).execute(server, client: client) end end
Creates multiple indexes on the collection.
@example Create multiple indexes.
view.create_many([ { key: { name: 1 }, unique: true }, { key: { age: -1 }, background: true } ])
@example Create multiple indexes with options.
view.create_many( { key: { name: 1 }, unique: true }, { key: { age: -1 }, background: true }, { commit_quorum: 'majority' } )
@note On MongoDB 3.0.0 and higher, the indexes will be created in
parallel on the server.
@param [ Array<Hash> ] models The index specifications. Each model MUST
include a :key option, except for the last item in the Array, which may be a Hash specifying options relevant to the createIndexes operation. The following options are accepted: - commit_quorum: Specify how many data-bearing members of a replica set, including the primary, must complete the index builds successfully before the primary marks the indexes as ready.
@return [ Result ] The result of the command.
@since 2.0.0
Source
# File lib/mongo/index/view.rb, line 137 def create_one(keys, options = {}) options = options.dup create_options = { commit_quorum: options.delete(:commit_quorum) } create_many({ key: keys }.merge(options), create_options) end
Creates an index on the collection.
@example Create a unique index on the collection.
view.create_one({ name: 1 }, { unique: true })
@param [ Hash ] keys A hash of field name/direction pairs. @param [ Hash ] options Options
for this index.
@option options [ true, false ] :unique (false) If true, this index will enforce
a uniqueness constraint on that field.
@option options [ true, false ] :background (false) If true, the index will be built
in the background (only available for server versions >= 1.3.2 )
@option options [ true, false ] :drop_dups (false) If creating a unique index on
this collection, this option will keep the first document the database indexes and drop all subsequent documents with duplicate values on this field.
@option options [ Integer ] :bucket_size (nil) For use with geoHaystack indexes.
Number of documents to group together within a certain proximity to a given longitude and latitude.
@option options [ Integer ] :max (nil) Specify the max latitude and longitude for
a geo index.
@option options [ Integer ] :min (nil) Specify the min latitude and longitude for
a geo index.
@option options [ Hash ] :partial_filter_expression Specify a filter for a partial
index.
@option options [ Boolean ] :hidden When :hidden is true, this index will
exist on the collection but not be used by the query planner when executing operations.
@option options [ String | Integer ] :commit_quorum Specify how many
data-bearing members of a replica set, including the primary, must complete the index builds successfully before the primary marks the indexes as ready.
@note Note that the options listed may be subset of those available. See the MongoDB documentation for a full list of supported options by server version.
@return [ Result ] The response.
@since 2.0.0
Source
# File lib/mongo/index/view.rb, line 95 def drop_all drop_by_name(Index::ALL) end
Drop all indexes on the collection.
@example Drop all indexes on the collection.
view.drop_all
@return [ Result ] The response.
@since 2.0.0
Source
# File lib/mongo/index/view.rb, line 82 def drop_one(name) raise Error::MultiIndexDrop.new if name == Index::ALL drop_by_name(name) end
Drop an index by its name.
@example Drop an index by its name.
view.drop_one('name_1')
@param [ String ] name The name of the index.
@return [ Result ] The response.
@since 2.0.0
Source
# File lib/mongo/index/view.rb, line 243 def each(&block) session = client.send(:get_session, @options) cursor = read_with_retry_cursor(session, ServerSelector.primary, self) do |server| send_initial_query(server, session) end if block_given? cursor.each do |doc| yield doc end else cursor.to_enum end end
Iterate over all indexes for the collection.
@example Get all the indexes.
view.each do |index| ... end
@since 2.0.0
Source
# File lib/mongo/index/view.rb, line 229 def get(keys_or_name) find do |index| (index[NAME] == keys_or_name) || (index[KEY] == normalize_keys(keys_or_name)) end end
Convenience method for getting index information by a specific name or spec.
@example Get index information by name.
view.get('name_1')
@example Get index information by the keys.
view.get(name: 1)
@param [ Hash, String ] keys_or_name The index name or spec.
@return [ Hash ] The index information.
@since 2.0.0
Private Instance Methods
Source
# File lib/mongo/index/view.rb, line 279 def drop_by_name(name) client.send(:with_session, @options) do |session| spec = { db_name: database.name, coll_name: collection.name, index_name: name, session: session } server = next_primary(nil, session) spec[:write_concern] = write_concern if server.with_connection { |connection| connection.features }.collation_enabled? Operation::DropIndex.new(spec).execute(server, client: client) end end
Source
# File lib/mongo/index/view.rb, line 293 def index_name(spec) spec.to_a.join('_') end
Source
# File lib/mongo/index/view.rb, line 297 def indexes_spec(session) { selector: { listIndexes: collection.name, cursor: batch_size ? { batchSize: batch_size } : {} }, coll_name: collection.name, db_name: database.name, session: session } end
Source
# File lib/mongo/index/view.rb, line 307 def initial_query_op(session) Operation::Indexes.new(indexes_spec(session)) end
Source
# File lib/mongo/index/view.rb, line 313 def normalize_keys(spec) return false if spec.is_a?(String) Options::Mapper.transform_keys_to_strings(spec) end
Source
# File lib/mongo/index/view.rb, line 318 def normalize_models(models, server) with_generated_names(models, server).map do |model| Options::Mapper.transform(model, OPTIONS) end end
Source
# File lib/mongo/index/view.rb, line 324 def send_initial_query(server, session) initial_query_op(session).execute(server, client: client) end
Source
# File lib/mongo/index/view.rb, line 337 def validate_collation!(model, server) if (model[:collation] || model[Operation::COLLATION]) && !server.with_connection { |connection| connection.features }.collation_enabled? raise Error::UnsupportedCollation.new end end
Source
# File lib/mongo/index/view.rb, line 328 def with_generated_names(models, server) models.dup.each do |model| validate_collation!(model, server) unless model[:name] model[:name] = index_name(model[:key]) end end end