Menu Docs
Página inicial do Docs
/
Manual do MongoDB
/ / /

db.collection.createIndexes()

Nesta página

  • Definição
  • Compatibilidade
  • Stable API
  • Opções
  • Opções para todos os tipos de índice
  • Opção para agrupamento
  • Opções para Índices text
  • Opções para Índices 2dsphere
  • Opções para Índices 2d
  • Opções para Índices wildcard
  • Comportamentos
  • Recriando um Índice Existente
  • Opções de índice
  • Índices curinga
  • Transações
  • Construções de índices
  • Exemplo
  • Criar índices sem opções
  • Criar índices com agrupamento especificado
  • Criar um Índice Curinga
  • Criar índices com quorum para o commit
  • Criar múltiplos índices
  • Informações adicionais

MongoDB com drivers

Esta página documenta um método mongosh. Para ver o método equivalente em um driver MongoDB, consulte a página correspondente da sua linguagem de programação:

C#Java SyncNode.jsPyMongoCC++GoJava RSKotlin CoroutineKotlin SyncPHPMotorMongoidRustScalaSwift
db.collection.createIndexes( [ keyPatterns ], options, commitQuorum )

Cria um ou mais índices em uma coleção.

Para minimizar o impacto da criação de um índice em conjunto de réplicas e clusters fragmentados, use um procedimento de compilação de índice contínuo, conforme descrito em Rolling Index Builds on Replica Sets.

db.collection.createIndexes() recebe os seguintes parâmetros:

Parâmetro
Tipo
Descrição
keyPatterns
documento

Um array contendo documentos de especificação de índice. Cada documento contém pares de campo e valor, onde o campo é a chave do índice e o valor descreve o tipo de índice para aquele campo. Para um índice ascendente em um campo, especifique um valor de 1; para índice descendente, especifique um valor de -1.

O MongoDB suporta vários tipos de índice diferentes, incluindo:

Consulte os tipos de índice para obter mais informações.

Índices Curinga suportam cargas de trabalho em que os usuários fazem query nos campos personalizados ou uma grande variedade de campos em uma coleção:

  • Você pode criar um índice curinga em um campo específico e seus subcaminhos ou em todos os campos de um documento.

    Para obter detalhes, consulte Índices Curinga.

options
documento
Opcional. Um documento que contém um conjunto de opções que controla a criação dos índices. Consulte Opções para detalhes.
inteiro ou string

Opcional. O número mínimo de nós do conjunto de réplicas de votação contendo dados (ou seja, commit quorum), incluindo o primário, que deve relatar uma construção de índice bem-sucedida antes que o primário marque o indexes como pronto. Um nó"votante" é qualquer nó do conjunto de réplicas em que members[n].votes é maior que 0.

suporta os seguintes valores:

  • "votingMembers" - todos os membros do conjunto de réplicas de votos com dados (Padrão).

  • "majority" - uma maioria simples dos membros do conjunto de réplicas de votos portadores de dados.

  • <int> - um número específico de membros do conjunto de réplicas de votação com dados.

  • 0 - Desativa o comportamento de votação em quórum. Os membros iniciam a construção do índice simultaneamente, mas não votam nem esperam pelo quorum antes de concluírem a construção do índice. Se você iniciar uma construção de índice com um quorum para o commit de 0, não poderá modificar posteriormente o quorum de confirmação usando setIndexCommitQuorum.

  • Um nome de tag do conjunto de réplicas.

Esse método está disponível em implantações hospedadas nos seguintes ambientes:

  • MongoDB Atlas: o serviço totalmente gerenciado para implantações do MongoDB na nuvem

Observação

Este comando é suportado em todos os clusters do MongoDB Atlas . Para obter informações sobre o suporte do Atlas para todos os comandos, consulte Comandos não suportados.

  • MongoDB Enterprise: a versão autogerenciada e baseada em assinatura do MongoDB

  • MongoDB Community: uma versão com código disponível, de uso gratuito e autogerenciada do MongoDB

