> ## 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.

> Allows `SELECT` queries to be performed on data that is stored on a remote MongoDB server.

# mongodb

Allows `SELECT` queries to be performed on data that is stored on a remote MongoDB server.

<h2 id="syntax">
  Syntax
</h2>

```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>...]);
```

<h2 id="arguments">
  Arguments
</h2>

| Argument      | Description                                                                                            |
| ------------- | ------------------------------------------------------------------------------------------------------ |
| `host:port`   | MongoDB server address.                                                                                |
| `database`    | Remote database name.                                                                                  |
| `collection`  | Remote collection name.                                                                                |
| `user`        | MongoDB user.                                                                                          |
| `password`    | User password.                                                                                         |
| `structure`   | The schema for the ClickHouse table returned from this function.                                       |
| `options`     | MongoDB connection string options (optional parameter).                                                |
| `oid_columns` | Comma-separated list of columns that should be treated as `oid` in the WHERE clause. `_id` by default. |

<Tip>
  If you are using the MongoDB Atlas cloud offering please add these options:

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

You can also connect by URI:

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

| Argument      | Description                                                                                            |
| ------------- | ------------------------------------------------------------------------------------------------------ |
| `uri`         | Connection string.                                                                                     |
| `collection`  | Remote collection name.                                                                                |
| `structure`   | The schema for the ClickHouse table returned from this function.                                       |
| `oid_columns` | Comma-separated list of columns that should be treated as `oid` in the WHERE clause. `_id` by default. |
| :::           |                                                                                                        |

You can pass the arguments using a named collection:

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

<h2 id="returned_value">
  Returned value
</h2>

A table object with the same columns as the original MongoDB table.

<h2 id="examples">
  Examples
</h2>

Suppose we have a collection named `my_collection` defined in a MongoDB database named `test`, and we insert a couple of documents:

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

Let's query the collection using the `mongodb` table function:

```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'
)
```

or:

```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'
)
```

or:

```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'
)
```

<h2 id="related">
  Related
</h2>

* [The `MongoDB` table engine](/reference/engines/table-engines/integrations/mongodb)
* [Using MongoDB as a dictionary source](/reference/statements/create/dictionary/sources/mongodb)