mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-08-22 07:58:06 +00:00
Mssql docs (#11196)
This commit is contained in:
parent
c14ef44d5c
commit
fa39f2732a
@ -46,6 +46,15 @@ To deploy OpenMetadata, check the Deployment guides.
|
||||
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with
|
||||
custom Airflow plugins to handle the workflow deployment.
|
||||
|
||||
MSSQL User must grant `SELECT` privilege to fetch the metadata of tables and views.
|
||||
|
||||
```sql
|
||||
-- Create a new user
|
||||
-- More details https://learn.microsoft.com/en-us/sql/t-sql/statements/create-user-transact-sql?view=sql-server-ver16
|
||||
CREATE USER Mary WITH PASSWORD = '********';
|
||||
-- Grant SELECT on table
|
||||
GRANT SELECT TO Mary;
|
||||
```
|
||||
### Python Requirements
|
||||
|
||||
To run the MSSQL ingestion, you will need to install:
|
||||
|
@ -46,6 +46,15 @@ To deploy OpenMetadata, check the Deployment guides.
|
||||
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with
|
||||
custom Airflow plugins to handle the workflow deployment.
|
||||
|
||||
MSSQL User must grant `SELECT` privilege to fetch the metadata of tables and views.
|
||||
|
||||
```sql
|
||||
-- Create a new user
|
||||
-- More details https://learn.microsoft.com/en-us/sql/t-sql/statements/create-user-transact-sql?view=sql-server-ver16
|
||||
CREATE USER Mary WITH PASSWORD = '********';
|
||||
-- Grant SELECT on table
|
||||
GRANT SELECT TO Mary;
|
||||
```
|
||||
### Python Requirements
|
||||
|
||||
To run the MSSQL ingestion, you will need to install:
|
||||
|
@ -66,6 +66,15 @@ To deploy OpenMetadata, check the Deployment guides.
|
||||
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with
|
||||
custom Airflow plugins to handle the workflow deployment.
|
||||
|
||||
MSSQL User must grant `SELECT` privilege to fetch the metadata of tables and views.
|
||||
|
||||
```sql
|
||||
-- Create a new user
|
||||
-- More details https://learn.microsoft.com/en-us/sql/t-sql/statements/create-user-transact-sql?view=sql-server-ver16
|
||||
CREATE USER Mary WITH PASSWORD = '********';
|
||||
-- Grant SELECT on table
|
||||
GRANT SELECT TO Mary;
|
||||
```
|
||||
### For Remote Connection
|
||||
|
||||
#### 1. SQL Server running
|
||||
|
@ -11,7 +11,7 @@ slug: /main-concepts/metadata-standard/schemas/entity/services/connections/datab
|
||||
|
||||
- **`type`**: Service Type. Refer to *#/definitions/mssqlType*. Default: `Mssql`.
|
||||
- **`scheme`**: SQLAlchemy driver scheme options. Refer to *#/definitions/mssqlScheme*. Default: `mssql+pytds`.
|
||||
- **`username`** *(string)*: Username to connect to MSSQL. This user should have privileges to read all the metadata in MsSQL.
|
||||
- **`username`** *(string)*: Username to connect to MSSQL. This user should have privileges to read all the metadata in MSSQL.
|
||||
- **`password`** *(string)*: Password to connect to MSSQL.
|
||||
- **`hostPort`** *(string)*: Host and port of the MSSQL service.
|
||||
- **`database`** *(string)*: Database of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single database. When left blank, OpenMetadata Ingestion attempts to scan all the databases.
|
||||
|
@ -39,6 +39,16 @@ To deploy OpenMetadata, check the <a href="/deployment">Deployment</a> guides.
|
||||
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with
|
||||
custom Airflow plugins to handle the workflow deployment.
|
||||
|
||||
|
||||
MSSQL User must grant `SELECT` privilege to fetch the metadata of tables and views.
|
||||
|
||||
```sql
|
||||
-- Create a new user
|
||||
-- More details https://learn.microsoft.com/en-us/sql/t-sql/statements/create-user-transact-sql?view=sql-server-ver16
|
||||
CREATE USER Mary WITH PASSWORD = '********';
|
||||
-- Grant SELECT on table
|
||||
GRANT SELECT TO Mary;
|
||||
```
|
||||
### Python Requirements
|
||||
|
||||
To run the MSSQL ingestion, you will need to install:
|
||||
|
@ -61,6 +61,16 @@ To deploy OpenMetadata, check the <a href="/deployment">Deployment</a> guides.
|
||||
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with
|
||||
custom Airflow plugins to handle the workflow deployment.
|
||||
|
||||
MSSQL User must grant `SELECT` privilege to fetch the metadata of tables and views.
|
||||
|
||||
```sql
|
||||
-- Create a new user
|
||||
-- More details https://learn.microsoft.com/en-us/sql/t-sql/statements/create-user-transact-sql?view=sql-server-ver16
|
||||
CREATE USER Mary WITH PASSWORD = '********';
|
||||
-- Grant SELECT on table
|
||||
GRANT SELECT TO Mary;
|
||||
```
|
||||
|
||||
### For Remote Connection
|
||||
|
||||
#### 1. SQL Server running
|
||||
|
@ -11,7 +11,7 @@ slug: /main-concepts/metadata-standard/schemas/entity/services/connections/datab
|
||||
|
||||
- **`type`**: Service Type. Refer to *#/definitions/mssqlType*. Default: `Mssql`.
|
||||
- **`scheme`**: SQLAlchemy driver scheme options. Refer to *#/definitions/mssqlScheme*. Default: `mssql+pytds`.
|
||||
- **`username`** *(string)*: Username to connect to MSSQL. This user should have privileges to read all the metadata in MsSQL.
|
||||
- **`username`** *(string)*: Username to connect to MSSQL. This user should have privileges to read all the metadata in MSSQL.
|
||||
- **`password`** *(string)*: Password to connect to MSSQL.
|
||||
- **`hostPort`** *(string)*: Host and port of the MSSQL service.
|
||||
- **`database`** *(string)*: Database of the data source. This is optional parameter, if you would like to restrict the metadata reading to a single database. When left blank, OpenMetadata Ingestion attempts to scan all the databases.
|
||||
|
@ -7,6 +7,22 @@ In this section, we provide guides and references to use the Mssql connector.
|
||||
To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with
|
||||
custom Airflow plugins to handle the workflow deployment.
|
||||
|
||||
MSSQL User must grant `SELECT` privilege to fetch the metadata of tables and views.
|
||||
|
||||
```sql
|
||||
-- Create a new user
|
||||
-- More details https://learn.microsoft.com/en-us/sql/t-sql/statements/create-user-transact-sql?view=sql-server-ver16
|
||||
CREATE USER Mary WITH PASSWORD = '********';
|
||||
-- Grant SELECT on table
|
||||
GRANT SELECT TO Mary;
|
||||
```
|
||||
|
||||
### Profiler & Data Quality
|
||||
Executing the profiler worflow or data quality tests, will require the user to have `SELECT` permission on the tables/schemas where the profiler/tests will be executed. More information on the profiler workflow setup can be found [here](https://docs.open-metadata.org/connectors/ingestion/workflows/profiler) and data quality tests [here](https://docs.open-metadata.org/connectors/ingestion/workflows/data-quality).
|
||||
|
||||
### Usage & Lineage
|
||||
For the usage and lineage workflow, the user will need `SELECT` privilege table. You can find more information on the usage workflow [here](https://docs.open-metadata.org/connectors/ingestion/workflows/usage) and the lineage workflow [here](https://docs.open-metadata.org/connectors/ingestion/workflows/lineage).
|
||||
|
||||
### For Remote Connection
|
||||
|
||||
#### 1. SQL Server running
|
||||
@ -43,14 +59,17 @@ For details step please refer the this [link](https://docs.microsoft.com/en-us/s
|
||||
|
||||
$$section
|
||||
### Scheme $(id="scheme")
|
||||
|
||||
SQLAlchemy driver scheme options.
|
||||
There are three schemes based on the user's requirement to fetch data from MSSQL:
|
||||
- **mssql+pytds**: High-performance open-source library for connecting to Microsoft SQL Server.
|
||||
- **mssql+pyodbc**: Cross-platform Python library that uses ODBC to connect to Microsoft SQL Server.
|
||||
- *mssql+pymssql**: Python library that uses FreeTDS to connect to Microsoft SQL Server, with support for bulk data transfer and query timeouts.
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Username $(id="username")
|
||||
|
||||
Username to connect to MSSQL. This user should have privileges to read all the metadata in MsSQL.
|
||||
Username to connect to MSSQL.
|
||||
This user should have privileges to read all the metadata in MSSQL.
|
||||
$$
|
||||
|
||||
$$section
|
||||
@ -62,8 +81,7 @@ $$
|
||||
$$section
|
||||
### Host Port $(id="hostPort")
|
||||
|
||||
Host and port of the MSSQL service.
|
||||
Example: `localhost:1433`
|
||||
The hostPort parameter specifies the host and port of the MSSQL instance. This should be specified as a string in the format `http://hostname:port` or `https://hostname:port`. For example, you might set the hostPort parameter to `https://:3000`.
|
||||
$$
|
||||
|
||||
$$section
|
||||
@ -75,26 +93,20 @@ $$
|
||||
$$section
|
||||
### Uri String $(id="uriString")
|
||||
|
||||
Connection URI In case of pyodbc
|
||||
Connection URI String to connect with MSSQL. It only works with `pyodbc` scheme.
|
||||
Example: `DRIVER={ODBC Driver 17 for SQL Server};SERVER=server_name;DATABASE=db_name;UID=user_name;PWD=password`.
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Connection Options $(id="connectionOptions")
|
||||
|
||||
Additional connection options to build the URL that can be sent to service during the connection.
|
||||
<!-- connectionOptions to be updated -->
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Connection Arguments $(id="connectionArguments")
|
||||
|
||||
Additional connection arguments such as security or protocol configs that can be sent to service during connection.
|
||||
<!-- connectionArguments to be updated -->
|
||||
$$
|
||||
|
||||
$$section
|
||||
### Supports Database $(id="supportsDatabase")
|
||||
|
||||
The source service supports the database concept in its hierarchy
|
||||
<!-- supportsDatabase to be updated -->
|
||||
$$
|
||||
Enter the details for any additional connection arguments such as security or protocol configs that can be sent to MSSQL during the connection. These details must be added as Key-Value pairs.
|
||||
- In case you are using Single-Sign-On (SSO) for authentication, add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "sso_login_url".
|
||||
- In case you authenticate with SSO using an external browser popup, then add the authenticator details in the Connection Arguments as a Key-Value pair as follows: "authenticator" : "externalbrowser".
|
||||
$$
|
Loading…
x
Reference in New Issue
Block a user