mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-28 11:50:02 +00:00
5d6f385a75
* Added Filter Params for table and Schema * Bigquery Doc changes * Doc Changes for databases * Filter Pattern Changes * Table Filter Pattern Example Changes * Filter Pattern Example Changes
2.6 KiB
2.6 KiB
| description |
|---|
| This guide will help install MariaDB connector and run manually |
MariaDB
{% 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/mariadb.json
Configuration
{% code title="mariadb.json" %}
{
"source": {
"type": "mariadb",
"config": {
"username": "openmetadata_user",
"password": "openmetadata_password",
"database": "openmetadata_db",
"service_name": "local_mysql",
"table_filter_pattern": {
"excludes": ["demo.*","orders.*"]
},
"schema_filter_pattern": {
"excludes": ["mysql.*", "information_schema.*", "performance_schema.*", "sys.*"]
}
}
},
...
{% endcode %}
- username - pass the MariaDB username.
- password - password for the username
- service_name - Service Name for this MariaDB cluster. If you added MariaDB cluster through OpenMetadata UI, make sure the service name matches the same.
- table_filter_pattern - It contains includes, excludes options to choose which pattern of tables you want to ingest into OpenMetadata.
- schema_filter_pattern - It contains includes, excludes options to choose which pattern of schemas 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 MariaDB data into the OpenMetadata service.
Add optionally pii processor and metadata-rest sink along with metadata-server config
{% code title="mariadb.json" %}
{
"source": {
"type": "mariadb",
"config": {
"username": "openmetadata_user",
"password": "openmetadata_password",
"database": "openmetadata_db",
"service_name": "local_mysql",
"table_filter_pattern": {
"excludes": ["demo.*","orders.*"]
},
"schema_filter_pattern": {
"excludes": ["information_schema.*"]
}
}
},
"sink": {
"type": "metadata-rest",
"config": {}
},
"metadata_server": {
"type": "metadata-server",
"config": {
"api_endpoint": "http://localhost:8585/api",
"auth_provider_type": "no-auth"
}
}
}
{% endcode %}