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

DOCS - MSSQL service connection (#15843)

Browse Source
This commit is contained in:
Pere Miquel Brull 2024-04-09 15:28:49 +02:00 committed by GitHub
parent 7f5c166e3b
commit 11e1901a4a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 34 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
openmetadata-docs/content/v1.3.x/connectors/database/mssql/index.md
View File

@ -105,7 +105,8 @@ For details step please refer to this [link](https://docs.microsoft.com/en-us/sq
- **Password**: Password to connect to MSSQL. - **Password**: Password to connect to MSSQL.
- **Host and Port**: Enter the fully qualified hostname and port number for your MSSQL deployment in the Host and Port field. - **Host and Port**: Enter the fully qualified hostname and port number for your MSSQL deployment in the Host and Port field.
- **URI String**: In case of a `pyodbc` connection. - **URI String**: In case of a `pyodbc` connection.
- **Database (Optional)**: The database of the data source is an optional parameter, if you would like to restrict the metadata reading to a single database. If left blank, OpenMetadata ingestion attempts to scan all the databases. - **Database**: The initial database to establish a connection to the data source.
- **Ingest All Databases**: If you need to ingest multiple databases - aside from the initial one above - you can enable this option.
{% partial file="/v1.3/connectors/database/advanced-configuration.md" /%} {% partial file="/v1.3/connectors/database/advanced-configuration.md" /%}

21
openmetadata-docs/content/v1.3.x/connectors/database/mssql/yaml.md
View File

@ -109,12 +109,18 @@ This is a sample config for MSSQL:
{% codeInfo srNumber=5 %} {% codeInfo srNumber=5 %}
**Database**: The database of the data source is an optional parameter, if you would like to restrict the metadata reading to a single database. If left blank, OpenMetadata ingestion attempts to scan all the databases. **database**: The initial database to establish a connection to the data source.
{% /codeInfo %} {% /codeInfo %}
{% codeInfo srNumber=6 %} {% codeInfo srNumber=6 %}
**ingestAllDatabases**: If you need to ingest multiple databases - aside from the initial one above - you can enable this option.
{% /codeInfo %}
{% codeInfo srNumber=7 %}
**uriString**: In case of a `pyodbc` connection. **uriString**: In case of a `pyodbc` connection.
{% /codeInfo %} {% /codeInfo %}
@ -128,13 +134,13 @@ This is a sample config for MSSQL:
#### Advanced Configuration #### Advanced Configuration
{% codeInfo srNumber=7 %} {% codeInfo srNumber=8 %}
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to Athena during the connection. These details must be added as Key-Value pairs. **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to Athena during the connection. These details must be added as Key-Value pairs.
{% /codeInfo %} {% /codeInfo %}
{% codeInfo srNumber=8 %} {% codeInfo srNumber=9 %}
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Athena during the connection. These details must be added as Key-Value pairs. **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Athena during the connection. These details must be added as Key-Value pairs.
@ -167,9 +173,12 @@ source:
hostPort: <hostPort> hostPort: <hostPort>
``` ```
```yaml {% srNumber=5 %} ```yaml {% srNumber=5 %}
# database: <database> database: <database>
``` ```
```yaml {% srNumber=6 %} ```yaml {% srNumber=6 %}
ingestAllDatabases: false # true
```
```yaml {% srNumber=7 %}
uriString: uriString uriString: uriString
``` ```
```yaml ```yaml
@ -184,11 +193,11 @@ source:
hostPort: <hostPort> hostPort: <hostPort>
# database: <database> # database: <database>
``` ```
```yaml {% srNumber=7 %} ```yaml {% srNumber=8 %}
# connectionOptions: # connectionOptions:
# key: value # key: value
``` ```
```yaml {% srNumber=8 %} ```yaml {% srNumber=9 %}
# connectionArguments: # connectionArguments:
# key: value # key: value
``` ```

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

@ -105,7 +105,8 @@ For details step please refer to this [link](https://docs.microsoft.com/en-us/sq
- **Password**: Password to connect to MSSQL. - **Password**: Password to connect to MSSQL.
- **Host and Port**: Enter the fully qualified hostname and port number for your MSSQL deployment in the Host and Port field. - **Host and Port**: Enter the fully qualified hostname and port number for your MSSQL deployment in the Host and Port field.
- **URI String**: In case of a `pyodbc` connection. - **URI String**: In case of a `pyodbc` connection.
- **Database (Optional)**: The database of the data source is an optional parameter, if you would like to restrict the metadata reading to a single database. If left blank, OpenMetadata ingestion attempts to scan all the databases. - **Database**: The initial database to establish a connection to the data source.
- **Ingest All Databases**: If you need to ingest multiple databases - aside from the initial one above - you can enable this option.
{% partial file="/v1.4/connectors/database/advanced-configuration.md" /%} {% partial file="/v1.4/connectors/database/advanced-configuration.md" /%}

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

@ -109,12 +109,18 @@ This is a sample config for MSSQL:
{% codeInfo srNumber=5 %} {% codeInfo srNumber=5 %}
**Database**: The database of the data source is an optional parameter, if you would like to restrict the metadata reading to a single database. If left blank, OpenMetadata ingestion attempts to scan all the databases. **database**: The initial database to establish a connection to the data source.
{% /codeInfo %} {% /codeInfo %}
{% codeInfo srNumber=6 %} {% codeInfo srNumber=6 %}
**ingestAllDatabases**: If you need to ingest multiple databases - aside from the initial one above - you can enable this option.
{% /codeInfo %}
{% codeInfo srNumber=7 %}
**uriString**: In case of a `pyodbc` connection. **uriString**: In case of a `pyodbc` connection.
{% /codeInfo %} {% /codeInfo %}
@ -128,13 +134,13 @@ This is a sample config for MSSQL:
#### Advanced Configuration #### Advanced Configuration
{% codeInfo srNumber=7 %} {% codeInfo srNumber=8 %}
**Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to Athena during the connection. These details must be added as Key-Value pairs. **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to Athena during the connection. These details must be added as Key-Value pairs.
{% /codeInfo %} {% /codeInfo %}
{% codeInfo srNumber=8 %} {% codeInfo srNumber=9 %}
**Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Athena during the connection. These details must be added as Key-Value pairs. **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent to Athena during the connection. These details must be added as Key-Value pairs.
@ -167,9 +173,12 @@ source:
hostPort: <hostPort> hostPort: <hostPort>
``` ```
```yaml {% srNumber=5 %} ```yaml {% srNumber=5 %}
# database: <database> database: <database>
``` ```
```yaml {% srNumber=6 %} ```yaml {% srNumber=6 %}
ingestAllDatabases: false # true
```
```yaml {% srNumber=7 %}
uriString: uriString uriString: uriString
``` ```
```yaml ```yaml
@ -184,11 +193,11 @@ source:
hostPort: <hostPort> hostPort: <hostPort>
# database: <database> # database: <database>
``` ```
```yaml {% srNumber=7 %} ```yaml {% srNumber=8 %}
# connectionOptions: # connectionOptions:
# key: value # key: value
``` ```
```yaml {% srNumber=8 %} ```yaml {% srNumber=9 %}
# connectionArguments: # connectionArguments:
# key: value # key: value
``` ```