Ao usar a API estável V1:

  • Você não pode especificar nenhum dos seguintes campos no documento options:

    • background

    • bucketSize

    • sparse

    • storageEngine

  • Você não pode criar índices geoHaystack ou texto.

  • Os tipos de índice não suportados acima são ignorados pelo planejador de query no modo strict. Por exemplo, tentar usar um índice sparse com cursor.hint() resultará no seguinte erro BadValue :

    planner returned error :: caused by :: hint provided does not
    correspond to an existing index

O documento options contém um conjunto de opções que controlam a criação dos índices. Diferentes tipos de índice podem ter opções adicionais específicas para esse tipo.

Várias opções de índice podem ser especificadas no mesmo documento. Entretanto, se você especificar vários documentos de opção, a operação db.collection.createIndexes() falhará.

Considere a seguinte operação do db.collection.createIndexes():

db.collection.createIndexes(
[
{
"a": 1
},
{
"b": 1
}
],
{
unique: true,
sparse: true,
expireAfterSeconds: 3600
}
)

Se a especificação de opções tivesse sido dividida em vários documentos como este: { unique: true }, { sparse: true, expireAfterSeconds: 3600 }, a operação de criação do índice teria falhado.

Importante

Quando você especifica opções para db.collection.createIndexes(), elas se aplicam a todos os índices especificados. Por exemplo, se você especificar uma opção de agrupamento, todos os índices criados o incluirão.

db.collection.createIndexes() retornará um erro se você tentar criar índices com opções incompatíveis ou muitos argumentos. Consulte as descrições das opções para obter mais informações.

As opções a seguir estão disponíveis para todos os tipos de índice, a menos que especificado de outra forma:

Parâmetro
Tipo
Descrição
unique
booleano

Opcional. Especifica que cada índice especificado no array keyPatterns é um índice único. Os índices únicos não aceitarão a inserção ou atualização de documentos em que o valor da chave do índice corresponda a um valor existente no índice.

Especifique true para criar um índice único. O valor padrão é false.

A opção está indisponível para índices com hash.

name
string

Opcional. O nome do índice. Se não for especificado, o MongoDB gera um nome de índice concatenando os nomes dos campos indexados e a ordem de classificação.

As opções especificadas em db.collection.createIndexes() se aplicam a todas as especificações de índice incluídas na array de padrão de chave. Como os nomes de índice devem ser exclusivos, você só pode especificar o nome se estiver criando um único índice usando db.collection.createIndexes().

partialFilterExpression
documento

Opcional. Se especificado, os índices fazem referência apenas a documentos que correspondem à expressão de filtro. Consulte Índices parciais para obter mais informações.

Uma expressão de filtro pode incluir:

Você pode especificar uma opção partialFilterExpression para todos os tipos de índiceMongoDB.

sparse
booleano

Opcional. Se true, os índices referenciam somente documentos com os campos especificados. Esses índices usam menos espaço, mas se comportam de maneira diferente em algumas situações (principalmente em classificações). O valor padrão é false. Consulte Índices esparsos para obter mais informações.

Os seguintes tipos de índice são escassos por padrão e ignoram esta opção:

Para um índice composto que inclui 2dsphere chaves de índice e chaves para outros tipos, somente os campos de índice 2dsphere determinam se o índice faz referência a um documento.

Os índices parciais têm um superconjunto da funcionalidade de sparse index. A menos que seu aplicativo tenha um requisito específico, use índices parciais em vez de índices esparsos.

expireAfterSeconds
inteiro

Opcional. Especifica um valor, em segundos, como um tempo de vida(TTL) para controlar por quanto tempo o MongoDB retém documentos na coleção. Esta opção se aplica somente aos índices TTL. Consulte Expirar dados de coleções configurando TTL para obter mais informações.

Se você usa índices TTL criados antes do MongoDB 5.0 ou se deseja sincronizar dados criados no MongDB 5.0 com um pré-5.0 instalação, consulte Índices configurados usando NaN para evitar problemas de configuração incorreta.

O valor expireAfterSeconds do índice TTL deve estar dentro de 0 e 2147483647 inclusive.

booleano

Opcional. Um sinalizador que determina se o índice está hidden do planejador de queries. Um índice oculto não é avaliado como parte da seleção do plano de query.

