schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
datahub_ingestion_schema.json
admin_apis_only
Retrieve metadata using PowerBI Admin API only. If this is enabled, then Report Pages will not be extracted. Admin API access is required if this setting is enabled
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
extract_independent_datasets
Whether to extract datasets not used in any PowerBI visualization
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
elasticsearch_config
Any source that connects to a platform should inherit this class
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "host": {"default": "localhost:9200", "type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}, "use_ssl": {"default": false, "type": "boolean"}, "verify_certs": {"default": false, "type": "boolean"}, "ca_certs": {"type": "string"}, "client_cert": {"type": "string"}, "client_key": {"type": "string"}, "ssl_assert_hostname": {"default": false, "type": "boolean"}, "ssl_assert_fingerprint": {"type": "string"}, "url_prefix": {"default": "", "type": "string"}, "index_pattern": {"default": {"allow": [".*"], "deny": ["^_.*", "^ilm-history.*"], "ignoreCase": true}, "allOf": [{}]}, "ingest_index_templates": {"default": false, "type": "boolean"}, "index_template_pattern": {"default": {"allow": [".*"], "deny": ["^_.*"], "ignoreCase": true}, "allOf": [{}]}, "profiling": {}, "collapse_urns": {}}, "additionalProperties": false}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance
The instance of the platform that all assets produced by this recipe belong to
{"type": "string"}
datahub_ingestion_schema.json
host
The elastic search host URI.
{"default": "localhost:9200", "type": "string"}
datahub_ingestion_schema.json
username
The username credential.
{"type": "string"}
datahub_ingestion_schema.json
password
The password credential.
{"type": "string"}
datahub_ingestion_schema.json
use_ssl
Whether to use SSL for the connection or not.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
verify_certs
Whether to verify SSL certificates.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
ca_certs
Path to a certificate authority (CA) certificate.
{"type": "string"}
datahub_ingestion_schema.json
client_cert
Path to the file containing the private key and the certificate, or cert only if using client_key.
{"type": "string"}
datahub_ingestion_schema.json
client_key
Path to the file containing the private key if using separate cert and key files.
{"type": "string"}
datahub_ingestion_schema.json
ssl_assert_hostname
Use hostname verification if not False.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
ssl_assert_fingerprint
Verify the supplied certificate fingerprint if not None.
{"type": "string"}
datahub_ingestion_schema.json
url_prefix
There are cases where an enterprise would have multiple elastic search clusters. One way for them to manage is to have a single endpoint for all the elastic search clusters and use url_prefix for routing requests to different clusters.
{"default": "", "type": "string"}
datahub_ingestion_schema.json
index_pattern
regex patterns for indexes to filter in ingestion.
{"default": {"allow": [".*"], "deny": ["^_.*", "^ilm-history.*"], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
ingest_index_templates
Ingests ES index templates if enabled.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
index_template_pattern
The regex patterns for filtering index templates to ingest.
{"default": {"allow": [".*"], "deny": ["^_.*"], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
snowflake_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"classification": {"default": {"enabled": false, "sample_size": 100, "max_workers": 2, "table_pattern": {"allow": [".*"], "deny": [], "ignoreCase": true}, "column_pattern": {"allow": [".*"], "deny": [], "ignoreCase": true}, "info_type_to_term": {}, "classifiers": [{"type": "datahub", "config": null}]}, "allOf": [{}]}, "store_last_profiling_timestamps": {"default": false, "type": "boolean"}, "bucket_duration": {"default": "DAY", "allOf": [{}]}, "end_time": {"type": "string", "format": "date-time"}, "start_time": {"type": "string", "format": "date-time"}, "store_last_usage_extraction_timestamp": {"default": true, "type": "boolean"}, "top_n_queries": {"default": 10, "exclusiveMinimum": 0, "type": "integer"}, "user_email_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "include_operational_stats": {"default": true, "type": "boolean"}, "include_read_operational_stats": {"default": false, "type": "boolean"}, "format_sql_queries": {"default": false, "type": "boolean"}, "include_top_n_queries": {"default": true, "type": "boolean"}, "email_domain": {"type": "string"}, "apply_view_usage_to_tables": {"default": false, "type": "boolean"}, "env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "stateful_ingestion": {}, "options": {"type": "object"}, "schema_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "table_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "view_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "profile_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "domain": {"default": {}, "type": "object", "additionalProperties": {}}, "include_views": {"default": true, "type": "boolean"}, "include_tables": {"default": true, "type": "boolean"}, "include_table_location_lineage": {"default": true, "type": "boolean"}, "profiling": {"default": {"enabled": false, "operation_config": {"lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null}, "limit": null, "offset": null, "report_dropped_profiles": false, "turn_off_expensive_profiling_metrics": false, "profile_table_level_only": false, "include_field_null_count": true, "include_field_distinct_count": true, "include_field_min_value": true, "include_field_max_value": true, "include_field_mean_value": true, "include_field_median_value": true, "include_field_stddev_value": true, "include_field_quantiles": false, "include_field_distinct_value_frequencies": false, "include_field_histogram": false, "include_field_sample_values": true, "field_sample_values_limit": 20, "max_number_of_fields_to_profile": null, "profile_if_updated_since_days": null, "profile_table_size_limit": 5, "profile_table_row_limit": 5000000, "profile_table_row_count_estimate_only": false, "max_workers": 10, "query_combiner_enabled": true, "catch_exceptions": true, "partition_profiling_enabled": true, "partition_datetime": null}, "allOf": [{}]}, "scheme": {"default": "snowflake", "type": "string"}, "username": {"type": "string"}, "password": {"type": "string", "writeOnly": true, "format": "password"}, "private_key": {"type": "string"}, "private_key_path": {"type": "string"}, "private_key_password": {"type": "string", "writeOnly": true, "format": "password"}, "oauth_config": {"allOf": [{}]}, "authentication_type": {"default": "DEFAULT_AUTHENTICATOR", "type": "string"}, "account_id": {"type": "string"}, "warehouse": {"type": "string"}, "role": {"type": "string"}, "include_table_lineage": {"default": true, "type": "boolean"}, "include_view_lineage": {"default": true, "type": "boolean"}, "connect_args": {"type": "object"}, "database_pattern": {"default": {"allow": [".*"], "deny": ["^UTIL_DB$", "^SNOWFLAKE$", "^SNOWFLAKE_SAMPLE_DATA$"], "ignoreCase": true}, "allOf": [{}]}, "ignore_start_time_lineage": {"default": false, "type": "boolean"}, "upstream_lineage_in_report": {"default": false, "type": "boolean"}, "convert_urns_to_lowercase": {"default": true, "type": "boolean"}, "include_usage_stats": {"default": true, "type": "boolean"}, "include_technical_schema": {"default": true, "type": "boolean"}, "include_column_lineage": {"default": true, "type": "boolean"}, "include_view_column_lineage": {"default": false, "type": "boolean"}, "extract_tags": {"default": "skip", "allOf": [{}]}, "include_external_url": {"default": true, "type": "boolean"}, "match_fully_qualified_names": {"default": false, "type": "boolean"}, "use_legacy_lineage_method": {"default": false, "type": "boolean"}, "validate_upstreams_against_patterns": {"default": true, "type": "boolean"}, "tag_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "temporary_tables_pattern": {"default": [".*\\.FIVETRAN_.*_STAGING\\..*", ".*__DBT_TMP$", ".*\\.SEGMENT_[a-f0-9]{8}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{12}", ".*\\.STAGING_.*_[a-f0-9]{8}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{12}"], "type": "array", "items": {"type": "string"}}, "email_as_user_identifier": {"default": true, "type": "boolean"}}, "required": ["account_id"], "additionalProperties": false}
datahub_ingestion_schema.json
classification
For details, refer [Classification](../../../../metadata-ingestion/docs/dev_guides/classification.md).
{"default": {"enabled": false, "sample_size": 100, "max_workers": 2, "table_pattern": {"allow": [".*"], "deny": [], "ignoreCase": true}, "column_pattern": {"allow": [".*"], "deny": [], "ignoreCase": true}, "info_type_to_term": {}, "classifiers": [{"type": "datahub", "config": null}]}, "allOf": [{}]}
datahub_ingestion_schema.json
store_last_profiling_timestamps
Enable storing last profile timestamp in store.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
bucket_duration
Size of the time window to aggregate usage stats.
{"default": "DAY", "allOf": [{}]}
datahub_ingestion_schema.json
end_time
Latest date of lineage/usage to consider. Default: Current time in UTC
{"type": "string", "format": "date-time"}
datahub_ingestion_schema.json
start_time
Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.
{"type": "string", "format": "date-time"}
datahub_ingestion_schema.json
store_last_usage_extraction_timestamp
Enable checking last usage timestamp in store.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
top_n_queries
Number of top queries to save to each table.
{"default": 10, "exclusiveMinimum": 0, "type": "integer"}
datahub_ingestion_schema.json
user_email_pattern
regex patterns for user emails to filter in usage.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
include_operational_stats
Whether to display operational stats.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_read_operational_stats
Whether to report read operational stats. Experimental.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
format_sql_queries
Whether to format sql queries
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
include_top_n_queries
Whether to ingest the top_n_queries.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
email_domain
Email domain of your organisation so users can be displayed on UI appropriately.
{"type": "string"}
datahub_ingestion_schema.json
apply_view_usage_to_tables
Whether to apply view's usage to its base tables. If set to True, usage is applied to base tables only.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance
The instance of the platform that all assets produced by this recipe belong to
{"type": "string"}
datahub_ingestion_schema.json
options
Any options specified here will be passed to [SQLAlchemy.create_engine](https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine) as kwargs.
{"type": "object"}
datahub_ingestion_schema.json
schema_pattern
Regex patterns for schemas to filter in ingestion. Specify regex to only match the schema name. e.g. to match all tables in schema analytics, use the regex 'analytics'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
table_pattern
Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in database.schema.table format. e.g. to match all tables starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
view_pattern
Regex patterns for views to filter in ingestion. Note: Defaults to table_pattern if not specified. Specify regex to match the entire view name in database.schema.view format. e.g. to match all views starting with customer in Customer database and public schema, use the regex 'Customer.public.customer.*'
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
profile_pattern
Regex patterns to filter tables (or specific columns) for profiling during ingestion. Note that only tables allowed by the `table_pattern` will be considered.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
domain
Attach domains to databases, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like "Marketing".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.
{"default": {}, "type": "object", "additionalProperties": {}}
datahub_ingestion_schema.json
include_views
Whether views should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_tables
Whether tables should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_table_location_lineage
If the source supports it, include table lineage to the underlying storage location.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
username
Snowflake username.
{"type": "string"}
datahub_ingestion_schema.json
password
Snowflake password.
{"type": "string", "writeOnly": true, "format": "password"}
datahub_ingestion_schema.json
private_key
Private key in a form of '-----BEGIN PRIVATE KEY-----\nprivate-key\n-----END PRIVATE KEY-----\n' if using key pair authentication. Encrypted version of private key will be in a form of '-----BEGIN ENCRYPTED PRIVATE KEY-----\nencrypted-private-key\n-----END ECNCRYPTED PRIVATE KEY-----\n' See: https://docs.snowflake.com/en/user-guide/key-pair-auth.html
{"type": "string"}
datahub_ingestion_schema.json
private_key_path
The path to the private key if using key pair authentication. Ignored if `private_key` is set. See: https://docs.snowflake.com/en/user-guide/key-pair-auth.html
{"type": "string"}
datahub_ingestion_schema.json
private_key_password
Password for your private key. Required if using key pair authentication with encrypted private key.
{"type": "string", "writeOnly": true, "format": "password"}
datahub_ingestion_schema.json
oauth_config
oauth configuration - https://docs.snowflake.com/en/user-guide/python-connector-example.html#connecting-with-oauth
{"allOf": [{}]}
datahub_ingestion_schema.json
authentication_type
The type of authenticator to use when connecting to Snowflake. Supports "DEFAULT_AUTHENTICATOR", "OAUTH_AUTHENTICATOR", "EXTERNAL_BROWSER_AUTHENTICATOR" and "KEY_PAIR_AUTHENTICATOR".
{"default": "DEFAULT_AUTHENTICATOR", "type": "string"}
datahub_ingestion_schema.json
account_id
Snowflake account identifier. e.g. xy12345, xy12345.us-east-2.aws, xy12345.us-central1.gcp, xy12345.central-us.azure, xy12345.us-west-2.privatelink. Refer [Account Identifiers](https://docs.snowflake.com/en/user-guide/admin-account-identifier.html#format-2-legacy-account-locator-in-a-region) for more details.
{"type": "string"}
datahub_ingestion_schema.json
warehouse
Snowflake warehouse.
{"type": "string"}
datahub_ingestion_schema.json
role
Snowflake role.
{"type": "string"}
datahub_ingestion_schema.json
include_table_lineage
If enabled, populates the snowflake table-to-table and s3-to-snowflake table lineage. Requires appropriate grants given to the role and Snowflake Enterprise Edition or above.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_view_lineage
If enabled, populates the snowflake view->table and table->view lineages. Requires appropriate grants given to the role, and include_table_lineage to be True. view->table lineage requires Snowflake Enterprise Edition or above.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
connect_args
Connect args to pass to Snowflake SqlAlchemy driver
{"type": "object"}
datahub_ingestion_schema.json
include_usage_stats
If enabled, populates the snowflake usage statistics. Requires appropriate grants given to the role.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_technical_schema
If enabled, populates the snowflake technical schema and descriptions.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_column_lineage
Populates table->table and view->table column lineage. Requires appropriate grants given to the role and the Snowflake Enterprise Edition or above.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_view_column_lineage
Populates view->view and table->view column lineage.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
extract_tags
Optional. Allowed values are `without_lineage`, `with_lineage`, and `skip` (default). `without_lineage` only extracts tags that have been applied directly to the given entity. `with_lineage` extracts both directly applied and propagated tags, but will be significantly slower. See the [Snowflake documentation](https://docs.snowflake.com/en/user-guide/object-tagging.html#tag-lineage) for information about tag lineage/propagation.
{"default": "skip", "allOf": [{}]}
datahub_ingestion_schema.json
include_external_url
Whether to populate Snowsight url for Snowflake Objects
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
match_fully_qualified_names
Whether `schema_pattern` is matched against fully qualified schema name `<catalog>.<schema>`.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
use_legacy_lineage_method
Whether to use the legacy lineage computation method. By default, uses new optimised lineage extraction method that requires less ingestion process memory. Table-to-view and view-to-view column-level lineage are not supported with the legacy method.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
validate_upstreams_against_patterns
Whether to validate upstream snowflake tables against allow-deny patterns
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
tag_pattern
List of regex patterns for tags to include in ingestion. Only used if `extract_tags` is enabled.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
temporary_tables_pattern
[Advanced] Regex patterns for temporary tables to filter in lineage ingestion. Specify regex to match the entire table name in database.schema.table format. Defaults are to set in such a way to ignore the temporary staging tables created by known ETL tools. Not used if `use_legacy_lineage_method=True`
{"default": [".*\\.FIVETRAN_.*_STAGING\\..*", ".*__DBT_TMP$", ".*\\.SEGMENT_[a-f0-9]{8}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{12}", ".*\\.STAGING_.*_[a-f0-9]{8}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{4}[-_][a-f0-9]{12}"], "type": "array", "items": {"type": "string"}}
datahub_ingestion_schema.json
email_as_user_identifier
Format user urns as an email, if the snowflake user's email is set. If `email_domain` is provided, generates email addresses for snowflake users with unset emails, based on their username.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
superset_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"stateful_ingestion": {"allOf": [{}]}, "connect_uri": {"default": "http://localhost:8088", "type": "string"}, "display_uri": {"type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}, "provider": {"default": "db", "type": "string"}, "options": {"default": {}, "type": "object"}, "env": {"default": "PROD", "type": "string"}, "database_alias": {"default": {}, "type": "object", "additionalProperties": {"type": "string"}}}, "additionalProperties": false}
datahub_ingestion_schema.json
stateful_ingestion
Superset Stateful Ingestion Config.
{"allOf": [{}]}
datahub_ingestion_schema.json
connect_uri
Superset host URL.
{"default": "http://localhost:8088", "type": "string"}
datahub_ingestion_schema.json
display_uri
optional URL to use in links (if `connect_uri` is only for ingestion)
{"type": "string"}
datahub_ingestion_schema.json
username
Superset username.
{"type": "string"}
datahub_ingestion_schema.json
password
Superset password.
{"type": "string"}
datahub_ingestion_schema.json
provider
Superset provider.
{"default": "db", "type": "string"}
datahub_ingestion_schema.json
env
Environment to use in namespace when constructing URNs
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
database_alias
Can be used to change mapping for database names in superset to what you have in datahub
{"default": {}, "type": "object", "additionalProperties": {"type": "string"}}
datahub_ingestion_schema.json
unity-catalog_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"store_last_profiling_timestamps": {"default": false, "type": "boolean"}, "env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "bucket_duration": {"default": "DAY", "allOf": [{}]}, "end_time": {"type": "string", "format": "date-time"}, "start_time": {"type": "string", "format": "date-time"}, "top_n_queries": {"default": 10, "exclusiveMinimum": 0, "type": "integer"}, "user_email_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "include_operational_stats": {"default": true, "type": "boolean"}, "include_read_operational_stats": {"default": false, "type": "boolean"}, "format_sql_queries": {"default": false, "type": "boolean"}, "include_top_n_queries": {"default": true, "type": "boolean"}, "stateful_ingestion": {"allOf": [{}]}, "token": {"type": "string"}, "workspace_url": {"type": "string"}, "workspace_name": {"type": "string"}, "catalog_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "schema_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "table_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "domain": {"default": {}, "type": "object", "additionalProperties": {}}, "include_table_lineage": {"default": true, "type": "boolean"}, "include_ownership": {"default": false, "type": "boolean"}, "include_column_lineage": {"default": true, "type": "boolean"}, "include_usage_statistics": {"default": true, "type": "boolean"}, "profiling": {"default": {"enabled": false, "operation_config": {"lower_freq_profile_enabled": false, "profile_day_of_week": null, "profile_date_of_month": null}, "warehouse_id": null, "profile_table_level_only": false, "pattern": {"allow": [".*"], "deny": [], "ignoreCase": true}, "call_analyze": true, "max_wait_secs": 3600, "max_workers": 10}, "allOf": [{}]}}, "required": ["token", "workspace_url"], "additionalProperties": false}
datahub_ingestion_schema.json
store_last_profiling_timestamps
Enable storing last profile timestamp in store.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
platform_instance
The instance of the platform that all assets produced by this recipe belong to
{"type": "string"}
datahub_ingestion_schema.json
bucket_duration
Size of the time window to aggregate usage stats.
{"default": "DAY", "allOf": [{}]}
datahub_ingestion_schema.json
end_time
Latest date of lineage/usage to consider. Default: Current time in UTC
{"type": "string", "format": "date-time"}
datahub_ingestion_schema.json
start_time
Earliest date of lineage/usage to consider. Default: Last full day in UTC (or hour, depending on `bucket_duration`). You can also specify relative time with respect to end_time such as '-7 days' Or '-7d'.
{"type": "string", "format": "date-time"}
datahub_ingestion_schema.json
top_n_queries
Number of top queries to save to each table.
{"default": 10, "exclusiveMinimum": 0, "type": "integer"}
datahub_ingestion_schema.json
user_email_pattern
regex patterns for user emails to filter in usage.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
include_operational_stats
Whether to display operational stats.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_read_operational_stats
Whether to report read operational stats. Experimental.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
format_sql_queries
Whether to format sql queries
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
include_top_n_queries
Whether to ingest the top_n_queries.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
stateful_ingestion
Unity Catalog Stateful Ingestion Config.
{"allOf": [{}]}
datahub_ingestion_schema.json
token
Databricks personal access token
{"type": "string"}
datahub_ingestion_schema.json
workspace_url
Databricks workspace url. e.g. https://my-workspace.cloud.databricks.com
{"type": "string"}
datahub_ingestion_schema.json
workspace_name
Name of the workspace. Default to deployment name present in workspace_url
{"type": "string"}
datahub_ingestion_schema.json
catalog_pattern
Regex patterns for catalogs to filter in ingestion. Specify regex to match the full `metastore.catalog` name.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
schema_pattern
Regex patterns for schemas to filter in ingestion. Specify regex to the full `metastore.catalog.schema` name. e.g. to match all tables in schema analytics, use the regex `^mymetastore\.mycatalog\.analytics$`.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
table_pattern
Regex patterns for tables to filter in ingestion. Specify regex to match the entire table name in `catalog.schema.table` format. e.g. to match all tables starting with customer in Customer catalog and public schema, use the regex `Customer\.public\.customer.*`.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
domain
Attach domains to catalogs, schemas or tables during ingestion using regex patterns. Domain key can be a guid like *urn:li:domain:ec428203-ce86-4db3-985d-5a8ee6df32ba* or a string like "Marketing".) If you provide strings, then datahub will attempt to resolve this name to a guid, and will error out if this fails. There can be multiple domain keys specified.
{"default": {}, "type": "object", "additionalProperties": {}}