From c68bb3c06a7f71fe54af3e2f7976b8cdb02dbf72 Mon Sep 17 00:00:00 2001 From: RounakDhillon <162090200+RounakDhillon@users.noreply.github.com> Date: Fri, 17 Jan 2025 10:07:23 +0530 Subject: [PATCH] Docs: Database YAML correction (#19412) --- .../v1.6/connectors/yaml/database/source-config-def.md | 4 ++++ .../partials/v1.6/connectors/yaml/database/source-config.md | 4 +++- .../v1.7/connectors/yaml/database/source-config-def.md | 4 ++++ .../partials/v1.7/connectors/yaml/database/source-config.md | 4 +++- 4 files changed, 14 insertions(+), 2 deletions(-) diff --git a/openmetadata-docs/content/partials/v1.6/connectors/yaml/database/source-config-def.md b/openmetadata-docs/content/partials/v1.6/connectors/yaml/database/source-config-def.md index 8655dab614f..c3a1011a4d4 100644 --- a/openmetadata-docs/content/partials/v1.6/connectors/yaml/database/source-config-def.md +++ b/openmetadata-docs/content/partials/v1.6/connectors/yaml/database/source-config-def.md @@ -20,6 +20,8 @@ The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetada **includeDDL**: Optional configuration to toggle the DDL Statements ingestion. +**overrideMetadata** *(boolean)*: Set the 'Override Metadata' toggle to control whether to override the existing metadata in the OpenMetadata server with the metadata fetched from the source. If the toggle is set to true, the metadata fetched from the source will override the existing metadata in the OpenMetadata server. If the toggle is set to false, the metadata fetched from the source will not override the existing metadata in the OpenMetadata server. This is applicable for fields like description, tags, owner and displayName. + **queryLogDuration**: Configuration to tune how far we want to look back in query logs to process Stored Procedures results. **queryParsingTimeoutLimit**: Configuration to set the timeout for parsing the query in seconds. @@ -30,6 +32,8 @@ The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetada **threads (beta)**: The number of threads to use when extracting the metadata using multithreading. Please take a look [here](/connectors/ingestion/workflows/metadata/multithreading) before configuring this. +**databaseMetadataConfigType** *(string)*: Database Source Config Metadata Pipeline type. + **incremental (beta)**: Incremental Extraction configuration. Currently implemented for: - [BigQuery](/connectors/ingestion/workflows/metadata/incremental-extraction/bigquery) diff --git a/openmetadata-docs/content/partials/v1.6/connectors/yaml/database/source-config.md b/openmetadata-docs/content/partials/v1.6/connectors/yaml/database/source-config.md index 5fced7a76e7..69a72752f5c 100644 --- a/openmetadata-docs/content/partials/v1.6/connectors/yaml/database/source-config.md +++ b/openmetadata-docs/content/partials/v1.6/connectors/yaml/database/source-config.md @@ -10,10 +10,12 @@ # includeOwners: false # includeStoredProcedures: true # includeDDL: true + # overrideMetadata: false # queryLogDuration: 1 # queryParsingTimeoutLimit: 300 # useFqnForFiltering: false - # threads: 4 + # threads: 1 + # databaseMetadataConfigType: () # incremental: # enabled: true # lookbackDays: 7 diff --git a/openmetadata-docs/content/partials/v1.7/connectors/yaml/database/source-config-def.md b/openmetadata-docs/content/partials/v1.7/connectors/yaml/database/source-config-def.md index 8655dab614f..c3a1011a4d4 100644 --- a/openmetadata-docs/content/partials/v1.7/connectors/yaml/database/source-config-def.md +++ b/openmetadata-docs/content/partials/v1.7/connectors/yaml/database/source-config-def.md @@ -20,6 +20,8 @@ The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetada **includeDDL**: Optional configuration to toggle the DDL Statements ingestion. +**overrideMetadata** *(boolean)*: Set the 'Override Metadata' toggle to control whether to override the existing metadata in the OpenMetadata server with the metadata fetched from the source. If the toggle is set to true, the metadata fetched from the source will override the existing metadata in the OpenMetadata server. If the toggle is set to false, the metadata fetched from the source will not override the existing metadata in the OpenMetadata server. This is applicable for fields like description, tags, owner and displayName. + **queryLogDuration**: Configuration to tune how far we want to look back in query logs to process Stored Procedures results. **queryParsingTimeoutLimit**: Configuration to set the timeout for parsing the query in seconds. @@ -30,6 +32,8 @@ The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetada **threads (beta)**: The number of threads to use when extracting the metadata using multithreading. Please take a look [here](/connectors/ingestion/workflows/metadata/multithreading) before configuring this. +**databaseMetadataConfigType** *(string)*: Database Source Config Metadata Pipeline type. + **incremental (beta)**: Incremental Extraction configuration. Currently implemented for: - [BigQuery](/connectors/ingestion/workflows/metadata/incremental-extraction/bigquery) diff --git a/openmetadata-docs/content/partials/v1.7/connectors/yaml/database/source-config.md b/openmetadata-docs/content/partials/v1.7/connectors/yaml/database/source-config.md index 5fced7a76e7..69a72752f5c 100644 --- a/openmetadata-docs/content/partials/v1.7/connectors/yaml/database/source-config.md +++ b/openmetadata-docs/content/partials/v1.7/connectors/yaml/database/source-config.md @@ -10,10 +10,12 @@ # includeOwners: false # includeStoredProcedures: true # includeDDL: true + # overrideMetadata: false # queryLogDuration: 1 # queryParsingTimeoutLimit: 300 # useFqnForFiltering: false - # threads: 4 + # threads: 1 + # databaseMetadataConfigType: () # incremental: # enabled: true # lookbackDays: 7