yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-11-25 15:17:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [0.4.0] 98 pages modified

Browse Source
This commit is contained in:
OpenMetadata 2021-09-20 02:01:55 +00:00 committed by gitbook-bot
parent a77b3fd7ee
commit 9199f0e0c3
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
5 changed files with 102 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/SUMMARY.md
View File

@ -69,7 +69,6 @@
* [Connectors](install/metadata-ingestion/connectors/README.md)
* [Dashboard Services](install/metadata-ingestion/connectors/dashboard-services/README.md)
* [Looker](install/metadata-ingestion/connectors/dashboard-services/looker.md)
* [Salesforce](install/metadata-ingestion/connectors/dashboard-services/salesforce.md)
* [Superset](install/metadata-ingestion/connectors/dashboard-services/superset.md)
* [Tableau](install/metadata-ingestion/connectors/dashboard-services/tableau.md)
* [Database Services](install/metadata-ingestion/connectors/database-services/README.md)
@ -84,6 +83,7 @@
* [Presto](install/metadata-ingestion/connectors/database-services/presto.md)
* [Redshift](install/metadata-ingestion/connectors/database-services/redshift.md)
* [Redshift Usage](install/metadata-ingestion/connectors/database-services/redshift-usage.md)
* [Salesforce](install/metadata-ingestion/connectors/database-services/salesforce.md)
* [Snowflake](install/metadata-ingestion/connectors/database-services/snowflake.md)
* [Snowflake Usage](install/metadata-ingestion/connectors/database-services/snowflake-usage.md)
* [Messaging Services](install/metadata-ingestion/connectors/messaging-services/README.md)

2
docs/install/metadata-ingestion/connectors/dashboard-services/README.md
View File

@ -4,7 +4,7 @@ OpenMetadata supports connectors to some popular dashboard services. We will con
{% page-ref page="looker.md" %}
{% page-ref page="salesforce.md" %}
{% page-ref page="../database-services/salesforce.md" %}
{% page-ref page="superset.md" %}

99
docs/install/metadata-ingestion/connectors/database-services/salesforce.md Normal file
View File

@ -0,0 +1,99 @@
---
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.
1. Python 3.7 or above
{% endhint %}
### Install from PyPI or Source
{% tabs %}
{% tab title="Install Using PyPI" %}
```bash
pip install 'openmetadata-ingestion[salesforce]'
```
{% endtab %}
{% endtabs %}
### Run Manually
```bash
metadata ingest -c ./pipelines/salesforce.json
```
### Configuration
{% code title="salesforce.json" %}
```javascript
{
"source": {
"type": "salesforce",
"config": {
"username": "username",
"password": "password",
"security_token": "secuirty_token",
"service_name": "local_salesforce",
"scheme": "salesforce",
"sobject_name": "Salesforce Object Name"
}
},
...
```
{% endcode %}
1. **username** - pass the Salesforce username.
2. **password** - password for the username.
3. **security\_token** - pass the security token.
4. **sobject\_name** - pass the salesforce object name.
5. **service\_name** - Service Name for this Salesforce cluster. If you added Salesforce cluster through OpenMetadata UI, make sure the service name matches the same.
6. **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 Salesforce data into the OpenMetadata service.
Add optionally `pii` processor and `metadata-rest-tables` sink along with `metadata-server` config
{% code title="salesforce.json" %}
```javascript
{
"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"
}
},
"cron": {
"minute": "*/5",
"hour": null,
"day": null,
"month": null,
"day_of_week": null
}
}
```
{% endcode %}

1
docs/install/metadata-ingestion/connectors/messaging-services/kafka.md
View File

@ -18,7 +18,6 @@ OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
{% tab title="Install Using PyPI" %}
```bash
pip install 'openmetadata-ingestion[kafka]'
python -m spacy download en_core_web_sm
```
{% endtab %}
{% endtabs %}

8
docs/install/metadata-ingestion/ingest-sample-data.md
View File

@ -21,8 +21,7 @@ OpenMetadata is built using Java, DropWizard, Jetty, and MySQL.
{% tabs %}
{% tab title="Install Using PyPI" %}
```bash
python3 -m pip install 'openmetadata-ingestion[sample-tables, elasticsearch]'
python3 -m spacy download en_core_web_sm
python3 -m pip install 'openmetadata-ingestion[sample-data, elasticsearch]'
git clone https://github.com/open-metadata/OpenMetadata.git
cd OpenMetadata/ingestion
@ -35,11 +34,6 @@ cd OpenMetadata/ingestion
Sample Data, Tables, Usage, Users, Topics, and Dashboards.
```bash
metadata ingest -c ./pipelines/sample_tables.json
metadata ingest -c ./pipelines/sample_usage.json
metadata ingest -c ./pipelines/sample_users.json
metadata ingest -c ./pipelines/sample_topics.json
metadata ingest -c ./pipelines/sample_dashboards.json
metadata ingest -c ./pipelines/sample_data.json
```