match all params in metadata ingestion docs-ui-yaml (#16528)

This commit is contained in:
harshsoni2024 2024-06-05 11:05:24 +05:30 committed by GitHub
parent 29028eabb3
commit b87956cbf0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 58 additions and 8 deletions

View File

@ -10,9 +10,14 @@ Please follow the instructions below
{% stepVisualInfo %} {% stepVisualInfo %}
{% image {% image
src="/images/v1.3/connectors/configure-metadata-ingestion-database.png" src="/images/v1.3/connectors/configure-metadata-ingestion-database-1.png"
alt="Configure Metadata Ingestion" alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page" /%} caption="Configure Metadata Ingestion Page - 1" /%}
{% image
src="/images/v1.3/connectors/configure-metadata-ingestion-database-2.png"
alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page - 2" /%}
{% /stepVisualInfo %} {% /stepVisualInfo %}

View File

@ -10,9 +10,14 @@ Please follow the instructions below
{% stepVisualInfo %} {% stepVisualInfo %}
{% image {% image
src="/images/v1.4/connectors/configure-metadata-ingestion-database.png" src="/images/v1.4/connectors/configure-metadata-ingestion-database-1.png"
alt="Configure Metadata Ingestion" alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page" /%} caption="Configure Metadata Ingestion Page - 1" /%}
{% image
src="/images/v1.4/connectors/configure-metadata-ingestion-database-2.png"
alt="Configure Metadata Ingestion"
caption="Configure Metadata Ingestion Page - 2" /%}
{% /stepVisualInfo %} {% /stepVisualInfo %}
@ -36,12 +41,19 @@ If the owner's name is openmetadata, you need to enter `openmetadata@domain.com`
- **Table Filter Pattern (Optional)**: Use to table filter patterns to control whether to include tables as part of metadata ingestion. - **Table Filter Pattern (Optional)**: Use to table filter patterns to control whether to include tables as part of metadata ingestion.
- **Include**: Explicitly include tables by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all tables with names matching one or more of the supplied regular expressions. All other tables will be excluded. - **Include**: Explicitly include tables by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all tables with names matching one or more of the supplied regular expressions. All other tables will be excluded.
- **Exclude**: Explicitly exclude tables by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all tables with names matching one or more of the supplied regular expressions. All other tables will be included. - **Exclude**: Explicitly exclude tables by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all tables with names matching one or more of the supplied regular expressions. All other tables will be included.
- **Include views (toggle)**: Set the Include views toggle to control whether to include views as part of metadata ingestion.
- **Include tags (toggle)**: Set the 'Include Tags' toggle to control whether to include tags as part of metadata ingestion.
- **Enable Debug Log (toggle)**: Set the Enable Debug Log toggle to set the default log level to debug. - **Enable Debug Log (toggle)**: Set the Enable Debug Log toggle to set the default log level to debug.
- **Include Owner(toggle)**: Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
- **Mark Deleted Tables (toggle)**: Set the Mark Deleted Tables toggle to flag tables as soft-deleted if they are not present anymore in the source system. - **Mark Deleted Tables (toggle)**: Set the Mark Deleted Tables toggle to flag tables as soft-deleted if they are not present anymore in the source system.
- **Mark Deleted Tables from Filter Only (toggle)**: Set the Mark Deleted Tables from Filter Only toggle to flag tables as soft-deleted if they are not present anymore within the filtered schema or database only. This flag is useful when you have more than one ingestion pipelines. For example if you have a schema - **Mark Deleted Tables from Filter Only (toggle)**: Set the Mark Deleted Tables from Filter Only toggle to flag tables as soft-deleted if they are not present anymore within the filtered schema or database only. This flag is useful when you have more than one ingestion pipelines. For example if you have a schema
- **includeTables (toggle)**: Optional configuration to turn off fetching metadata for tables.
- **includeViews (toggle)**: Set the Include views toggle to control whether to include views as part of metadata ingestion.
- **includeTags (toggle)**: Set the 'Include Tags' toggle to control whether to include tags as part of metadata ingestion.
- **includeOwners (toggle)**: Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
- **includeStoredProcedures (toggle)**: Optional configuration to toggle the Stored Procedures ingestion.
- **includeDDL (toggle)**: Optional configuration to toggle the DDL Statements ingestion.
- **queryLogDuration (Optional)**: Configuration to tune how far we want to look back in query logs to process Stored Procedures results.
- **queryParsingTimeoutLimit (Optional)**: Configuration to set the timeout for parsing the query in seconds.
- **useFqnForFiltering (toggle)**: Regex will be applied on fully qualified name (e.g service_name.db_name.schema_name.table_name) instead of raw name (e.g. table_name).
- **Incremental (Beta)**: Use Incremental Metadata Extraction after the first execution. This is done by getting the changed tables instead of all of them. **Only Available for BigQuery, Redshift and Snowflake** - **Incremental (Beta)**: Use Incremental Metadata Extraction after the first execution. This is done by getting the changed tables instead of all of them. **Only Available for BigQuery, Redshift and Snowflake**
- **Enabled**: If `True`, enables Metadata Extraction to be Incremental. - **Enabled**: If `True`, enables Metadata Extraction to be Incremental.
- **lookback Days**: Number of days to search back for a successful pipeline run. The timestamp of the last found successful pipeline run will be used as a base to search for updated entities. - **lookback Days**: Number of days to search back for a successful pipeline run. The timestamp of the last found successful pipeline run will be used as a base to search for updated entities.

View File

@ -6,10 +6,26 @@ The `sourceConfig` is defined [here](https://github.com/open-metadata/OpenMetada
**markDeletedTables**: To flag tables as soft-deleted if they are not present anymore in the source system. **markDeletedTables**: To flag tables as soft-deleted if they are not present anymore in the source system.
**markDeletedStoredProcedures**: Optional configuration to soft delete stored procedures in OpenMetadata if the source stored procedures are deleted. Also, if the stored procedures is deleted, all the associated entities like lineage, etc., with that stored procedures will be deleted.
**includeTables**: true or false, to ingest table data. Default is true. **includeTables**: true or false, to ingest table data. Default is true.
**includeViews**: true or false, to ingest views definitions. **includeViews**: true or false, to ingest views definitions.
**includeTags**: Optional configuration to toggle the tags ingestion.
**includeOwners**: Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten.
**includeStoredProcedures**: Optional configuration to toggle the Stored Procedures ingestion.
**includeDDL**: Optional configuration to toggle the DDL Statements ingestion.
**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.
**useFqnForFiltering**: Regex will be applied on fully qualified name (e.g service_name.db_name.schema_name.table_name) instead of raw name (e.g. table_name).
**databaseFilterPattern**, **schemaFilterPattern**, **tableFilterPattern**: Note that the filter supports regex as include or exclude. You can find examples [here](/connectors/ingestion/workflows/metadata/filter-patterns/database) **databaseFilterPattern**, **schemaFilterPattern**, **tableFilterPattern**: Note that the filter supports regex as include or exclude. You can find examples [here](/connectors/ingestion/workflows/metadata/filter-patterns/database)
**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. **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.

View File

@ -3,14 +3,21 @@
config: config:
type: DatabaseMetadata type: DatabaseMetadata
markDeletedTables: true markDeletedTables: true
markDeletedStoredProcedures: true
includeTables: true includeTables: true
includeViews: true includeViews: true
# includeTags: true
# includeOwners: false
# includeStoredProcedures: true
# includeDDL: true
# queryLogDuration: 1
# queryParsingTimeoutLimit: 300
# useFqnForFiltering: false
# threads: 4 # threads: 4
# incremental: # incremental:
# enabled: true # enabled: true
# lookbackDays: 7 # lookbackDays: 7
# safetyMarginDays: 1 # safetyMarginDays: 1
# includeTags: true
# databaseFilterPattern: # databaseFilterPattern:
# includes: # includes:
# - database1 # - database1

View File

@ -11,19 +11,29 @@ slug: /main-concepts/metadata-standard/schemas/metadataingestion/databaseservice
- **`type`**: Pipeline type. Refer to *#/definitions/databaseMetadataConfigType*. Default: `DatabaseMetadata`. - **`type`**: Pipeline type. Refer to *#/definitions/databaseMetadataConfigType*. Default: `DatabaseMetadata`.
- **`markDeletedTables`** *(boolean)*: This is an optional configuration for enabling soft deletion of tables. When this option is enabled, only tables that have been deleted from the source will be soft deleted, and this will apply solely to the schema that is currently being ingested via the pipeline. Any related entities such as test suites or lineage information that were associated with those tables will also be deleted. Default: `True`. - **`markDeletedTables`** *(boolean)*: This is an optional configuration for enabling soft deletion of tables. When this option is enabled, only tables that have been deleted from the source will be soft deleted, and this will apply solely to the schema that is currently being ingested via the pipeline. Any related entities such as test suites or lineage information that were associated with those tables will also be deleted. Default: `True`.
- **`markDeletedStoredProcedures`** *(boolean)*: Optional configuration to soft delete stored procedures in OpenMetadata if the source stored procedures are deleted. Also, if the stored procedures is deleted, all the associated entities like lineage, etc., with that stored procedures will be deleted. Default: `True`.
- **`includeTables`** *(boolean)*: Optional configuration to turn off fetching metadata for tables. Default: `True`. - **`includeTables`** *(boolean)*: Optional configuration to turn off fetching metadata for tables. Default: `True`.
- **`includeViews`** *(boolean)*: Optional configuration to turn off fetching metadata for views. Default: `True`. - **`includeViews`** *(boolean)*: Optional configuration to turn off fetching metadata for views. Default: `True`.
- **`includeTags`** *(boolean)*: Optional configuration to toggle the tags ingestion. Default: `True`. - **`includeTags`** *(boolean)*: Optional configuration to toggle the tags ingestion. Default: `True`.
- **`includeOwners`** *(boolean)*: Set the 'Include Owners' toggle to control whether to include owners to the ingested entity if the owner email matches with a user stored in the OM server as part of metadata ingestion. If the ingested entity already exists and has an owner, the owner will not be overwritten. Default: `False`.
- **`includeStoredProcedures`** *(boolean)*: Optional configuration to toggle the Stored Procedures ingestion. Default: `True`. - **`includeStoredProcedures`** *(boolean)*: Optional configuration to toggle the Stored Procedures ingestion. Default: `True`.
- **`includeDDL`** *(boolean)*: Optional configuration to toggle the DDL Statements ingestion. Default: `True`.
- **`queryLogDuration`** *(integer)*: Configuration to tune how far we want to look back in query logs to process Stored Procedures results. Default: `1`. - **`queryLogDuration`** *(integer)*: Configuration to tune how far we want to look back in query logs to process Stored Procedures results. Default: `1`.
- **`queryParsingTimeoutLimit`** *(integer)*: Configuration to set the timeout for parsing the query in seconds. Default: `300`. - **`queryParsingTimeoutLimit`** *(integer)*: Configuration to set the timeout for parsing the query in seconds. Default: `300`.
- **`useFqnForFiltering`** *(boolean)*: Regex will be applied on fully qualified name (e.g service_name.db_name.schema_name.table_name) instead of raw name (e.g. table_name). Default: `False`. - **`useFqnForFiltering`** *(boolean)*: Regex will be applied on fully qualified name (e.g service_name.db_name.schema_name.table_name) instead of raw name (e.g. table_name). Default: `False`.
- **`schemaFilterPattern`**: Regex to only fetch tables or databases that matches the pattern. Refer to *../type/filterPattern.json#/definitions/filterPattern*. - **`schemaFilterPattern`**: Regex to only fetch tables or databases that matches the pattern. Refer to *../type/filterPattern.json#/definitions/filterPattern*.
- **`tableFilterPattern`**: Regex exclude tables or databases that matches the pattern. Refer to *../type/filterPattern.json#/definitions/filterPattern*. - **`tableFilterPattern`**: Regex exclude tables or databases that matches the pattern. Refer to *../type/filterPattern.json#/definitions/filterPattern*.
- **`databaseFilterPattern`**: Regex to only fetch databases that matches the pattern. Refer to *../type/filterPattern.json#/definitions/filterPattern*. - **`databaseFilterPattern`**: Regex to only fetch databases that matches the pattern. Refer to *../type/filterPattern.json#/definitions/filterPattern*.
## Definitions ## Definitions
- **`databaseMetadataConfigType`** *(string)*: Database Source Config Metadata Pipeline type. Must be one of: `['DatabaseMetadata']`. Default: `DatabaseMetadata`. - **`databaseMetadataConfigType`** *(string)*: Database Source Config Metadata Pipeline type. Must be one of: `['DatabaseMetadata']`. Default: `DatabaseMetadata`.
## Incremental
- Use Incremental Metadata Extraction after the first execution. This is done by getting the changed tables instead of all of them. **Only Available for BigQuery, Redshift and Snowflake**
- **`Enabled`**: Optional configuration for Metadata Extraction to be Incremental. Default: `True`,
- **`lookback Days`**: Number of days to search back for a successful pipeline run. The timestamp of the last found successful pipeline run will be used as a base to search for updated entities. Default: `7`
- **`Safety Margin Days`**: Number of days to add to the last successful pipeline run timestamp to search for updated entities. Default: `1`
Documentation file automatically generated at 2023-10-27 13:55:46.343512. Documentation file automatically generated at 2023-10-27 13:55:46.343512.

Binary file not shown.

After

Width:  |  Height:  |  Size: 147 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 154 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 147 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 154 KiB