Use visualizações com Atlas Search

Requisitos

Você deve usar o MongoDB 8.0 ou superior.

• No MongoDB v8.0+:

  • Use a IU do Atlas ou a API do Atlas para criar índices do Atlas Search em Visualizações.

  • Execute queries do Atlas Search na coleção de origem. Referencie o índice do Atlas Search que foi criado na Visualização. Essas queries retornam os documentos originais como aparecem na coleção de origem.

• No MongoDB v8.1+, você também pode:

  • Use os métodos mongosh e driver, db.collection.createSearchIndex(), db.collection.updateSearchIndex(), db.collection.dropSearchIndex() e $listSearchIndexes para criar e gerenciar índices do Atlas Search em Visualizações.

  • Execute as consultas do Atlas Search na Visualização.

Para editar uma visualização, você deve ter uma função de Usuário administrador e usar o comando de banco de dados collMod.

Limitações

• O Atlas Search oferece suporte a visualizações somente para $expr nas seguintes etapas:

  • $addFields

  • $set

  • $match

• Os nomes de índice devem ser únicos em uma coleção de origem e em todas as suas visualizações.

• O Atlas Search não suporta definições de visualização com operadores que produzem resultados dinâmicos, como a variável de sistema $$USER_ROLES e o operador de agregação $rand.

• As consultas do Atlas Search retornam os documentos originais como aparecem na coleção de origem.

Exemplo: filtrar documentos

Para criar uma visualização, você deve ter o privilégio createCollection.

Você pode indexar parcialmente uma coleção para filtrar documentos. O exemplo a seguir cria uma visualização na coleção sample_mflix.movies para que você possa pesquisar apenas filmes lançados após 1° de janeiro de 2000.

use sample_mflix

db.createView(
  "movies_ReleasedAfter2000",
  "movies",
  [
    {
      $match: {
        $expr: {
          $gt: [
            "$released",
            ISODate("2000-01-01")
          ]
        }
      }
    }
  ]
)

use sample_mflix

1
db.db.movies_ReleasedAfter2000.aggregate([
2
  {
3
    $search: {
4
      index: "releasedAfter2000Index",
5
      text: {
6
        path: "title",
7
        query: "foo"
8
      },
9
      sort: {
10
        released: 1
11
      }
12
    }
13
  }
14
])

[
  {
    _id: ObjectId('573a13d2f29313caabd929f8'),
    plot: "Rising from the ashes of Nirvana, the Foo Fighters became a Grammy-winning sensation on their own. Sixteen years of the band's history comes to life in this documentary, from their demo ...",
    genres: [ 'Documentary', 'Music' ],
    runtime: 150,
    cast: [
      'Shawn Cloninger',
      'William Goldsmith',
      'Jessy Greene',
      'Dave Grohl'
    ],
    num_mflix_comments: 0,
    poster: 'https://m.media-amazon.com/images/M/MV5BMzE4OTczMTgxM15BMl5BanBnXkFtZTcwNTU1NjQxOA@@._V1_SY1000_SX677_AL_.jpg',
    title: 'Foo Fighters: Back and Forth',
    fullplot: `Rising from the ashes of Nirvana, the Foo Fighters became a Grammy-winning sensation on their own. Sixteen years of the band's history comes to life in this documentary, from their demo tapes through the creation of their 2011 album, "Wasting Light."`,
    languages: [ 'English' ],
    released: ISODate('2011-04-05T00:00:00.000Z'),
    directors: [ 'James Moll' ],
    awards: { wins: 1, nominations: 1, text: '1 win & 1 nomination.' },
    lastupdated: '2015-08-19 00:00:25.937000000',
    year: 2011,
    imdb: { rating: 8.4, votes: 3745, id: 1853563 },
    countries: [ 'USA' ],
    type: 'movie',
    tomatoes: {
      viewer: { rating: 4.4, numReviews: 857, meter: 96 },
      dvd: ISODate('2011-08-08T00:00:00.000Z'),
      website: 'http://us.foofightersfilm.com/',
      production: 'Cinedigm Digital Cinema',
      lastUpdated: ISODate('2015-09-12T18:42:01.000Z')
    }
  }
]

Exemplo: Adicionar ou Modificar Campos

O exemplo a seguir permite que você pesquise a coleção sample_airbnb.listingsAndReviews por acomodações com base em um novo campo totalPrice, que é a soma dos campos price e cleaningFee. Além disso, como o Atlas Search não oferece suporte para tipos Decimal128, transformamos os valores em Double.