O padrão é false.

storageEngine
documento

Opcional. Permite que os usuários configurem o mecanismo de armazenamento para os índices criados.

A opção storageEngine deve receber o seguinte formulário:

storageEngine: { <storage-engine-name>: <options> }

As opções de configuração do mecanismo de armazenamento especificadas ao criar índices são validadas e registradas no oplog durante a replicação para suportar conjuntos de réplicas com membros que usam mecanismos de armazenamento diferentes.

Parâmetro
Tipo
Descrição
collation
documento

Opcional. Especifica o agrupamento do índice.

A colocação permite que os usuários especifiquem regras específicas do idioma para comparação de strings, como regras para letras maiúsculas e marcas de acento.

Se você especificou um agrupamento no nível da coleção, então:

  • Se você não especificar um agrupamento ao criar o índice, o MongoDB criará o índice com o agrupamento padrão da coleção.

  • Se você especificar um agrupamento ao criar o índice, o MongoDB criará o índice com o agrupamento especificado.

A opção de agrupamento tem a seguinte sintaxe:

collation: {
locale: <string>,
caseLevel: <boolean>,
caseFirst: <string>,
strength: <int>,
numericOrdering: <boolean>,
alternate: <string>,
maxVariable: <string>,
backwards: <boolean>
}

Ao especificar agrupamento, o campo locale é obrigatório; todos os outros campos de agrupamento são opcionais. Para obter descrições dos campos, consulte Documento de agrupamento.

Os índices a seguir oferecem suporte apenas à comparação binária simples e não oferecem suporte ao agrupamento:

Dica

Para criar um índice text ou 2d em uma collection que tem um agrupamento não simples, você deve especificar explicitamente {collation: {locale: "simple"} } ao criar o índice.

Se você especificou um agrupamento no nível da coleção, então:

  • Se você não especificar um agrupamento ao criar o índice, o MongoDB criará o índice com o agrupamento padrão da coleção.

  • Se você especificar um agrupamento ao criar o índice, o MongoDB criará o índice com o agrupamento especificado.

Dica

Ao especificar um agrupamento strength de 1 ou 2, você pode criar um índice que não diferencia maiúsculas de minúsculas. O índice com um agrupamento strength de 1 não diferencia letras diacríticas e maiúsculas de minúsculas.

Você pode criar vários índices na(s) mesma(s) chave(s) com diferentes agrupamentos. Para criar indexes com o mesmo padrão de chave, mas com agrupamentos diferentes, você deve fornecer nomes de índice exclusivos.

Para usar um índice para comparações de strings, uma operação também deve especificar o mesmo agrupamento. Ou seja, um índice com ordenação não pode suportar uma operação que executa comparações de strings nos campos indexados se a operação especificar uma ordenação diferente.

Aviso

Porque os índices configurados com agrupamento usam ICU. chaves de agrupamento para obter a ordem de classificação, chaves de índice com reconhecimento de agrupamento pode ser maior do que as chaves de índice para índices sem agrupamento.

Por exemplo, a coleta myColl possui um índice em um campo de sequência category com o código do idioma de ordenação "fr".

db.myColl.createIndex( { category: 1 }, { collation: { locale: "fr" } } )

A seguinte operação de consulta, que especifica o mesmo agrupamento que o índice, pode usar o índice:

db.myColl.find( { category: "cafe" } ).collation( { locale: "fr" } )

No entanto, a seguinte operação de consulta, que por padrão usa o agrupador binário "simples", não pode usar o índice:

db.myColl.find( { category: "cafe" } )

Para um índice composto em que as chaves de prefixo do índice não são strings, matrizes e documentos incorporados, uma operação que especifica um agrupamento diferente ainda pode usar o índice para dar suporte a comparações nas chaves de prefixo do índice.

Por exemplo, a coleta myColl possui um índice composto nos campos numéricos score e price e no campo de string category; o índice é criado com a localidade de ordenação "fr" para comparações de strings:

db.myColl.createIndex(
{ score: 1, price: 1, category: 1 },
{ collation: { locale: "fr" } } )

