mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-11-09 07:23:39 +00:00
Update ingestion connector docs
This commit is contained in:
parent
2d09b83183
commit
c4a89a2cab
@ -12,21 +12,28 @@ description: This guide will help install MsSQL connector and run manually
|
|||||||
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
|
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
|
||||||
|
|
||||||
1. Python 3.7 or above
|
1. Python 3.7 or above
|
||||||
2. Create and activate python env
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python3 -m venv env
|
|
||||||
source env/bin/activate
|
|
||||||
```
|
|
||||||
{% endhint %}
|
{% endhint %}
|
||||||
|
|
||||||
\*\*\*\*
|
|
||||||
|
|
||||||
## Install
|
### Install from PyPI or Source
|
||||||
|
|
||||||
|
{% tabs %}
|
||||||
|
{% tab title="Install Using PyPI" %}
|
||||||
```bash
|
```bash
|
||||||
|
pip install 'openmetadata-ingestion[mssql]'
|
||||||
|
```
|
||||||
|
{% endtab %}
|
||||||
|
{% tab title="Build from source " %}
|
||||||
|
```bash
|
||||||
|
# checkout OpenMetadata
|
||||||
|
git clone https://github.com/open-metadata/OpenMetadata.git
|
||||||
|
cd OpenMetadata/ingestion
|
||||||
|
python3 -m venv env
|
||||||
|
source env/bin/activate
|
||||||
pip install '.[mssql]'
|
pip install '.[mssql]'
|
||||||
```
|
```
|
||||||
|
{% endtab %}
|
||||||
|
{% endtabs %}
|
||||||
|
|
||||||
## Run Manually
|
## Run Manually
|
||||||
|
|
||||||
@ -64,3 +71,53 @@ metadata ingest -c ./pipelines/mssql.json
|
|||||||
5. **table\_pattern** - It contains allow, deny options to choose which pattern of datasets you want to ingest into OpenMetadata.
|
5. **table\_pattern** - It contains allow, deny options to choose which pattern of datasets you want to ingest into OpenMetadata.
|
||||||
6. **database** - \_\*\*\_Database name from where data is to be fetched from.
|
6. **database** - \_\*\*\_Database name from where data is to be fetched from.
|
||||||
|
|
||||||
|
## Publish to OpenMetadata
|
||||||
|
|
||||||
|
{% code title="mssql.json" %}
|
||||||
|
```javascript
|
||||||
|
{
|
||||||
|
"source": {
|
||||||
|
"type": "mssql",
|
||||||
|
"config": {
|
||||||
|
"host_port": "localhost:1433",
|
||||||
|
"service_name": "local_mssql",
|
||||||
|
"service_type": "MSSQL",
|
||||||
|
"database":"catalog_test",
|
||||||
|
"username": "sa",
|
||||||
|
"password": "test!Password",
|
||||||
|
"include_pattern": {
|
||||||
|
"excludes": ["catalog_test.*"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"processor": {
|
||||||
|
"type": "pii-tags",
|
||||||
|
"config": {
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"sink": {
|
||||||
|
"type": "metadata-rest-tables",
|
||||||
|
"config": {
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"metadata_server": {
|
||||||
|
"type": "metadata-server",
|
||||||
|
"config": {
|
||||||
|
"api_endpoint": "http://localhost:8585/api",
|
||||||
|
"auth_provider_type": "no-auth"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"cron": {
|
||||||
|
"minute": "*/5",
|
||||||
|
"hour": null,
|
||||||
|
"day": null,
|
||||||
|
"month": null,
|
||||||
|
"day_of_week": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
...
|
||||||
|
```
|
||||||
|
{% endcode %}
|
||||||
|
|
||||||
|
Add Optional ```pii-tags``` processor
|
||||||
|
and ```metadata-rest-tables``` sink along with ```metadata-server``` config
|
||||||
@ -20,11 +20,25 @@ OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
|
|||||||
```
|
```
|
||||||
{% endhint %}
|
{% endhint %}
|
||||||
|
|
||||||
### Install
|
### Install from PyPI or Source
|
||||||
|
|
||||||
|
{% tabs %}
|
||||||
|
{% tab title="Install Using PyPI" %}
|
||||||
```bash
|
```bash
|
||||||
|
pip install 'openmetadata-ingestion[mysql]'
|
||||||
|
```
|
||||||
|
{% endtab %}
|
||||||
|
{% tab title="Build from source " %}
|
||||||
|
```bash
|
||||||
|
# checkout OpenMetadata
|
||||||
|
git clone https://github.com/open-metadata/OpenMetadata.git
|
||||||
|
cd OpenMetadata/ingestion
|
||||||
|
python3 -m venv env
|
||||||
|
source env/bin/activate
|
||||||
pip install '.[mysql]'
|
pip install '.[mysql]'
|
||||||
```
|
```
|
||||||
|
{% endtab %}
|
||||||
|
{% endtabs %}
|
||||||
|
|
||||||
### Run Manually
|
### Run Manually
|
||||||
|
|
||||||
@ -57,3 +71,50 @@ metadata ingest -c ./pipelines/mysql.json
|
|||||||
3. **service\_name** - Service Name for this MySQL cluster. If you added MySQL cluster through OpenMetadata UI, make sure the service name matches the same.
|
3. **service\_name** - Service Name for this MySQL cluster. If you added MySQL cluster through OpenMetadata UI, make sure the service name matches the same.
|
||||||
4. **table\_pattern** - It contains allow, deny options to choose which pattern of datasets you want to ingest into OpenMetadata
|
4. **table\_pattern** - It contains allow, deny options to choose which pattern of datasets you want to ingest into OpenMetadata
|
||||||
|
|
||||||
|
## Publish to OpenMetadata
|
||||||
|
|
||||||
|
{% code title="mysql.json" %}
|
||||||
|
```javascript
|
||||||
|
{
|
||||||
|
"source": {
|
||||||
|
"type": "mysql",
|
||||||
|
"config": {
|
||||||
|
"username": "openmetadata_user",
|
||||||
|
"password": "openmetadata_password",
|
||||||
|
"service_name": "local_mysql",
|
||||||
|
"service_type": "MySQL",
|
||||||
|
"include_pattern": {
|
||||||
|
"excludes": ["mysql.*", "information_schema.*"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"processor": {
|
||||||
|
"type": "pii-tags",
|
||||||
|
"config": {
|
||||||
|
"api_endpoint": "http://localhost:8585/api"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"sink": {
|
||||||
|
"type": "metadata-rest-tables",
|
||||||
|
"config": {
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"metadata_server": {
|
||||||
|
"type": "metadata-server",
|
||||||
|
"config": {
|
||||||
|
"api_endpoint": "http://localhost:8585/api",
|
||||||
|
"auth_provider_type": "no-auth"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"cron": {
|
||||||
|
"minute": "*/5",
|
||||||
|
"hour": null,
|
||||||
|
"day": null,
|
||||||
|
"month": null,
|
||||||
|
"day_of_week": null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
{% endcode %}
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@ -12,19 +12,29 @@ description: This guide will help install Postgres connector and run manually
|
|||||||
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
|
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
|
||||||
|
|
||||||
1. Python 3.7 or above
|
1. Python 3.7 or above
|
||||||
2. Create and activate python env
|
|
||||||
|
|
||||||
```bash
|
|
||||||
python3 -m venv env
|
|
||||||
source env/bin/activate
|
|
||||||
```
|
|
||||||
{% endhint %}
|
{% endhint %}
|
||||||
|
|
||||||
### Install
|
### Install from PyPI or Source
|
||||||
|
|
||||||
|
{% tabs %}
|
||||||
|
{% tab title="Install Using PyPI" %}
|
||||||
```bash
|
```bash
|
||||||
|
pip install 'openmetadata-ingestion[postgres]'
|
||||||
|
```
|
||||||
|
{% endtab %}
|
||||||
|
{% tab title="Build from source " %}
|
||||||
|
```bash
|
||||||
|
# checkout OpenMetadata
|
||||||
|
git clone https://github.com/open-metadata/OpenMetadata.git
|
||||||
|
cd OpenMetadata/ingestion
|
||||||
|
python3 -m venv env
|
||||||
|
source env/bin/activate
|
||||||
pip install '.[postgres]'
|
pip install '.[postgres]'
|
||||||
```
|
```
|
||||||
|
{% endtab %}
|
||||||
|
{% endtabs %}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Run Manually
|
### Run Manually
|
||||||
|
|
||||||
|
|||||||
@ -15,31 +15,32 @@ OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
|
|||||||
2. Create and activate python env
|
2. Create and activate python env
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
python3 -m venv env
|
|
||||||
source env/bin/activate
|
|
||||||
```
|
```
|
||||||
{% endhint %}
|
{% endhint %}
|
||||||
|
|
||||||
### Build from source or PyPI
|
### Install from PyPI or Source
|
||||||
|
|
||||||
{% tabs %}
|
{% tabs %}
|
||||||
|
{% tab title="Install Using PyPI" %}
|
||||||
|
```bash
|
||||||
|
pip install 'openmetadata-ingestion[sample-tables, elasticsearch]'
|
||||||
|
```
|
||||||
|
{% endtab %}
|
||||||
{% tab title="Build from source " %}
|
{% tab title="Build from source " %}
|
||||||
```bash
|
```bash
|
||||||
# checkout OpenMetadata
|
# checkout OpenMetadata
|
||||||
git clone https://github.com/open-metadata/OpenMetadata.git
|
git clone https://github.com/open-metadata/OpenMetadata.git
|
||||||
cd OpenMetadata/ingestion
|
cd OpenMetadata/ingestion
|
||||||
|
python3 -m venv env
|
||||||
|
source env/bin/activate
|
||||||
|
pip install '.[sample-tables, elasticsearch]'
|
||||||
```
|
```
|
||||||
{% endtab %}
|
|
||||||
|
|
||||||
{% tab title="Install Using PyPI" %}
|
|
||||||
|
|
||||||
{% endtab %}
|
{% endtab %}
|
||||||
{% endtabs %}
|
{% endtabs %}
|
||||||
|
|
||||||
### Ingest sample tables and users
|
### Ingest sample tables and users
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install '.[sample-tables]'
|
|
||||||
metadata ingest -c ./pipelines/sample_tables.json
|
metadata ingest -c ./pipelines/sample_tables.json
|
||||||
metadata ingest -c ./pipelines/sample_users.json
|
metadata ingest -c ./pipelines/sample_users.json
|
||||||
```
|
```
|
||||||
@ -55,7 +56,6 @@ docker run -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" docker.elas
|
|||||||
Index sample data in ElasticSearch:
|
Index sample data in ElasticSearch:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pip install '.[elasticsearch]'
|
|
||||||
metadata ingest -c ./pipelines/metadata_to_es.json
|
metadata ingest -c ./pipelines/metadata_to_es.json
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user