> For the complete documentation index, see [llms.txt](https://docs.skyone.cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.skyone.cloud/skyone-studio/modulos/configuracoes-and-operacoes/operacoes-de-modulos/operacao-mongodb.md).

# Operação MongoDB

Acompanhe, a seguir, os métodos possíveis em operações MongoDB:

### Método de Banco de Dados (Db)

* `collection(name)`: Seleciona uma coleção específica.

### Métodos de Coleção (Collection)

Estes são os métodos de CRUD (Create, Read, Update, Delete) executados em uma coleção específica.

#### **Criação (Create)**

* `insertOne(doc)`: Insere um único document na coleção.
* `insertMany([docs])`: Insere múltiplos documents de uma só vez.

#### **Leitura (Read)**

* `find(query)`: Busca múltiplos documents. Ele retorna um cursor, que você pode transformar em array usando .toArray().
* `findOne(query)`: Busca e retorna apenas o primeiro document que satisfaça o filtro.
* `countDocuments(query)`: Conta quantos documents atendem aos critérios da busca.
* `distinct(field, query)`: Retorna uma lista de valores únicos para um campo específico.

#### **Atualização (Update)**

* `updateOne(filter, update)`: Atualiza o primeiro document encontrado pelo filtro.
* `updateMany(filter, update)`: Atualiza todos os documents que correspondem ao filtro.
* `replaceOne(filter, replacement)`: Substitui um document inteiro por um novo, mantendo apenas o \_id.
* `findOneAndUpdate(filter, update)`: Busca um document, aplica a atualização e retorna o original (ou o atualizado, dependendo das opções).

#### **Exclusão (Delete)**

* `deleteOne(filter)`: Remove o primeiro document que corresponde ao filtro.
* `deleteMany(filter)`: Remove todos os documents que correspondem ao filtro.

### Métodos de Agregação e Performance

* `aggregate(pipeline)`: Executa um Aggregation Framework pipeline para transformações de dados complexas.
* `createIndex(keys, options)`: Cria um index na coleção para melhorar a performance das buscas.
* `drop()`: Remove a coleção inteira do banco de dados.

### Como referenciar a Collection (2 tipos)

1. **Acesso Direto via Propriedade (Dot Notation):** Utilizado quando o nome da coleção não possui caracteres especiais ou espaços. Exemplo: db.users ou db.products
2. **Método collection() com String:** É a forma mais segura e recomendada na documentação do driver mongodb para Node.js. Permite usar aspas simples ou duplas e aceita nomes com espaços ou caracteres especiais. Exemplo: db.collection('users') ou db.collection("active-logs")

#### Operações comuns logo após referenciar a collection

Uma vez que você referenciou a collection usando um dos métodos acima, você geralmente encadeia os métodos de busca ou manipulação:

* `db.collection('users').find({})`
* `db.users.insertOne({ name: "Dev" })`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.skyone.cloud/skyone-studio/modulos/configuracoes-and-operacoes/operacoes-de-modulos/operacao-mongodb.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.