yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-14 18:27:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc(mongodb): mongodb+srv connection scheme (#18712)

Browse Source 
- added information about the mongodb+srv connection scheme
- added link to atlas guide for getting the connection string
This commit is contained in:
Imri Paran 2024-11-21 19:42:35 +01:00 committed by GitHub
parent 253fc6be6f
commit d089ffa2d0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
openmetadata-docs/content/v1.6.x-SNAPSHOT/connectors/database/mongodb/index.md
View File

@ -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. - **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. - **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. - **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" /%} {% partial file="/v1.5/connectors/database/advanced-configuration.md" /%}
{% /extraContent %} {% /extraContent %}

4
openmetadata-docs/content/v1.6.x-SNAPSHOT/connectors/database/mongodb/yaml.md
View File

@ -74,7 +74,9 @@ This is a sample config for MongoDB:
{% codeInfo srNumber=3 %} {% 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 %} {% /codeInfo %}

2
openmetadata-spec/src/main/resources/json/schema/entity/services/connections/database/mongoDBConnection.json
View File

@ -51,7 +51,7 @@
}, },
"hostPort": { "hostPort": {
"title": "Host and Port", "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" "type": "string"
}, },
"connectionOptions": { "connectionOptions": {