use sample_airbnb

db.createView(
  "listingsAndReviews_totalPrice",
  "listingsAndReviews",
  [
    {
      $addFields: {
        totalPrice: {
          $add: [
            {
              $ifNull: [{ $toDouble: "$price" }, 0]
            },
            {
              $ifNull: [{ $toDouble: "$cleaning_fee" }, 0]
            }
          ]
        }
      }
    }
  ]
)

use sample_airbnb

1
db.listingsAndReviews_totalPrice.aggregate([
2
  {
3
    $search: {
4
      index: "totalPriceIndex",
5
      range: {
6
        path: "totalPrice",
7
        lte: 300
8
      },
9
      returnStoredSource: true
10
    }
11
  }
12
])

[
  { _id: '10006546', totalPrice: 115 },
  { _id: '1001265', totalPrice: 215 },
  { _id: '10021707', totalPrice: 40 },
  { _id: '1003530', totalPrice: 270 },
  { _id: '10038496', totalPrice: 269 },
  { _id: '10051164', totalPrice: 250 },
  { _id: '10057447', totalPrice: 50 },
  { _id: '10057826', totalPrice: 205 },
  { _id: '10059244', totalPrice: 43 },
  { _id: '10066928', totalPrice: 140 },
  { _id: '10082422', totalPrice: 60 },
  { _id: '10083468', totalPrice: 40 },
  { _id: '10084023', totalPrice: 231 },
  { _id: '10091713', totalPrice: 231 },
  { _id: '10092679', totalPrice: 58 },
  { _id: '10096773', totalPrice: 205 },
  { _id: '10112159', totalPrice: 90 },
  { _id: '10117617', totalPrice: 55 },
  { _id: '10120414', totalPrice: 150 },
  { _id: '10133554', totalPrice: 121 }
]

Editar uma visualização

O exemplo a seguir atualiza a visualização movies_ReleasedAfter2000 do MongoDB para filmes anteriores a 2000.

db.runCommand(
{
    collMod: "movies_ReleasedAfter2000",
    viewOn: "movies",
    "pipeline": [
      {
        $match: {
          $expr: {
            $lt: [
              "$released",
              ISODate("2000-01-01T00")
            ]
          }
        }
      }
    ]
  }
)

Depois de executar este comando, o Atlas Search detecta automaticamente a alteração na definição da visualização e realiza uma reindexação sem interrupção.

Retornar os pipelines para uma visualização

O exemplo a seguir retorna os pipelines na visualização movies_ReleasedAfter2000.

1
db.getCollectionInfos({ name: "movies_ReleasedAfter2000" })[0].options.pipeline

[
  {
    '$match': {
      '$expr': { '$gt': [ '$released', ISODate('2000-01-01T00:00:00.000Z') ] }
    }
  }
]

Considerações de desempenho

Para índices criados em visualizações, o Atlas Search aplica as transformações ou filtros que você define no pipeline de visualização no momento da query e no momento da replicação. Embora transformações triviais ou filtros no pipeline de visualização geralmente resultem em impacto insignificante no desempenho, transformações complexas ou filtros muito seletivos no pipeline de visualização podem retardar significativamente a query ou a replicação. Se você quiser executar uma transformação pesada nos documentos ou aplicar um filtro altamente seletivo, considere criar uma visualização materializada com documentos já transformados ou filtrados. Você pode avaliar o desempenho da visualização comparando a latência da query executada com a visualização e com a sua coleção de origem.

Solução de problemas

Processo de índice

Quando você cria um índice Atlas Search em uma visualização, o processo mongot executa as mesmas tarefas que quando você cria um índice Atlas Search em uma coleção regular. O processo mongot:

1. Cria índices de Atlas Search com base nas regras na index definition para a collection.

2. Monitores fluxos de alterações para o estado atual dos documentos e índices para as coleções para as quais você definiu Atlas Search indexes.

3. Processa queries do Atlas Search e retorna os IDs dos documentos e outros metadados da pesquisa dos documentos correspondentes ao mongod, que então faz uma pesquisa completa do documento e retorna os resultados ao cliente.

Quando você cria um índice Atlas Search em uma View, a definição da View é aplicada durante as etapas 1 e 2, e os documentos transformados são armazenados no índice Atlas Search em disco.

Saiba mais

Para saber mais sobre visualizações, consulte Visualizações.

Para criar um índice do Atlas Vector Search em uma visualização, consulte Utilizar visualizações com o Atlas Vector Search.