mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-23 09:22:18 +00:00

* remove spaCy dependencies from setup.py * Spacy, PII and Processor dependencies removed Co-authored-by: Ayush Shah <ayush@getcollate.io>
2.6 KiB
2.6 KiB
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.
- Python 3.7 or above {% endhint %}
Install from PyPI
{% tabs %} {% tab title="Install Using PyPI" %}
pip install 'openmetadata-ingestion[mysql]'
{% endtab %} {% endtabs %}
Run Manually
metadata ingest -c ./examples/workflows/mysql.json
Configuration
{% code title="mysql.json" %}
{
"source": {
"type": "mysql",
"config": {
"username": "openmetadata_user",
"password": "openmetadata_password",
"database": "openmetadata_db",
"service_name": "local_mysql",
"data_profiler_enabled": "true",
"data_profiler_offset": "0",
"data_profiler_limit": "50000",
"filter_pattern": {
"excludes": ["mysql.*", "information_schema.*", "performance_schema.*", "sys.*"]
}
}
},
...
{% endcode %}
- username - pass the MySQL username. We recommend creating a user with read-only permissions to all the databases in your MySQL installation
- password - password for the username
- service_name - Service Name for this MySQL cluster. If you added MySQL cluster through OpenMetadata UI, make sure the service name matches the same.
- filter_pattern - It contains includes, excludes options to choose which pattern of datasets you want to ingest into OpenMetadata
- data_profiler_enabled - Enable data-profiling (Optional). It will provide you the newly ingested data.
- data_profiler_offset - Specify offset.
- data_profiler_limit - Specify limit.
Publish to OpenMetadata
Below is the configuration to publish MySQL data into the OpenMetadata service.
Add metadata-rest
sink along with metadata-server
config
{% code title="mysql.json" %}
{
"source": {
"type": "mysql",
"config": {
"username": "openmetadata_user",
"password": "openmetadata_password",
"database": "openmetadata_db",
"service_name": "local_mysql",
"data_profiler_enabled": "true",
"data_profiler_offset": "0",
"data_profiler_limit": "50000",
"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"
}
}
}
{% endcode %}