As operações a seguir, que usam agrupamento binário "simple" para comparações de strings, podem usar o índice:

db.myColl.find( { score: 5 } ).sort( { price: 1 } )
db.myColl.find( { score: 5, price: { $gt: NumberDecimal( "10" ) } } ).sort( { price: 1 } )

A operação a seguir, que usa agrupamento binário "simple" para comparações de strings no campo category indexado, pode usar o índice para preencher apenas a parte score: 5 da query:

db.myColl.find( { score: 5, category: "cafe" } )

Importante

As correspondências com chaves de documentos, incluindo chaves de documentos incorporadas, usam uma comparação binária simples. Isto significa que uma query para uma chave como "foo.bár" não corresponderá à chave "foo.bar", independente do valor definido para o parâmetro de força.

As seguintes opções estão disponíveis apenas para índices de texto:

Parâmetro
Tipo
Descrição
weights
documento

Opcional. Para índices de texto, um documento que contém pares de peso e campo. O peso é um número inteiro que varia de 1 a 99.999 e denota a importância do campo em relação aos outros campos indexados em termos de pontuação. Você pode especificar pesos para alguns ou todos os campos indexados. Consulte Atribuir pesos aos resultados da pesquisa de texto em implantações autogerenciadas para ajustar as pontuações. O valor padrão é 1.

Iniciando no MongoDB 5.0, a opção pesos é permitida somente para índices de texto.

default_language
string
Opcional. Para índices de texto, o idioma que determina a lista de palavras de interrupção e as regras para o stemmer e o tokenizador. Consulte Idiomas de pesquisa de texto em implantações autogerenciadas para os idiomas disponíveis e Especificar idioma padrão para um índice de texto em implantações autogerenciadas para obter mais informações e exemplos. O valor padrão é english.
language_override
string
Opcional. Para índices de texto, o nome do campo, nos documentos da coleção, que contém o idioma de substituição do documento. O valor padrão é language. Consulte Especificar o idioma padrão para um índice de texto em implantações autogerenciadas para obter um exemplo.
textIndexVersion
inteiro

Opcional. O número da versão do índice text. Os usuários podem usar essa opção para substituir o número da versão padrão.

Para ver as versões disponíveis, consulte Versões de índice de texto em implantações autogerenciadas.

A seguinte opção está disponível apenas para índices de 2dsphere:

Parâmetro
Tipo
Descrição
2dsphereIndexVersion
inteiro

Opcional. O número da versão do índice 2dsphere. Os usuários podem usar essa opção para substituir o número da versão padrão.

Para as versões disponíveis, consulte Índices do 2dsphere.

As seguintes opções estão disponíveis somente para índices 2d:

Parâmetro
Tipo
Descrição
bits
inteiro

Opcional. Para índices do 2d, o número de precisão do valor geohash armazenado dos dados de localização.

O valor de bits varia de 1 a 32, inclusive. O valor padrão é 26.

min
número
Opcional. Para índices do 2d, o limite de inclusão inferior para os valores de longitude e latitude. O valor padrão é -180.0.
max
número
Opcional. Para índices do 2d, o limite de inclusão superior para os valores de longitude e latitude. O valor padrão é 180.0.

A opção a seguir está disponível somente para índices coringa :

Parâmetro
Tipo
Descrição
wildcardProjection
documento

Opcional. Permite que os usuários incluam ou excluam caminho do campo específicos de um índice curinga.

Essa opção só é válida quando você cria um índice Curinga em todos os campos do documento.Você não pode especificar a opção wildcardProjection quando você cria um índice curinga em um caminho de campo específico e seus subcampos.

wildcardProjection funciona com especificações como:

No entanto, você não pode definir um índice que inclua o mesmo campo nos campos curinga e os campos regulares (não curinga). Para definir o índice corretamente, utilize um wildcardProjection para excluir campos duplicados do padrão curinga.

wildcardProjection não funciona com uma especificação como:

``{ "path.to.field.$**" : 1 }``

A opção wildcardProjection tem o seguinte formato:

O <value> pode ser um dos seguintes:

