corpo, corpo Obrigatório

• agrupamento objeto

  Uma ou mais configurações que especificam regras específicas da linguagem para comparar strings nesse índice.

  Opções de agrupamento
  Ocultar atributos de agrupamento Mostrar atributos de agrupamento objeto

  • alternar string

    Método para lidar com espaços em branco e pontuação como caracteres básicos para fins de comparação. "non-ignorable" avaliará o espaço em branco e a pontuação como caracteres básicos. "shifted" não será, o MongoDB Cloud distingue esses caracteres quando "strength" > 3.

    Os valores são non-ignorable ou shifted. O valor padrão é non-ignorable.

  • de trás para frente booleano

    Sinalizador que indica se as strings com diacríticos são classificadas do final da string. Alguns dicionários francês ordenam strings dessa forma. true comparará de trás para frente. false comparará de frente para trás.

    O valor padrão é false.

  • caseFirst string

    Método para lidar com a ordem de classificação das diferenças de caso durante comparações de nível terciário. "upper" classifica maiúsculas antes de minúsculas. "lower" classifica em minúsculas antes de maiúsculas. "off" é semelhante a "lower" com pequenas diferenças.

    Os valores são lower, off ou upper. O valor padrão é off.

  • caseLevel booleano

    Sinalizador que indica se a comparação de caso deve ser incluída quando "strength" : 1 ou "strength" : 2.

    • true - Incluir caixa na comparação
      • Nível de força: 1 - Caracteres básicos e caso.
      • Nível de força: 2 - Caracteres básicos, diacríticos (e outras possíveis diferenças secundárias) e maiúsculas e minúsculas.
    • false - O caso NÃO está incluído na comparação.

    O valor padrão é false.

  • localidade string Obrigatório

    Código de componentes internacionais para unicode (ICU) que representa um idioma localizado. Para especificar uma comparação binária simples, defina "locale" : "simple".

    Os valores são af, sq, am, ar, hy, as, az, bn, be, bs, bs_Cyrl, bg, my, ca, chr, zh, zh_Hant, hr, cs, da, nl, dz, en, en_US, en_US_POSIX, eo, et, ee, fo, fil, fi_FI, fr, fr_CA, gl, ka, de, de_AT, el, gu, ha, haw, he, hi, hu, is, ig, smn, id, ga, it, ja, kl, kn, kk, km, kok, ko, ky, lk, lo, lv, li, lt, dsb, lb, mk, ms, ml, mt, mr, mn, ne, se, nb, nn, or, om, ps, fa, fa_AF, pl, pt, pa, ro, ru, sr, sr_Latn, si, sk, sl, es, sw, sv, ta, te, th, bo, to, tr, uk, hsb, ur, ug, vi, wae, cy, yi, yo, zu ou simple.

  • maxVariable string

    Campo que indica quais caracteres podem ser ignorados quando "alternate" : "shifted"."punct" ignora o espaço em branco e a pontuação. "space" ignora espaços em branco. Isso não terá efeito se "alternate" : "non-ignorable".

    Os valores são punct ou space.

  • normalização booleano

    Sinalizador que indica se deve verificar se o texto exige normalização e, em seguida, executá-la. A maioria dos textos não exige esse processamento de normalização.

    true verificará se está totalmente normalizado e executará a normalização para comparar o texto. false não verificará.

    O valor padrão é false.

  • numericOrdering booleano

    Sinalizador que indica se as sequências de dígitos devem ser comparadas como números ou como strings. true será comparado como números, isso resulta em 10 > 2. false comparará como strings. Isso resulta em "10" < "2".

    O valor padrão é false.

  • força integer(int32)

    Grau de comparação a ser executado ao classificar palavras.

    O MongoDB Cloud aceita os seguintes valores numéricos que correspondem ao nível de comparação e a qual é esse método de comparação.

    • 1 - "Primary" - Compara apenas os caracteres básicos, ignorando outras diferenças, como diacríticos, maiúsculas e minúsculas.
    • 2 - "Secondary" - Compara caracteres básicos (primary) e sinais diacríticos (secundário). As diferenças primárias têm precedência sobre as secundárias.
    • 3 - "terciário" - compara caracteres básicos (primários), diacríticos (secundários) e maiúsculas e minúsculas e variantes (terciário). Diferenças entre caracteres básicos tem precedência sobre diferenças secundárias que têm precedência sobre as diferenças terciárias.
    • 4 - " Quaternary " - Compara o caso de uso específico para considerar a pontuação quando os níveis 1 a 3 ignoram a pontuação ou o processamento de texto em chinês.
    • 5 - "Idêntico" - compara para o caso de uso específico do disjuntor tie .

    O valor mínimo é 1, o valor máximo é 5. O valor padrão é 3.

