diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 02e1e4ee9ac..d84954198ee 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -74,7 +74,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/database-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) @@ -87,11 +86,12 @@ * [Oracle](install/metadata-ingestion/connectors/database-services/oracle.md) * [Postgres](install/metadata-ingestion/connectors/database-services/postgres.md) * [Presto](install/metadata-ingestion/connectors/database-services/presto.md) - * [Trino](install/metadata-ingestion/connectors/database-services/trino.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) + * [Trino](install/metadata-ingestion/connectors/database-services/trino.md) + * [Vertica](install/metadata-ingestion/connectors/database-services/vertica.md) * [Messaging Services](install/metadata-ingestion/connectors/messaging-services/README.md) * [Kafka](install/metadata-ingestion/connectors/messaging-services/kafka.md) * [Scheduler](install/metadata-ingestion/scheduler.md) diff --git a/docs/install/metadata-ingestion/connectors/dashboard-services/README.md b/docs/install/metadata-ingestion/connectors/dashboard-services/README.md index 6197dbdf2be..b89643fe8ae 100644 --- a/docs/install/metadata-ingestion/connectors/dashboard-services/README.md +++ b/docs/install/metadata-ingestion/connectors/dashboard-services/README.md @@ -4,8 +4,6 @@ OpenMetadata supports connectors to some popular dashboard services. We will con {% page-ref page="looker.md" %} -{% page-ref page="salesforce.md" %} - {% page-ref page="superset.md" %} {% page-ref page="tableau.md" %} diff --git a/docs/install/metadata-ingestion/connectors/dashboard-services/looker.md b/docs/install/metadata-ingestion/connectors/dashboard-services/looker.md index 19e8b1c10e0..0ab5c7eb156 100644 --- a/docs/install/metadata-ingestion/connectors/dashboard-services/looker.md +++ b/docs/install/metadata-ingestion/connectors/dashboard-services/looker.md @@ -10,6 +10,7 @@ description: This guide will help install Looker connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source @@ -61,7 +62,6 @@ Add Optionally`pii` processor and `metadata-rest-tables` sink along with `metada {% code title="looker.json" %} ```javascript { - { "source": { "type": "looker", "config": { diff --git a/docs/install/metadata-ingestion/connectors/dashboard-services/superset.md b/docs/install/metadata-ingestion/connectors/dashboard-services/superset.md index 96ab2c7842c..8abc4f60ec2 100644 --- a/docs/install/metadata-ingestion/connectors/dashboard-services/superset.md +++ b/docs/install/metadata-ingestion/connectors/dashboard-services/superset.md @@ -10,6 +10,7 @@ description: This guide will help install Superset connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/dashboard-services/tableau.md b/docs/install/metadata-ingestion/connectors/dashboard-services/tableau.md index fa6c7a7000c..a620f940cf0 100644 --- a/docs/install/metadata-ingestion/connectors/dashboard-services/tableau.md +++ b/docs/install/metadata-ingestion/connectors/dashboard-services/tableau.md @@ -10,6 +10,7 @@ description: This guide will help install Tableau connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/README.md b/docs/install/metadata-ingestion/connectors/database-services/README.md index 98f832ba3b9..21bdf5d6943 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/README.md +++ b/docs/install/metadata-ingestion/connectors/database-services/README.md @@ -8,6 +8,8 @@ OpenMetadata supports connectors to some popular data sources. We will continue {% page-ref page="elastic-search.md" %} +{% page-ref page="hive.md" %} + {% page-ref page="mssql.md" %} {% page-ref page="mysql.md" %} @@ -16,13 +18,17 @@ OpenMetadata supports connectors to some popular data sources. We will continue {% page-ref page="postgres.md" %} -{% page-ref page="redshift.md" %} - {% page-ref page="redshift-usage.md" %} +{% page-ref page="salesforce.md" %} + {% page-ref page="snowflake.md" %} {% page-ref page="snowflake-usage.md" %} +{% page-ref page="trino.md" %} + +{% page-ref page="vertica.md" %} + diff --git a/docs/install/metadata-ingestion/connectors/database-services/athena.md b/docs/install/metadata-ingestion/connectors/database-services/athena.md index 686bcdf198f..ae40907e71f 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/athena.md +++ b/docs/install/metadata-ingestion/connectors/database-services/athena.md @@ -10,6 +10,7 @@ description: This guide will help install Athena connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/bigquery.md b/docs/install/metadata-ingestion/connectors/database-services/bigquery.md index a3a695ee517..275c55f0d5e 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/bigquery.md +++ b/docs/install/metadata-ingestion/connectors/database-services/bigquery.md @@ -10,6 +10,7 @@ description: This guide will help install BigQuery connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/elastic-search.md b/docs/install/metadata-ingestion/connectors/database-services/elastic-search.md index ed00435c5de..fae649401d4 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/elastic-search.md +++ b/docs/install/metadata-ingestion/connectors/database-services/elastic-search.md @@ -12,6 +12,7 @@ description: >- OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/hive.md b/docs/install/metadata-ingestion/connectors/database-services/hive.md index 4a137b3d878..46840b7c292 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/hive.md +++ b/docs/install/metadata-ingestion/connectors/database-services/hive.md @@ -9,6 +9,7 @@ description: This guide will help install Hive connector and run manually 1. Python 3.7 or above 2. Library: **libsasl2-dev** Hive connector uses `pyhive` to connect and fetch metadata. Pyhive has python sasl dependency and which requires libsasl2-dev to be installed. In some cases, you may need to set LD\_LIBRARY\_PATH to point to where libsasl2-dev is installed. Please check on how to install libsasl2 for your Linux Distro. +3. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source @@ -78,7 +79,6 @@ Add optionally `pii` processor and `metadata-rest-tables` sink along with `metad } } - ``` {% endcode %} diff --git a/docs/install/metadata-ingestion/connectors/database-services/mssql.md b/docs/install/metadata-ingestion/connectors/database-services/mssql.md index 11d93f06580..487e1187b32 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/mssql.md +++ b/docs/install/metadata-ingestion/connectors/database-services/mssql.md @@ -10,6 +10,7 @@ description: This guide will help install MsSQL connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/mysql.md b/docs/install/metadata-ingestion/connectors/database-services/mysql.md index 01f0d27ae35..eeeb654418a 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/mysql.md +++ b/docs/install/metadata-ingestion/connectors/database-services/mysql.md @@ -10,6 +10,7 @@ description: This guide will help install MySQL connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/oracle.md b/docs/install/metadata-ingestion/connectors/database-services/oracle.md index a36f3bb5b30..5d6f65aaf1b 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/oracle.md +++ b/docs/install/metadata-ingestion/connectors/database-services/oracle.md @@ -10,6 +10,7 @@ description: This guide will help install Oracle connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/postgres.md b/docs/install/metadata-ingestion/connectors/database-services/postgres.md index 85dd5f771f3..d79089bf881 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/postgres.md +++ b/docs/install/metadata-ingestion/connectors/database-services/postgres.md @@ -10,6 +10,7 @@ description: This guide will help install Postgres connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/redshift-usage.md b/docs/install/metadata-ingestion/connectors/database-services/redshift-usage.md index 1b3a468c52c..08cad7e528c 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/redshift-usage.md +++ b/docs/install/metadata-ingestion/connectors/database-services/redshift-usage.md @@ -10,6 +10,7 @@ description: This guide will help install Redshift Usage connector and run manua OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/salesforce.md b/docs/install/metadata-ingestion/connectors/database-services/salesforce.md index ea5e685b95a..cdc3628c779 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/salesforce.md +++ b/docs/install/metadata-ingestion/connectors/database-services/salesforce.md @@ -10,6 +10,7 @@ description: This guide will help install Salesforce connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/snowflake-usage.md b/docs/install/metadata-ingestion/connectors/database-services/snowflake-usage.md index ba2ea85be27..2a7bc39af68 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/snowflake-usage.md +++ b/docs/install/metadata-ingestion/connectors/database-services/snowflake-usage.md @@ -10,6 +10,7 @@ description: This guide will help install Snowflake Usage connector and run manu OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/snowflake.md b/docs/install/metadata-ingestion/connectors/database-services/snowflake.md index ce651115266..0aafbd4d0fe 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/snowflake.md +++ b/docs/install/metadata-ingestion/connectors/database-services/snowflake.md @@ -10,6 +10,7 @@ description: This guide will help install Snowflake connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/install/metadata-ingestion/connectors/database-services/trino.md b/docs/install/metadata-ingestion/connectors/database-services/trino.md index a20221dd4d5..e33b1d3e775 100644 --- a/docs/install/metadata-ingestion/connectors/database-services/trino.md +++ b/docs/install/metadata-ingestion/connectors/database-services/trino.md @@ -34,12 +34,13 @@ metadata ingest -c ./examples/workflows/trino.json {% code title="trino.json" %} ```javascript +{ "source": { "type": "trino", "config": { "service_name": "local_trino", - "host_port": "192.168.1.32:8080", - "database": "default" + "host_port": "localhost:8080", + "catalog": "system" } }, ... ``` @@ -63,11 +64,11 @@ add `metadata-rest-tables` sink along with `metadata-server` config ```javascript { "source": { - "type": "Trino", + "type": "trino", "config": { "service_name": "local_trino", - "host_port": "192.168.1.32:8080", - "database": "default" + "host_port": "localhost:8080", + "catalog": "system" } }, "sink": { diff --git a/docs/install/metadata-ingestion/connectors/database-services/vertica.md b/docs/install/metadata-ingestion/connectors/database-services/vertica.md new file mode 100644 index 00000000000..464e08002bf --- /dev/null +++ b/docs/install/metadata-ingestion/connectors/database-services/vertica.md @@ -0,0 +1,100 @@ +--- +description: This guide will help install Vertica Usage connector and run manually +--- + +# Vertica Usage + +{% hint style="info" %} +**Prerequisites** + +OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. + +1. Python 3.7 or above +2. OpenMetadata Server up and running +{% endhint %} + +### Install from PyPI or Source + +{% tabs %} +{% tab title="Install Using PyPI" %} +```bash +pip install 'openmetadata-ingestion[vertica]' +``` +{% endtab %} +{% endtabs %} + +## Run Manually + +```bash +metadata ingest -c ./examples/workflows/vertica.json +``` + +### Configuration + +{% code title="vertica.json" %} +```javascript +{ + "source": { + "type": "vertica", + "config": { + "username": "openmetadata_user", + "password": "openmetadata_password", + "database": "openmetadata_db", + "service_name": "local_vertica", + "filter_pattern": { + "excludes": [] + } + } + }, +``` +{% endcode %} + +1. **username** - pass the Vertica username. +2. **password** - the password for the Vertica username. +3. **service\_name** - Service Name for this Vertica cluster. If you added the Vertica 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. +5. **database -** Database name from where data is to be fetched. + +### Publish to OpenMetadata + +Below is the configuration to publish Vertica Usage data into the OpenMetadata service. + +Add Optionally `query-parser` processor, `table-usage` stage and`metadata-usage` bulk\_sink along with `metadata-server` config + +{% code title="vertica.json" %} +```javascript +{ + "source": { + "type": "vertica", + "config": { + "username": "openmetadata_user", + "password": "openmetadata_password", + "database": "openmetadata_db", + "service_name": "local_vertica", + "filter_pattern": { + "excludes": [] + } + } + }, + "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 %} diff --git a/docs/install/metadata-ingestion/connectors/messaging-services/kafka.md b/docs/install/metadata-ingestion/connectors/messaging-services/kafka.md index b0c6ea2ba46..d0ed35da6da 100644 --- a/docs/install/metadata-ingestion/connectors/messaging-services/kafka.md +++ b/docs/install/metadata-ingestion/connectors/messaging-services/kafka.md @@ -10,6 +10,7 @@ description: This guide will help install Kafka connector and run manually OpenMetadata is built using Java, DropWizard, Jetty, and MySQL. 1. Python 3.7 or above +2. OpenMetadata Server up and running {% endhint %} ### Install from PyPI or Source diff --git a/docs/openmetadata-apis/schemas/entities/bot.md b/docs/openmetadata-apis/schemas/entities/bot.md index a4cc1c05b6a..d7ac24a3a54 100644 --- a/docs/openmetadata-apis/schemas/entities/bot.md +++ b/docs/openmetadata-apis/schemas/entities/bot.md @@ -24,4 +24,4 @@ Type: `object` - Link to the resource corresponding to this bot. - $ref: [../type/basic.json#/definitions/href](../types/basic.md#href) -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/chart.md b/docs/openmetadata-apis/schemas/entities/chart.md index 744b27f5390..2b9c397074a 100644 --- a/docs/openmetadata-apis/schemas/entities/chart.md +++ b/docs/openmetadata-apis/schemas/entities/chart.md @@ -74,4 +74,4 @@ Type: `object` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/dashboard.md b/docs/openmetadata-apis/schemas/entities/dashboard.md index 4eb5fa8873d..fb5e9a001eb 100644 --- a/docs/openmetadata-apis/schemas/entities/dashboard.md +++ b/docs/openmetadata-apis/schemas/entities/dashboard.md @@ -54,4 +54,4 @@ Type: `object` - Latest usage information for this database. - $ref: [../../type/usageDetails.json](../types/usagedetails.md) -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/dashboardservice.md b/docs/openmetadata-apis/schemas/entities/dashboardservice.md index 1a44668fe0f..7bc4e6b11e2 100644 --- a/docs/openmetadata-apis/schemas/entities/dashboardservice.md +++ b/docs/openmetadata-apis/schemas/entities/dashboardservice.md @@ -14,6 +14,9 @@ Type: `object` - Name that identifies this dashboard service. - Type: `string` - Length: between 1 and 64 + - **displayName** + - Display Name that identifies this dashboard service. + - Type: `string` - **serviceType** `required` - Type of dashboard service such as Looker or Superset... - $ref: [#/definitions/dashboardServiceType](#dashboardservicetype) @@ -51,4 +54,4 @@ Type: `object` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/database.md b/docs/openmetadata-apis/schemas/entities/database.md index 9b7d5b0d79d..53752278d67 100644 --- a/docs/openmetadata-apis/schemas/entities/database.md +++ b/docs/openmetadata-apis/schemas/entities/database.md @@ -16,6 +16,9 @@ Type: `object` - **fullyQualifiedName** - Name that uniquely identifies a database in the format 'ServiceName.DatabaseName'. - Type: `string` + - **displayName** + - Display Name that identifies this database. + - Type: `string` - **description** - Description of the database instance. - Type: `string` @@ -46,4 +49,4 @@ Type: `object` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/databaseservice.md b/docs/openmetadata-apis/schemas/entities/databaseservice.md index 76ba86c6c0a..33b6684a872 100644 --- a/docs/openmetadata-apis/schemas/entities/databaseservice.md +++ b/docs/openmetadata-apis/schemas/entities/databaseservice.md @@ -14,6 +14,9 @@ Type: `object` - Name that identifies this database service. - Type: `string` - Length: between 1 and 64 + - **displayName** + - Display Name that identifies this database service. + - Type: `string` - **serviceType** `required` - Type of database service such as MySQL, BigQuery, Snowflake, Redshift, Postgres... - $ref: [#/definitions/databaseServiceType](#databaseservicetype) @@ -50,4 +53,4 @@ Type: `object` 11. _"Trino"_ 12. _"Vertica"_ -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/messagingservice.md b/docs/openmetadata-apis/schemas/entities/messagingservice.md index 48ee168e2a8..f1090d07c42 100644 --- a/docs/openmetadata-apis/schemas/entities/messagingservice.md +++ b/docs/openmetadata-apis/schemas/entities/messagingservice.md @@ -20,6 +20,9 @@ Type: `object` - **description** - Description of a messaging service instance. - Type: `string` + - **displayName** + - Display Name that identifies this messaging service. It could be title or label from the source services. + - Type: `string` - **brokers** `required` - Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar. - $ref: [#/definitions/brokers](#brokers) @@ -52,6 +55,4 @@ Type: `object` - **Items** - Type: `string` - - -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/metrics.md b/docs/openmetadata-apis/schemas/entities/metrics.md index 4c80e5629dd..1ccf23df09c 100644 --- a/docs/openmetadata-apis/schemas/entities/metrics.md +++ b/docs/openmetadata-apis/schemas/entities/metrics.md @@ -18,6 +18,9 @@ Type: `object` - A unique name that identifies a metric in the format 'ServiceName.MetricName'. - Type: `string` - Length: between 1 and 64 + - **displayName** + - Display Name that identifies this metric. + - Type: `string` - **description** - Description of metrics instance, what it is, and how to use it. - Type: `string` @@ -34,4 +37,4 @@ Type: `object` - Latest usage information for this database. - $ref: [../../type/usageDetails.json](../types/usagedetails.md) -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/model.md b/docs/openmetadata-apis/schemas/entities/model.md index 42970df3157..5af5c84c069 100644 --- a/docs/openmetadata-apis/schemas/entities/model.md +++ b/docs/openmetadata-apis/schemas/entities/model.md @@ -49,4 +49,4 @@ Type: `object` - $ref: [../../type/usageDetails.json](../types/usagedetails.md) -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/pipeline.md b/docs/openmetadata-apis/schemas/entities/pipeline.md index a1c777bb7ae..59acdc23075 100644 --- a/docs/openmetadata-apis/schemas/entities/pipeline.md +++ b/docs/openmetadata-apis/schemas/entities/pipeline.md @@ -60,4 +60,4 @@ Type: `object` - Link to service where this pipeline is hosted in. - $ref: [../../type/entityReference.json](../types/entityreference.md) -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/pipelineservice.md b/docs/openmetadata-apis/schemas/entities/pipelineservice.md index b4f830e21f8..19fb2281563 100644 --- a/docs/openmetadata-apis/schemas/entities/pipelineservice.md +++ b/docs/openmetadata-apis/schemas/entities/pipelineservice.md @@ -20,6 +20,9 @@ Type: `object` - **description** - Description of a pipeline service instance. - Type: `string` + - **displayName** + - Display Name that identifies this pipeline service. It could be title or label from the source services. + - Type: `string` - **pipelineUrl** `required` - Pipeline Service Management/UI URL. - Type: `string` @@ -42,4 +45,4 @@ Type: `object` 2. _"Prefect"_ -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/report.md b/docs/openmetadata-apis/schemas/entities/report.md index d67d8b97e0d..08afaa631c6 100644 --- a/docs/openmetadata-apis/schemas/entities/report.md +++ b/docs/openmetadata-apis/schemas/entities/report.md @@ -18,6 +18,9 @@ Type: `object` - A unique name that identifies a report in the format 'ServiceName.ReportName'. - Type: `string` - Length: between 1 and 64 + - **displayName** + - Display Name that identifies this report. It could be title or label from the source services. + - Type: `string` - **description** - Description of this report instance. - Type: `string` @@ -34,4 +37,4 @@ Type: `object` - Latest usage information for this database. - $ref: [../../type/usageDetails.json](../types/usagedetails.md) -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/table.md b/docs/openmetadata-apis/schemas/entities/table.md index 7890a4460f7..8e3c9126116 100644 --- a/docs/openmetadata-apis/schemas/entities/table.md +++ b/docs/openmetadata-apis/schemas/entities/table.md @@ -13,6 +13,9 @@ Type: `object` - **name** `required` - Name of a table. Expected to be unique within a database. - $ref: [#/definitions/tableName](#tablename) + - **displayName** + - Display Name that identifies this table. It could be title or label from the source services. + - Type: `string` - **description** - Description of a table. - Type: `string` @@ -337,4 +340,4 @@ Type: `object` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/tagcategory.md b/docs/openmetadata-apis/schemas/entities/tagcategory.md index 059b2427d00..d766ae33637 100644 --- a/docs/openmetadata-apis/schemas/entities/tagcategory.md +++ b/docs/openmetadata-apis/schemas/entities/tagcategory.md @@ -11,6 +11,9 @@ This schema does not accept additional properties. ## Properties - **name** `required` - $ref: [#/definitions/tagName](#tagname) + - **displayName** + - Display Name that identifies this tag category. + - Type: `string` - **description** `required` - Description of the tag category. - Type: `string` @@ -49,4 +52,4 @@ This schema does not accept additional properties. ### tag -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/task.md b/docs/openmetadata-apis/schemas/entities/task.md index 545ce0d1450..5f0a8521b68 100644 --- a/docs/openmetadata-apis/schemas/entities/task.md +++ b/docs/openmetadata-apis/schemas/entities/task.md @@ -62,4 +62,4 @@ Type: `object` - $ref: [../../type/entityReference.json](../types/entityreference.md) -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/team.md b/docs/openmetadata-apis/schemas/entities/team.md index cafe80dba40..97394aeb8c4 100644 --- a/docs/openmetadata-apis/schemas/entities/team.md +++ b/docs/openmetadata-apis/schemas/entities/team.md @@ -43,4 +43,4 @@ Type: `object` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/thread.md b/docs/openmetadata-apis/schemas/entities/thread.md index 7c04f764aa7..73210dd1eea 100644 --- a/docs/openmetadata-apis/schemas/entities/thread.md +++ b/docs/openmetadata-apis/schemas/entities/thread.md @@ -47,4 +47,4 @@ Type: `object` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/topic.md b/docs/openmetadata-apis/schemas/entities/topic.md index c94065de494..2e5fa3b9080 100644 --- a/docs/openmetadata-apis/schemas/entities/topic.md +++ b/docs/openmetadata-apis/schemas/entities/topic.md @@ -16,6 +16,9 @@ Type: `object` - **fullyQualifiedName** - Name that uniquely identifies a topic in the format 'messagingServiceName.topicName'. - Type: `string` + - **displayName** + - Display Name that identifies this topic. It could be title or label from the source services. + - Type: `string` - **description** - Description of the topic instance. - Type: `string` @@ -97,4 +100,4 @@ Type: `object` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/entities/user.md b/docs/openmetadata-apis/schemas/entities/user.md index c37a343ebc0..0ae347671fd 100644 --- a/docs/openmetadata-apis/schemas/entities/user.md +++ b/docs/openmetadata-apis/schemas/entities/user.md @@ -58,5 +58,4 @@ This schema does not accept additional properties. - Length: between 1 and 64 - -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/auditlog.md b/docs/openmetadata-apis/schemas/types/auditlog.md index 247227d9b17..7e82690448a 100644 --- a/docs/openmetadata-apis/schemas/types/auditlog.md +++ b/docs/openmetadata-apis/schemas/types/auditlog.md @@ -34,4 +34,4 @@ Type: `object` - Type of Entity that is modified by the operation. - Type: `string` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/basic.md b/docs/openmetadata-apis/schemas/types/basic.md index 9f462aa849c..a52cf77cb5f 100644 --- a/docs/openmetadata-apis/schemas/types/basic.md +++ b/docs/openmetadata-apis/schemas/types/basic.md @@ -84,4 +84,4 @@ This schema defines basic common types that are used by other schemas. -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/dailycount.md b/docs/openmetadata-apis/schemas/types/dailycount.md index e898e7d30a6..1068301816d 100644 --- a/docs/openmetadata-apis/schemas/types/dailycount.md +++ b/docs/openmetadata-apis/schemas/types/dailycount.md @@ -16,4 +16,4 @@ This schema does not accept additional properties. - **date** `required` - $ref: [basic.json#/definitions/date](basic.md#date) -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/entitylineage.md b/docs/openmetadata-apis/schemas/types/entitylineage.md index ced509d6600..f53552df9c8 100644 --- a/docs/openmetadata-apis/schemas/types/entitylineage.md +++ b/docs/openmetadata-apis/schemas/types/entitylineage.md @@ -57,4 +57,4 @@ This schema does not accept additional properties. - Type: `string` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/entityreference.md b/docs/openmetadata-apis/schemas/types/entityreference.md index 4d4ff974182..a90b8258a67 100644 --- a/docs/openmetadata-apis/schemas/types/entityreference.md +++ b/docs/openmetadata-apis/schemas/types/entityreference.md @@ -21,6 +21,9 @@ This schema does not accept additional properties. - **description** - Optional description of entity. - Type: `string` + - **displayName** + - Display Name that identifies this entity. + - Type: `string` - **href** - Link to the entity resource. - $ref: [basic.json#/definitions/href](basic.md#href) @@ -35,4 +38,4 @@ This schema does not accept additional properties. -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/entityusage.md b/docs/openmetadata-apis/schemas/types/entityusage.md index b0fd3d0ce6f..f1df27c45bb 100644 --- a/docs/openmetadata-apis/schemas/types/entityusage.md +++ b/docs/openmetadata-apis/schemas/types/entityusage.md @@ -16,4 +16,4 @@ Type: `object` - **Items** - $ref: [usageDetails.json](usagedetails.md) -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/jdbcconnection.md b/docs/openmetadata-apis/schemas/types/jdbcconnection.md index 164343751cc..99d64200ec0 100644 --- a/docs/openmetadata-apis/schemas/types/jdbcconnection.md +++ b/docs/openmetadata-apis/schemas/types/jdbcconnection.md @@ -46,4 +46,4 @@ Type: `object` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/paging.md b/docs/openmetadata-apis/schemas/types/paging.md index 4b07b1c50de..f446f85b81b 100644 --- a/docs/openmetadata-apis/schemas/types/paging.md +++ b/docs/openmetadata-apis/schemas/types/paging.md @@ -17,4 +17,4 @@ Type: `object` - Total number of entries available to page through. - Type: `integer` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/profile.md b/docs/openmetadata-apis/schemas/types/profile.md index 2cb52d4cd69..7f4d2b2aabc 100644 --- a/docs/openmetadata-apis/schemas/types/profile.md +++ b/docs/openmetadata-apis/schemas/types/profile.md @@ -41,4 +41,4 @@ Type: `object` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/schedule.md b/docs/openmetadata-apis/schemas/types/schedule.md index f15350922ff..5968b19e715 100644 --- a/docs/openmetadata-apis/schemas/types/schedule.md +++ b/docs/openmetadata-apis/schemas/types/schedule.md @@ -14,4 +14,4 @@ Type: `object` - Repeat frequency in ISO 8601 duration format. Example - 'P23DT23H'. - $ref: [basic.json#/definitions/duration](basic.md#duration) -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/taglabel.md b/docs/openmetadata-apis/schemas/types/taglabel.md index 31a09a4d155..541ac671c64 100644 --- a/docs/openmetadata-apis/schemas/types/taglabel.md +++ b/docs/openmetadata-apis/schemas/types/taglabel.md @@ -32,4 +32,4 @@ This schema does not accept additional properties. - Link to the tag resource. - $ref: [basic.json#/definitions/href](basic.md#href) -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file diff --git a/docs/openmetadata-apis/schemas/types/usagedetails.md b/docs/openmetadata-apis/schemas/types/usagedetails.md index bd00d381c48..e3d9648478b 100644 --- a/docs/openmetadata-apis/schemas/types/usagedetails.md +++ b/docs/openmetadata-apis/schemas/types/usagedetails.md @@ -39,4 +39,4 @@ Type: `object` -_This document was updated on: Tuesday, October 12, 2021_ \ No newline at end of file +_This document was updated on: Thursday, October 14, 2021_ \ No newline at end of file