Os índices curinga omitem o campo _id por padrão. Para incluir o campo _id no índice curinga, você deve explicitamente incluí-lo no documento wildcardProjection :

Todas as declarações no documento wildcardProjection devem ser declarações de inclusão ou de exclusão. Você também pode incluir o campo _id com declarações de exclusão. Esta é a única exceção à regra.

As opções especificadas em db.collection.createIndexes() se aplicam a todas as especificações de índice incluídas no array de padrão de chave. Especifique wildcardProjection somente se estiver criando um único índice curinga usando db.collection.createIndexes().

Se você chamar db.collection.createIndexes() para um índice ou índices que já existem, o MongoDB não recriará o índice ou índices existentes.

Com exceção da opção de agrupamento, se você criar um índice com um conjunto de opções de índice e tentar recriar o mesmo índice, mas com diferentes opções de índice, o MongoDB não alterará as opções nem recriará o índice.

A opção oculta pode ser alterada sem descartar e recriar o índice. Consulte Opção oculta.

Para alterar as outras opções de índice, descarte o índice existente com db.collection.dropIndex() antes de executar db.collection.createIndexes() com as novas opções.

Você pode criar vários índices na(s) mesma(s) chave(s) com diferentes agrupamentos. Para criar indexes com o mesmo padrão de chave, mas com agrupamentos diferentes, você deve fornecer nomes de índice exclusivos.

Para ocultar ou exibir índices existentes, você pode usar os seguintes métodos mongosh:

Por exemplo,

  • Para alterar a opção hidden para um índice para true, utilize o método db.collection.hideIndex():

    db.restaurants.hideIndex( { borough: 1, ratings: 1 } );
  • Para alterar a opção hidden para um índice para false, utilize o método db.collection.unhideIndex():

    db.restaurants.unhideIndex( { borough: 1, city: 1 } );

Dica

Veja também:

  • Os índices curinga omitem o campo _id por padrão. Para incluir o campo _id no índice curinga, você deve explicitamente incluí-lo no documento wildcardProjection :

    {
    "wildcardProjection" : {
    "_id" : 1,
    "<field>" : 0|1
    }
    }

    Todas as declarações no documento wildcardProjection devem ser declarações de inclusão ou de exclusão. Você também pode incluir o campo _id com declarações de exclusão. Esta é a única exceção à regra.

  • Os índices curinga não suportam:

    Os índices curinga são índices esparsos . Eles não oferecem suporte a queries quando um campo indexado não existe. Um índice curinga indexará o documento se o campo curinga tiver um valor null.

    A partir do MongoDB 7.0, os índices curinga suportam ordem crescente (1) e decrescente (-1). As versões anteriores suportavam apenas ordem crescente.

Para saber mais, consulte:

Você pode criar coleção e indexes dentro de uma transaction distribuída se a transaction não for uma transação de escrita de estilhaço cruzado.

Para usar db.collection.createIndexes() em uma transação, a transação deve usar preocupação de leitura "local". Se você especificar um nível de preocupação de leitura diferente de "local", a transação falhará.

Alterado na versão 7.1.

A partir do MongoDB 7.1, as compilações de índice são aprimoradas com relatórios de erros mais rápidos e maior resiliência a falhas. Você também pode definir o espaço mínimo em disco disponível necessário para compilações de índice usando o novo parâmetro indexBuildMinAvailableDiskSpaceMB , que interrompe as compilações de índice se o espaço em disco estiver muito baixo.

A tabela a seguir compara o comportamento de construção de índices a partir do MongoDB 7.1 com versões anteriores.

