createIndexes

string

A coleção para a qual criar índices.

array

Especifica os índices a serem criados. Cada documento na array especifica um índice separado.

documento

Opcional. Um documento que expressa o write concern. Omitir para usar o write concern padrão.

inteiro ou string

Opcional. O número mínimo de nós do conjunto de réplicas contendo dados (ou seja, quorum para o commit), incluindo o primary, que deve relatar uma construção de índice bem-sucedida antes que o primary marque o indexes como pronto.

A partir do MongoDB v5.0, você pode retomar algumas construções de índice interrompido quando o commit quorum is set para "votingMembers".

Nós do conjunto de réplicas em um quorum para o commit devem ter members[n].buildIndexes definido como true. Se algum nó de votação tiver members[n].buildIndexes definido como false, você não poderá usar o "votingMembers" commit quorum padrão. Configure todos os nós com members[n].buildIndexes definido como true ou selecione um commit quorum diferente.

suporta os seguintes valores:

• "votingMembers" - todos os membros do conjunto de réplicas de votos com dados (Padrão). Um membro "votante" é qualquer membro do conjunto de réplicas em que members[n].votes é maior que 0.

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

• <int> - um número específico de membros do conjunto de réplicas 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.

any

Opcional. Um comentário fornecido pelo usuário para anexar a este comando. Depois de definido, esse comentário aparece junto com os registros desse comando nos seguintes locais:

• mensagens de log do mongod, no campo attr.command.cursor.comment.

• Saída do perfil do banco de dados, no campo command.comment.

• Saída de currentOp, no campo command.comment.

Um comentário pode ser qualquer tipo BSON válido (string, inteiro, objeto, array etc).

documento

Especifica os campos do índice. Para cada campo, especifique um par chave-valor no qual a chave é o nome do campo a ser indexado e o valor é a direção do índice ou o tipo de índice. Se especificar direção, especifique 1 para ascendente ou -1 para descendente.

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

• text

• Geoespacial

• Índices com hash

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.

string

Um nome que identifica exclusivamente o índice.

booleano

Opcional. Cria um índice único para que a coleção não aceite 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 de hasheados.

documento

Opcional. Se especificado, o índice só faz referência a documentos que correspondam à expressão de filtro. Consulte Índices parciais para obter mais informações.

Uma expressão de filtro pode incluir:

• expressões de igualdade (ou seja, field: value ou usando o operador $eq),

• $exists: true expressão,

• $gt, $gte, $lt, $lte expressions,

• $type expressões,

• $and operador,

• $or operador,

• $in operador, operador

Se você estiver utilizando o Client-Side Field Level Encryption ou o Queryable Encryption, um partialFilterExpression não poderá fazer referência a um campo criptografado.

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

booleano

Opcional. Se true, o índice referencia apenas documentos com o campo especificado. Esses índices usam menos espaço, mas se comportam de forma diferente em algumas situações (especialmente em tipos). O valor padrão é false. Consulte Analisar índices para obter mais informações.

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

• 2dsphere

• 2d

• Text

Para um índice composto que inclui 2dsphere chave(s) de índice junto com chaves de outros tipos, somente os campos de índice 2dsphere determinam se o índice faz referência a um documento.

O MongoDB fornece a opção de criar índices parciais. Eles oferecem um superconjunto de funcionalidades de índices esparsos e são preferidos.

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. Uma bandeira que determina se o índice é oculto do planejador de query. Um índice oculto não é avaliado como parte da seleção do plano de query.

O padrão é false.

documento

Opcional. Permite que os usuários configurem o mecanismo de armazenamento por índice ao criar um índice.

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.

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.

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.

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.

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.

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.

inteiro

Opcional. Para índices 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.

número

Opcional. Para índices 2d, o limite inferior inclusivo para os valores de longitude e latitude. O valor padrão é -180.0.

número

Opcional. Para índices 2d, o limite de inclusão superior para os valores de longitude e latitude. O valor padrão é 180.0.

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.

documento

Opcional.

Permite que os usuários incluam ou excluam caminho do campo específicos de um índice curinga usando o padrão de chave { "$**" : 1}. Essa opção só é válida se você criar um índice curinga em todos os campos do documento. Você não pode especificar essa opção ao criar um índice curinga em um caminho de campo específico e seus subcampos, por exemplo { "path.to.field.$**" : 1 }

A opção wildcardProjection tem o seguinte formato:

wildcardProjection: {
  "path.to.field.a" : <value>,
  "path.to.field.b" : <value>
}

O <value> pode ser um dos seguintes:

• 1 ou true para incluir o campo no índice curinga.

• 0 ou false para excluir o campo do índice curinga.

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.