mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-11-02 11:39:12 +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.2 KiB
2.2 KiB
| description |
|---|
| This guide will help install Salesforce connector and run manually |
Salesforce
{% 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[salesforce]'
{% endtab %} {% endtabs %}
Run Manually
metadata ingest -c ./examples/workflows/salesforce.json
Configuration
{% code title="salesforce.json" %}
{
"source": {
"type": "salesforce",
"config": {
"username": "username",
"password": "password",
"security_token": "secuirty_token",
"service_name": "local_salesforce",
"scheme": "salesforce",
"sobject_name": "Salesforce Object Name"
}
},
...
{% endcode %}
- username - pass the Salesforce username.
- password - password for the username.
- security_token - pass the security token.
- sobject_name - pass the salesforce object name.
- service_name - Service Name for this Salesforce cluster. If you added Salesforce 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.
Publish to OpenMetadata
Below is the configuration to publish Salesforce data into the OpenMetadata service.
Add metadata-rest sink along with metadata-server config
{% code title="salesforce.json" %}
{
"source": {
"type": "salesforce",
"config": {
"username": "username",
"password": "password",
"security_token": "secuirty_token",
"service_name": "local_salesforce",
"scheme": "salesforce",
"sobject_name": "Salesforce Object Name"
}
},
"sink": {
"type": "metadata-rest",
"config": {}
},
"metadata_server": {
"type": "metadata-server",
"config": {
"api_endpoint": "http://localhost:8585/api",
"auth_provider_type": "no-auth"
}
}
}
{% endcode %}