module Mongo::Commands::ListIndexes

Overview

Returns information about the indexes on the specified collection.

Specifically, the command returns a document that contains information with which to create a cursor to the index information. Index information includes the keys and options used to create the index.

NOTE for more details, please check the official MongoDB documentation.

Extended Modules

• Mongo::Commands::Command
• Mongo::Commands::ListIndexes
• Mongo::Commands::ReadCommand
• Mongo::Commands::Retryable

Defined in:

cryomongo/commands/admin/list_indexes.cr

Class Method Summary

• .name

Instance Method Summary

• #command(database : String, collection : Collection::CollectionKey)

  Returns a pair of OP_MSG body and sequences associated with the command and arguments.

• #result(bson : BSON)

  Transforms the server result.

Class Method Detail

Instance Method Detail