> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-fix-nav-issues.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Позволяет выполнять `SELECT`-запросы к данным, хранящимся на удалённом сервере MongoDB.

# mongodb

Позволяет выполнять `SELECT`-запросы к данным, хранящимся на удалённом сервере MongoDB.

<div id="syntax">
  ## Синтаксис
</div>

```sql theme={null}
mongodb(host:port, database, collection, user, password, structure[, options[, oid_columns]]);
mongodb(uri, collection, structure[, oid_columns]);
mongodb(named_collection_name[, <arg>=<value>...]);
```

<div id="arguments">
  ## Аргументы
</div>

| Аргумент      | Описание                                                                                                                |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `host:port`   | Адрес сервера MongoDB.                                                                                                  |
| `database`    | Имя удалённой базы данных.                                                                                              |
| `collection`  | Имя удалённой коллекции.                                                                                                |
| `user`        | Пользователь MongoDB.                                                                                                   |
| `password`    | Пароль пользователя.                                                                                                    |
| `structure`   | Схема таблицы ClickHouse, которую возвращает эта функция.                                                               |
| `options`     | Параметры строки подключения MongoDB (необязательный параметр).                                                         |
| `oid_columns` | Разделённый запятыми список столбцов, которые следует обрабатывать как `oid` в предложении WHERE. По умолчанию — `_id`. |

<Tip>
  Если вы используете облачный сервис MongoDB Atlas, добавьте следующие параметры:

  ```ini theme={null}
  'connectTimeoutMS=10000&ssl=true&authSource=admin'
  ```
</Tip>

Вы также можете подключиться с помощью URI:

```sql theme={null}
mongodb(uri, collection, structure[, oid_columns])
```

| Аргумент      | Описание                                                                                                                 |
| ------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `uri`         | Строка подключения.                                                                                                      |
| `collection`  | Имя удалённой коллекции.                                                                                                 |
| `structure`   | Схема таблицы ClickHouse, которую возвращает эта функция.                                                                |
| `oid_columns` | Список столбцов, разделённых запятыми, которые следует обрабатывать как `oid` в предложении WHERE. По умолчанию — `_id`. |
| :::           |                                                                                                                          |

Вы можете передать аргументы с помощью именованной коллекции:

```sql theme={null}
mongodb(_named_collection_[, host][, port][, database][, collection][, user][, password][, structure][, options][, oid_columns])
-- или
mongodb(_named_collection_[, uri][, structure][, oid_columns])
```

<div id="returned_value">
  ## Возвращаемое значение
</div>

Объект таблицы с теми же столбцами, что и у исходной таблицы MongoDB.

<div id="examples">
  ## Примеры
</div>

Предположим, у нас есть коллекция `my_collection` в базе данных MongoDB `test`, и мы вставляем в неё пару документов:

```sql theme={null}
db.createUser({user:"test_user",pwd:"password",roles:[{role:"readWrite",db:"test"}]})

db.createCollection("my_collection")

db.my_collection.insertOne(
    { log_type: "event", host: "120.5.33.9", command: "check-cpu-usage -w 75 -c 90" }
)

db.my_collection.insertOne(
    { log_type: "event", host: "120.5.33.4", command: "system-check"}
)
```

Давайте выполним запрос к коллекции с помощью table function `mongodb`:

```sql theme={null}
SELECT * FROM mongodb(
    '127.0.0.1:27017',
    'test',
    'my_collection',
    'test_user',
    'password',
    'log_type String, host String, command String',
    'connectTimeoutMS=10000'
)
```

или:

```sql theme={null}
SELECT * FROM mongodb(
    'mongodb://test_user:password@127.0.0.1:27017/test?connectionTimeoutMS=10000',
    'my_collection',
    'log_type String, host String, command String'
)
```

или:

```sql theme={null}
CREATE NAMED COLLECTION mongo_creds AS
       uri='mongodb://test_user:password@127.0.0.1:27017/test?connectionTimeoutMS=10000',
       collection='default_collection';

SELECT * FROM mongodb(
        mongo_creds,
        collection = 'my_collection',
        structure = 'log_type String, host String, command String'
)
```

<div id="related">
  ## См. также
</div>

* [`MongoDB` — движок таблицы](/ru/reference/engines/table-engines/integrations/mongodb)
* [Использование MongoDB в качестве источника словаря](/ru/reference/statements/create/dictionary/sources/mongodb)