• collection string Obrigatório

  Etiqueta legível por humanos da coleção para a qual o MongoDB Cloud cria um índice.

• db string Obrigatório

  Etiqueta legível por humanos do banco de dados que contém a coleção na qual o MongoDB Cloud cria um índice.

• keys array[objeto]

  Lista que contém um ou mais objetos que descrevem os parâmetros que você deseja indexar.

  Par de valores-chave que define o parâmetro a ser indexado como a chave e o tipo de índice como seu valor. Para criar um índice de múltiplas chaves, liste cada parâmetro em seu próprio objeto dentro desta array.

  Ocultar atributo de chaves Mostrar atributo das chaves objeto

  Tipos de índice

  • * string Propriedades adicionais

    Par de valores-chave que define o parâmetro a ser indexado como a chave e o tipo de índice como seu valor. Para criar um índice de múltiplas chaves, liste cada parâmetro em seu próprio objeto dentro desta array.

    Tipos de índice
• opções objeto

  Uma ou mais configurações que determinam como o MongoDB Cloud cria este índice MongoDB.

  Opções de índice
  Ocultar atributos de opções Mostrar atributos de opções objeto

  • 2dsphereIndexVersion integer(int32)

    Número da versão do índice aplicado ao índice 2dsphere. MongoDB 3.2 e posterior utilizam a versão 3. Use esta opção para substituir o número da versão padrão. Essa opção se aplica somente ao tipo de índice 2dsphere.

    O valor padrão é 3.

  • Plano de fundo booleano

    Sinalizador que indica se o MongoDB deve construir o índice em segundo plano. Isso se aplica aos bancos de dados MongoDB que executam a versão de compatibilidade do recurso 4.0 ou anterior. Bancos de dados MongoDB que executam FCV 4.2 ou posterior criam índices usando um processo de construção otimizado. Esse processo mantém o bloqueio exclusivo apenas no início e no final do processo de construção. O restante do processo de construção resulta em operações intercaladas de leitura e gravação. Os bancos de dados MongoDB que executam o FCV 4.2 ou posterior ignoram esta opção. Esta opção se aplica a todos os tipos de índice.

    O valor padrão é false.

  • bits integer(int32)

    Número de precisão aplicado ao valor geohash armazenado dos dados de localização. Essa opção se aplica somente ao tipo de índice 2d.

    O valor padrão é 26.

  • bucketSize integer(int32)

    Número de unidades dentro das quais agrupar os valores de localização. Você pode agrupar no mesmo bloco esses valores de localização dentro do número especificado de unidades entre si. Esta opção se aplica somente ao tipo de índice geoHaystack.

    O MongoDB 5.0 removeu os índices geoHaystack e o comando geoSearch.

  • columnstoreProjeção objeto

    O documento columnstoreProjection permite incluir ou excluir o esquema de subschemas. Não é possível combinar declarações de inclusão e exclusão. Assim, pode ser um dos seguintes: 1 ou true para incluir o campo e recursivamente todos os campos dos quais é um prefixo no índice 0 ou false para excluir o campo e recursivamente todos os campos dos quais é um prefixo de o índice.

    Ocultar atributo columnstoreProjection Mostrar atributo columnstoreProjection objeto

    • * integer(int32) Propriedades adicionais

      O documento columnstoreProjection permite incluir ou excluir o esquema de subschemas. Não é possível combinar declarações de inclusão e exclusão. Assim, pode ser um dos seguintes: 1 ou true para incluir o campo e recursivamente todos os campos dos quais é um prefixo no índice 0 ou false para excluir o campo e recursivamente todos os campos dos quais é um prefixo de o índice.

  • default_language string

    Linguagem humana que determina a lista de palavras de parada e as regras para o stemmer e o tokenizador. Esta opção aceita os idiomas suportados usando seu nome em letras minúsculas em inglês ou o código ISO 639-2. Se você definir esse parâmetro como "none", a pesquisa de texto usará tokenização simples, sem lista de palavras vazias e sem derivação. Essa opção se aplica somente ao tipo de índice de texto.

    O valor padrão é english.

  • expireAfterSeconds integer(int32)

    Número de segundos que o MongoDB retém documentos em um índice Time To Live (TTL).

  • escondida booleano

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

    O valor padrão é false.

  • language_override string

    Rótulo legível por humanos que identifica o parâmetro do documento que contém o idioma de substituição do documento. Essa opção se aplica somente ao tipo de índice de texto.

    O valor padrão é language.

  • max integer(int32)

    Limite de inclusão superior para limitar os valores de longitude e latitude. Essa opção se aplica somente ao tipo de índice 2d.

    O valor padrão é 180.

  • min integer(int32)

    Limite inclusivo inferior para limitar os valores de longitude e latitude. Essa opção se aplica somente ao tipo de índice 2d.

    O valor padrão é -180.

  • name string

    Rótulo legível por humanos que identifica este índice. Esta opção se aplica a todos os tipos de índice.

  • Expressão de filtro parcial objeto

    Regras que limitam os documentos às quais o índice faz referência a uma expressão de filtro. Todos os tipos de índice MongoDB aceitam uma opção partialFilterExpression. partialFilterExpression pode incluir as seguintes expressões:

    • igualdade ("parameter" : "value" ou utilizando o operador $eq)
    • "$exists": true , maximum: $gt, $gte, $lt, $lte comparações
    • $type
    • $and (somente nível superior) Essa opção se aplica a todos os tipos de índice.
    Ocultar atributo partialFilterExpression Mostrar atributo partialFilterExpression objeto

    • * objeto Propriedades adicionais

      Regras que limitam os documentos às quais o índice faz referência a uma expressão de filtro. Todos os tipos de índice MongoDB aceitam uma opção partialFilterExpression. partialFilterExpression pode incluir as seguintes expressões:

      • igualdade ("parameter" : "value" ou utilizando o operador $eq)
      • "$exists": true , maximum: $gt, $gte, $lt, $lte comparações
      • $type
      • $and (somente nível superior) Essa opção se aplica a todos os tipos de índice.
  • Esparso booleano

    Sinalizador que indica se o índice faz referência a documentos que só têm o parâmetro especificado. Esses índices usam menos espaço, mas se comportam de maneira diferente em algumas situações, como na classificação. Os seguintes tipos de índice são padronizados como esparsos e ignoram esta opção: 2dsphere, 2d, geoHaystack, text.

    Índices compostos que incluem um ou mais índices com chaves 2dsphere além de outros tipos de chaves, somente os parâmetros de índice 2dsphere determinam a quais documentos o índice faz referência. Se você executar o MongoDB 3.2 ou posterior, use índices parciais. Esta opção se aplica a todos os tipos de índice.

    O valor padrão é false.

  • storageEngine objeto

    Mecanismo de armazenamento definido para o índice específico. Este valor pode ser definido somente na criação. Esta opção utiliza o seguinte formato: "storageEngine" : { "<storage-engine-name>" : "<options>" } O MongoDB valida as opções de configuração do mecanismo de armazenamento ao criar índices. Para oferecer suporte a conjuntos de réplicas com membros com diferentes mecanismos de armazenamento, o MongoDB registra essas opções no oplog durante a replicação. Esta opção se aplica a todos os tipos de índice.

    Mecanismos de armazenamento do MongoDB Server
    Ocultar atributo storageEngine Mostrar atributo storageEngine objeto

    • * objeto Propriedades adicionais

      Mecanismo de armazenamento definido para o índice específico. Este valor pode ser definido somente na criação. Esta opção utiliza o seguinte formato: "storageEngine" : { "<storage-engine-name>" : "<options>" } O MongoDB valida as opções de configuração do mecanismo de armazenamento ao criar índices. Para oferecer suporte a conjuntos de réplicas com membros com diferentes mecanismos de armazenamento, o MongoDB registra essas opções no oplog durante a replicação. Esta opção se aplica a todos os tipos de índice.

      Mecanismos de armazenamento do MongoDB Server
  • textIndexVersão integer(int32)

    Versão aplicada a este índice de texto. MongoDB 3.2 e posterior utilizam a versão 3. Use esta opção para substituir o número da versão padrão. Essa opção se aplica somente ao tipo de índice de texto.

    O valor padrão é 3.

  • pesos objeto

    Importância relativa a ser atribuída aos parâmetros do índice fornecidos. Esse objeto expressa isso como pares chave/valor de parâmetro e peso do índice a serem aplicados a esse parâmetro. Você pode especificar pesos para alguns ou todos os parâmetros indexados. O peso deve ser um número inteiro entre 1 e 99,999. O MongoDB 5.0 e posterior podem aplicar pesos somente a índices de texto.

    Ocultar atributo de peso Mostrar atributo de pesos objeto

    • * objeto Propriedades adicionais

      Importância relativa a ser atribuída aos parâmetros do índice fornecidos. Esse objeto expressa isso como pares chave/valor de parâmetro e peso do índice a serem aplicados a esse parâmetro. Você pode especificar pesos para alguns ou todos os parâmetros indexados. O peso deve ser um número inteiro entre 1 e 99,999. O MongoDB 5.0 e posterior podem aplicar pesos somente a índices de texto.