createIndexes

Nomes de Índice

A partir da versão 4.2, o comando createIndexes e mongosh auxiliares db.collection.createIndex() e db.collection.createIndexes() relatam um erro se você criar um índice com um nome e tentar criar o mesmo índice novamente, mas com outro nome.

{
   "ok" : 0,
   "errmsg" : "Index with name: x_1 already exists with a different name",
   "code" : 85,
   "codeName" : "IndexOptionsConflict"
}

Em versões anteriores, o MongoDB não recriava o índice, mas retornava um objeto de resposta com valor ok de 1 e uma observação de que o índice não foi recriado. Por exemplo:

{
   "numIndexesBefore" : 2,
   "numIndexesAfter" : 2,
   "note" : "all indexes already exist",
   "ok" : 1
}

Conjuntos de Réplicas e Clusters Compartilhados

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

Para iniciar uma construção de índice com um commit quorum não padrão, especifique o commitQuorum.

Use o comando setIndexCommitQuorum para modificar o quórum para a confirmação de uma construção de índice em andamento.

Para minimizar o impacto da criação de um índice em conjunto de réplicas e clusters fragmentados, use um procedimento de rolling de índices de construçã, conforme descrito em Construções contínuas de índices em replica sets.

Tipos de agrupamento e índice

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

• índices de texto ,

• Índices 2d e

• índices do geoHaystack .

Stable API

Ao usar a API estável V1:

• Você não pode especificar nenhum dos seguintes campos na array indexes:

  • background

  • bucketSize

  • sparse

  • storageEngine

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

Concurrency

Para featureCompatibilityVersion "4.2", createIndexes usa um processo de compilação otimizado que obtém e mantém um bloqueio exclusivo na coleção especificada no início e no final da compilação de índice. Todas as operações subsequentes na coleção devem aguardar até que createIndexes libere o exclusivo trava. createIndexes permite intercalar operações de leitura e gravação durante a maior parte da compilação do índice.

Para featureCompatibilityVersion "4.0", o createIndexes utiliza o pré-4.2 processo de construção do índice que, por padrão, obtém um bloqueio exclusivo no banco de dados pai por toda a duração do processo de construção. O pré-4. O processo de construção 2 bloqueia todas as operações no banco de dados e todas as suas coleções até que a operação seja concluída. os índices background não recebem um bloqueio exclusivo.

Para obter mais informações sobre o comportamento de bloqueio de createIndexes, consulte Index Builds on PopulatedCollections.

Limite de uso da memória

O createIndexes permite criar um ou mais índices em uma collection. createIndexes usa uma combinação de memória e arquivos temporários no disco para concluir as compilações de índice. O limite padrão de uso de memória para createIndexes é 200 megabytes (para as versões 4.2.3 e posteriores) e 500 (para as versões 4.2.2 e anterior), compartilhado entre todos os índices construídos utilizando um único comando createIndexes . Após o limite de memória ser atingido, o createIndexes utiliza arquivos de disco temporários em um subdiretório denominado _tmp dentro do diretório --dbpath para concluir a compilação.

Você pode substituir o limite de memória configurando o parâmetro do servidor maxIndexBuildMemoryUsageMegabytes. A definição de um limite de memória maior pode resultar na conclusão mais rápida das compilações de índices. No entanto, um limite muito alto em relação à RAM não utilizada no seu sistema pode resultar no esgotamento da memória e no desligamento do servidor.

Opções de índice

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

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

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

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

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

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

Índices 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
    }
  }

  Com exceção de incluir explicitamente o campo _id , não é possível combinar declarações de inclusão e exclusão no documento wildcardProjection .

• O mongod featureCompatibilityVersion deve ser 4.2 para criar índices curinga. Para obter instruções sobre como definir o FCV, consulte Definir versão de compatibilidade do recurso em sistemas do MongoDB 5.0.

• Os índices curinga não suportam os seguintes tipos de índice ou propriedades:

  • composto

  • TTL

  • texto

  • 2d (Geoespacial)

  • 2dsphere (Geoespacial)

  • Hash

  • Único

  Observação

  Os índices curinga são distintos e incompatíveis com os índices de texto curinga. Os índices curinga não suportam consultas usando o operador $text .

  Para obter a documentação completa sobre restrições de índice curinga, consulte Restrições de índice curinga.

Para obter exemplos de criação de índice curinga, consulte Criar um índice curinga. Para obter a documentação completa sobre índices Curinga, consulte Índices Curinga.

Transações

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 createIndexes em uma transação, a transação deve usar read concern "local". Se você especificar um nível de preocupação de leitura diferente de "local", a transação falhará.

Criar um Índice Curinga

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

• Criar um Índice Curinga em um Caminho de Campo Único

• Crie um Índice Curinga em Todos os Caminhos de Campo

• Crie um índice curinga em vários caminhos do campo específicos

• Crie um índice curinga que exclua vários caminhos de campo específicos

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" ]
    }
  }
] )

use inventory
db.runCommand(
  {
    createIndexes: "products_catalog",
    indexes: [
      {
        key: { "product_attributes.$**" : 1 },
        name: "wildcardIndex"
      }
    ]
  }
)

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" } } )

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" ]
    }
  }
] )

use inventory
db.runCommand(
  {
    createIndexes: "products_catalog",
    indexes: [
      {
        key: { "$**" : 1 },
        name: "wildcardIndex"
      }
    ]
  }
)

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

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" ]
    }
  }
] )

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

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

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" ]
    }
  }
] )

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

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

Criar Índice com Commit Quorum

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

Especifique a opção commitQuorum para a operação createIndexes para definir o número mínimo de membros votantes portadores de dados (ou seja, quorum de commit), incluindo o primário, que deve concluir a construção do índice antes que o primário marque os índices como prontos. O quorum para o commit padrão é votingMembers ou todos os nós do conjunto de réplicas com dados.

A seguinte operação cria um índice com um commit quorum de "majority" ou uma simples maioria dos nós com recurso de dados:

db.getSiblingDB("examples").runCommand(
  {
    createIndexes: "invoices",
    indexes: [
      {
        key: { "invoices" : 1 },
        "name" : "invoiceIndex"
      }
    ],
    "commitQuorum" : "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.