Skip to content

Commit

Permalink
doc(mongodb): mongodb+srv connection scheme (#18712)
Browse files Browse the repository at this point in the history
- added information about the mongodb+srv connection scheme
- added link to atlas guide for getting the connection string
  • Loading branch information
sushi30 authored Nov 21, 2024
1 parent 253fc6b commit d089ffa
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,11 @@ To fetch the metadata from MongoDB to OpenMetadata, the MongoDB user must have a

- **Username**: Username to connect to Mongodb. This user must have access to perform `find` operation on collection and `listCollection` operations on database available in MongoDB.
- **Password**: Password to connect to MongoDB.
- **Host Port**: The hostPort parameter specifies the host and port of the MongoDB. This should be specified as a string in the format `hostname:port`. E.g., `localhost:27017`.
- **Host Port**: When using the `mongodb` connecion schema, the hostPort parameter specifies the host and port of the MongoDB. This should be specified as a string in the format `hostname:port`. E.g., `localhost:27017`. When using the `mongodb+srv` connection schema, the hostPort parameter specifies the host and port of the MongoDB. This should be specified as a string in the format `hostname`. E.g., `cluster0-abcde.mongodb.net`.
- **databaseName**: Optional name to give to the database in OpenMetadata. If left blank, we will use default as the database name.

Using Atlas? Follow [this guide](https://www.mongodb.com/docs/guides/atlas/connection-string/) to get the connection string.

{% partial file="/v1.5/connectors/database/advanced-configuration.md" /%}

{% /extraContent %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,9 @@ This is a sample config for MongoDB:

{% codeInfo srNumber=3 %}

**hostPort**: The hostPort parameter specifies the host and port of the MongoDB. This should be specified as a string in the format `hostname:port`. E.g., `localhost:27017`.
**hostPort**: When using the `mongodb` connecion schema, the hostPort parameter specifies the host and port of the MongoDB. This should be specified as a string in the format `hostname:port`. E.g., `localhost:27017`. When using the `mongodb+srv` connection schema, the hostPort parameter specifies the host and port of the MongoDB. This should be specified as a string in the format `hostname`. E.g., `cluster0-abcde.mongodb.net`.

Using Atlas? Follow [this guide](https://www.mongodb.com/docs/guides/atlas/connection-string/) to get the connection string.

{% /codeInfo %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
},
"hostPort": {
"title": "Host and Port",
"description": "Host and port of the MongoDB service.",
"description": "Host and port of the MongoDB service when using the `mongodb` connection scheme. Only host when using the `mongodb+srv` scheme.",
"type": "string"
},
"connectionOptions": {
Expand Down

0 comments on commit d089ffa

Please sign in to comment.