mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-19 15:31:59 +00:00
13be70e416
* updated documentation * addressing pyline findings * addressing pyline findings * doc update Co-authored-by: parthp2107 <parth@getcollate.io>
102 lines
2.3 KiB
Markdown
102 lines
2.3 KiB
Markdown
---
|
|
description: This guide will help install MySQL connector and run manually
|
|
---
|
|
|
|
# MySQL
|
|
|
|
{% hint style="info" %}
|
|
**Prerequisites**
|
|
|
|
OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
|
|
|
|
1. Python 3.7 or above
|
|
{% endhint %}
|
|
|
|
### Install from PyPI or Source
|
|
|
|
{% tabs %}
|
|
{% tab title="Install Using PyPI" %}
|
|
```bash
|
|
pip install 'openmetadata-ingestion[mysql]'
|
|
python -m spacy download en_core_web_sm
|
|
```
|
|
{% endtab %}
|
|
{% endtabs %}
|
|
|
|
### Run Manually
|
|
|
|
```bash
|
|
metadata ingest -c ./pipelines/mysql.json
|
|
```
|
|
|
|
### Configuration
|
|
|
|
{% code title="mysql.json" %}
|
|
```javascript
|
|
{
|
|
"source": {
|
|
"type": "mysql",
|
|
"config": {
|
|
"username": "openmetadata_user",
|
|
"password": "openmetadata_password",
|
|
"database": "openmetadata_db",
|
|
"service_name": "local_mysql",
|
|
"filter_pattern": {
|
|
"excludes": ["mysql.*", "information_schema.*", "performance_schema.*", "sys.*"]
|
|
}
|
|
}
|
|
},
|
|
...
|
|
```
|
|
{% endcode %}
|
|
|
|
1. **username** - pass the MySQL username. We recommend creating a user with read-only permissions to all the databases in your MySQL installation
|
|
2. **password** - password for the username
|
|
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. **filter\_pattern** - It contains includes, excludes options to choose which pattern of datasets you want to ingest into OpenMetadata
|
|
|
|
## Publish to OpenMetadata
|
|
|
|
Below is the configuration to publish MySQL data into the OpenMetadata service.
|
|
|
|
Add optionally `pii` processor and `metadata-rest-tables` sink along with `metadata-server` config
|
|
|
|
{% code title="mysql.json" %}
|
|
```javascript
|
|
{
|
|
"source": {
|
|
"type": "mysql",
|
|
"config": {
|
|
"username": "openmetadata_user",
|
|
"password": "openmetadata_password",
|
|
"database": "openmetadata_db",
|
|
"service_name": "local_mysql",
|
|
"filter_pattern": {
|
|
"excludes": ["mysql.*", "information_schema.*", "performance_schema.*", "sys.*"]
|
|
}
|
|
}
|
|
},
|
|
"sink": {
|
|
"type": "metadata-rest",
|
|
"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 %}
|
|
|