Comportamento a partir do MongoDB 7.1
Comportamento em versões anteriores do MongoDB
Os erros de índice encontrados durante a fase de varredura da collection, exceto erros de chave duplicada, são retornados imediatamente e, em seguida, a criação do índice é interrompida. Versões anteriores do MongoDB retornam erros na fase de confirmação, que ocorre próximo ao final da compilação do índice. O MongoDB 7.1 ajuda você a diagnosticar rapidamente erros de índice. Por exemplo, se um formato de valor de índice incompatível for encontrado, o erro será retornado a você imediatamente.
Os erros de construção de índice podem levar muito tempo para serem retornados em comparação com o MongoDB 7.1 porque os erros são retornados perto do final da construção de índices na fase de confirmação.
Maior resiliência para sua implantação. Se ocorrer um erro de construção de índice, um membro secundário poderá solicitar que o membro primário interrompa uma construção de índice e o membro secundário não falha. Uma solicitação para interromper a criação de um índice nem sempre é possível: se um membro já tiver votado para confirmar o índice, o secundário não poderá solicitar que a criação do índice pare e o secundário falha (semelhante ao MongoDB 7.0 e anterior).
Um erro de construção de índice pode fazer com que um membro secundário falhe.
Gerenciamento aprimorado de espaço em disco para compilações de índice. Uma compilação de índice pode ser interrompida automaticamente se o espaço em disco disponível estiver abaixo do mínimo especificado no parâmetro indexBuildMinAvailableDiskSpaceMB . Se um membro já tiver votado para confirmar o índice, a criação do índice não será interrompida.
Uma compilação de índice não será interrompida se não houver espaço em disco disponível insuficiente.

Dica

Veja também:

db.collection.createIndex() para obter exemplos de várias especificações de índice.

Considere uma coleção restaurants contendo documentos semelhantes aos seguintes:

{
location: {
type: "Point",
coordinates: [-73.856077, 40.848447]
},
name: "Morris Park Bake Shop",
cuisine: "Cafe",
borough: "Bronx",
}

O exemplo a seguir cria dois índices na coleção restaurants: um índice ascendente no campo borough e um índice de 2 esferas no campo location.

db.restaurants.createIndexes([{"borough": 1}, {"location": "2dsphere"}])

O exemplo seguinte cria dois índices na coleção products: um índice ascendente no campo manufacturer e um índice ascendente no campo category . Ambos os índices usam um agrupamento que especifica a localidade fr e a força de comparação 2:

db.products.createIndexes( [ { "manufacturer": 1}, { "category": 1 } ],
{ collation: { locale: "fr", strength: 2 } })

Para queries ou operações de classificação nas chaves indexadas que usam as mesmas regras de agrupamento, o MongoDB pode usar o índice. Para obter detalhes, consulte Agrupamento e uso de índice.

Para obter a documentação completa sobre índices Curinga, consulte Índices Curinga.

As seguintes listas listam exemplos de criação de índice coringa:

Considere uma coleção products_catalog onde os documentos podem conter um campo product_attributes. O campo product_attributes pode conter campos aninhados arbitrários, incluindo documentos incorporados e arrays:

db.products_catalog.insertMany( [
{
_id : ObjectId("5c1d358bf383fbee028aea0b"),
product_name: "Blaster Gauntlet",
product_attributes: {
price: {
cost: 299.99,
currency: "USD"
}
}
},
{
_id: ObjectId("5c1d358bf383fbee028aea0c"),
product_name: "Super Suit",
product_attributes: {
superFlight: true,
resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
}
}
] )

A seguinte operação cria um índice curinga no campo product_attributes :

use inventory
db.products_catalog.createIndexes(
[ { "product_attributes.$**" : 1 } ]
)

Com este índice curinga, MongoDB indexa todos os valores escalares de product_attributes. Se um campo for um documento ou array aninhado, o índice curinga recorrerá ao documento/array e indexará todos os campos escalares no documento/array.

O índice curinga pode suportar queries arbitrárias de campo único no product_attributes ou um de seus campos aninhados:

db.products_catalog.find( { "product_attributes.superFlight" : true } )
db.products_catalog.find( { "product_attributes.maxSpeed" : { $gt : 20 } } )
db.products_catalog.find( { "product_attributes.elements" : { $eq: "water" } } )

Observação

A sintaxe do índice curinga específico do caminho é incompatível com a opção wildcardProjection. Consulte a documentação do parâmetro para mais informações.

Considere uma coleção products_catalog onde os documentos podem conter um campo product_attributes. O campo product_attributes pode conter campos aninhados arbitrários, incluindo documentos incorporados e arrays:

db.products_catalog.insertMany( [
{
_id : ObjectId("5c1d358bf383fbee028aea0b"),
product_name: "Blaster Gauntlet",
product_attributes: {
price: {
cost: 299.99,
currency: "USD"
}
}
},
{
_id: ObjectId("5c1d358bf383fbee028aea0c"),
product_name: "Super Suit",
product_attributes: {
superFlight: true,
resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
}
}
] )

A seguinte operação cria um índice curinga em todos os campos escalares (excluindo o campo _id):

use inventory
db.products_catalog.createIndexes( [ { "$**" : 1 } ] )

Com esse índice curinga, o MongoDB indexa todos os campos escalares para cada documento na coleção. Se um determinado campo for um documento ou array aninhada, o índice curinga recorrerá ao documento/array e indexará todos os campos escalares no documento/array.

O índice criado pode suportar queries em qualquer campo arbitrário dentro de documentos na coleção:

db.products_catalog.find( { "product_price" : { $lt : 25 } } )
db.products_catalog.find( { "product_attributes.elements" : { $eq: "water" } } )

Observação

Os índices curinga omitem o campo _id por padrão. Para incluir o campo _id no índice curinga, você deve explicitamente incluí-lo no documento wildcardProjection. Consulte a documentação dos parâmetros para mais informações.

Considere uma coleção products_catalog onde os documentos podem conter um campo product_attributes. O campo product_attributes pode conter campos aninhados arbitrários, incluindo documentos incorporados e arrays:

db.products_catalog.insertMany( [
{
_id : ObjectId("5c1d358bf383fbee028aea0b"),
product_name: "Blaster Gauntlet",
product_attributes: {
price: {
cost: 299.99,
currency: "USD"
}
}
},
{
_id: ObjectId("5c1d358bf383fbee028aea0c"),
product_name: "Super Suit",
product_attributes: {
superFlight: true,
resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
}
}
] )

A seguinte operação cria um índice curinga e usa a opção wildcardProjection para incluir somente valores escalares dos campos product_attributes.elements e product_attributes.resistance no índice.

use inventory
db.products_catalog.createIndexes(
[ { "$**" : 1 } ],
{
"wildcardProjection" : {
"product_attributes.elements" : 1,
"product_attributes.resistance" : 1
}
}
)

O padrão "$**" inclui todos os campos no documento. Utilize o campo wildcardProjection para limitar o índice aos campos especificados.

Para documentação completa no wildcardProjection, consulte Opções para índices do wildcard.

Se um campo for um documento ou array aninhado, o índice curinga recorrerá ao documento/array e indexará todos os campos escalares no documento/array.

O índice curinga suporta queries em qualquer campo escalar incluído no wildcardProjection:

db.products_catalog.find( { "product_attributes.elements" : { $eq: "Water" } } )
db.products_catalog.find( { "product_attributes.resistance" : "Bludgeoning" } )

Observação

Os índices curinga não suportam a combinação de instruções de inclusão e exclusão no documento wildcardProjection , exceto quando se inclui explicitamente o campo _id. Para obter mais informações sobre wildcardProjection, consulte a documentação do parâmetro.

Considere uma coleção products_catalog onde os documentos podem conter um campo product_attributes. O campo product_attributes pode conter campos aninhados arbitrários, incluindo documentos incorporados e arrays:

db.products_catalog.insertMany( [
{
_id : ObjectId("5c1d358bf383fbee028aea0b"),
product_name: "Blaster Gauntlet",
product_attributes: {
price: {
cost: 299.99,
currency: "USD"
}
}
},
{
_id: ObjectId("5c1d358bf383fbee028aea0c"),
product_name: "Super Suit",
product_attributes: {
superFlight: true,
resistance: [ "Bludgeoning", "Piercing", "Slashing" ]
}
}
] )

Este exemplo usa um índice coringa e um documento wildcardProjection para indexar os campos escalares para cada documento na collection. O índice coringa exclui os campos product_attributes.elements e product_attributes.resistance:

use inventory
db.products_catalog.createIndexes(
[ { "$**" : 1 } ],
{
"wildcardProjection" : {
"product_attributes.elements" : 0,
"product_attributes.resistance" : 0
}
}
)

O padrão curinga "$**" inclui todos os campos no documento. No entanto, o campo wildcardProjection exclui os campos especificados do índice.

Para documentação completa no wildcardProjection, consulte Opções para índices do wildcard.

Se um campo for um documento ou array aninhado, o índice curinga recorrerá ao documento/array e indexará todos os campos escalares no documento/array.

O índice pode suportar queries em qualquer campo escalar exceto campos excluídos por wildcardProjection:

db.products_catalog.find( { "product_attributes.maxSpeed" : { $gt: 25 } } )
db.products_catalog.find( { "product_attributes.superStrength" : true } )

Observação

Os índices curinga não suportam a combinação de instruções de inclusão e exclusão no documento wildcardProjection , exceto quando se inclui explicitamente o campo _id. Para obter mais informações sobre wildcardProjection, consulte a documentação do parâmetro.

Observação

Exige featureCompatibilityVersion 4.4+

Cada mongod no conjunto de réplica ou agrupamento fragmentado deve ter featureCompatibilityVersion configurado para pelo menos 4.4 para iniciar construções de índice simultaneamente entre membros do conjunto de réplicas.

Construir índices em um conjunto de réplicas ou cluster particionado é feito simultaneamente em todos os membros do conjunto de réplicas que contêm dados. Para clusters fragmentados, a construção de índices ocorre somente em fragmentos que contêm dados para a coleção que está sendo indexada. O primário requer um número mínimo de membros de dados voting (ou seja, quórum para a confirmação), incluindo ele próprio, que deve concluir a construção antes de marcar o índice como pronto para uso. Consulte Construções de Índice em Ambientes Replicados para obter mais informações.

Para definir o quórum para a confirmação, use createIndexes() para especificar o valor commitQuorum.

commitQuorum especifica quantos nós votantes portadores de dados, ou quais nós votantes, incluindo o primário, devem estar preparados para confirmar a construção do índice antes que o primário execute o commit. O commit quorum padrão é votingMembers, o que significa todos os nós portadores de dados.

A seguinte operação cria um índice com um quórum para a confirmação de "majority":

db.getSiblingDB("examples").invoices.createIndexes(
{ "invoices" : 1 },
{ },
"majority"
)

A construção do índice de notas primário ficou pronta somente após a maioria simples dos membros votantes portadores de dados " votarem em" para confirmar a criação do índice. Para obter mais informações sobre a criação de índices e o processo de votação, consulte Construções de índices em ambientes replicados.

Crie uma collection cakeSales que contenha vendas de bolo nos estados da Califórnia (CA) e de Washington (WA):

db.cakeSales.insertMany( [
{ _id: 0, type: "chocolate", orderDate: new Date("2020-05-18T14:10:30Z"),
state: "CA", price: 13, quantity: 120 },
{ _id: 1, type: "chocolate", orderDate: new Date("2021-03-20T11:30:05Z"),
state: "WA", price: 14, quantity: 140 },
{ _id: 2, type: "vanilla", orderDate: new Date("2021-01-11T06:31:15Z"),
state: "CA", price: 12, quantity: 145 },
{ _id: 3, type: "vanilla", orderDate: new Date("2020-02-08T13:13:23Z"),
state: "WA", price: 13, quantity: 104 },
{ _id: 4, type: "strawberry", orderDate: new Date("2019-05-18T16:09:01Z"),
state: "CA", price: 41, quantity: 162 },
{ _id: 5, type: "strawberry", orderDate: new Date("2019-01-08T06:12:03Z"),
state: "WA", price: 43, quantity: 134 }
] )

O exemplo seguinte cria múltiplos índices na coleção cakeSales:

db.cakeSales.createIndexes( [
{ "type": 1 },
{ "orderDate": 1 },
{ "state": 1 },
{ "orderDate": 1, "state": -1 }
] )

Os três primeiros índices estão em campos únicos e em ordem crescente (1).

O último índice está em orderDate em ordem crescente (1) e state em ordem decrescente (-1).

Para obter informações adicionais sobre índices, consulte:

Voltar

db.collection.createIndex