schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
datahub_ingestion_schema.json
kafka-connect_config
Any source that connects to a platform should inherit this class
{"type": "object", "properties": {"stateful_ingestion": {}, "env": {"default": "PROD", "type": "string"}, "platform_instance_map": {"type": "object", "additionalProperties": {"type": "string"}}, "platform_instance": {"type": "string"}, "connect_uri": {"default": "http://localhost:8083/", "type": "string"}, "username": {"type": "string"}, "password": {"type": "string"}, "cluster_name": {"default": "connect-cluster", "type": "string"}, "convert_lineage_urns_to_lowercase": {"default": false, "type": "boolean"}, "connector_patterns": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "provided_configs": {"type": "array", "items": {}}, "connect_to_platform_map": {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}}, "generic_connectors": {"default": [], "type": "array", "items": {}}}, "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_map
Platform instance mapping to use when constructing URNs. e.g.`platform_instance_map: { "hive": "warehouse" }`
{"type": "object", "additionalProperties": {"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
connect_uri
URI to connect to.
{"default": "http://localhost:8083/", "type": "string"}
datahub_ingestion_schema.json
username
Kafka Connect username.
{"type": "string"}
datahub_ingestion_schema.json
password
Kafka Connect password.
{"type": "string"}
datahub_ingestion_schema.json
cluster_name
Cluster to ingest from.
{"default": "connect-cluster", "type": "string"}
datahub_ingestion_schema.json
convert_lineage_urns_to_lowercase
Whether to convert the urns of ingested lineage dataset to lowercase
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
connector_patterns
regex patterns for connectors to filter for ingestion.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
provided_configs
Provided Configurations
{"type": "array", "items": {}}
datahub_ingestion_schema.json
connect_to_platform_map
Platform instance mapping when multiple instances for a platform is available. Entry for a platform should be in either `platform_instance_map` or `connect_to_platform_map`. e.g.`connect_to_platform_map: { "postgres-connector-finance-db": "postgres": "core_finance_instance" }`
{"type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}}
datahub_ingestion_schema.json
generic_connectors
Provide lineage graph for sources connectors other than Confluent JDBC Source Connector, Debezium Source Connector, and Mongo Source Connector
{"default": [], "type": "array", "items": {}}
datahub_ingestion_schema.json
sagemaker_config
Common AWS credentials config. Currently used by: - Glue source - SageMaker source
{"type": "object", "properties": {"aws_access_key_id": {"type": "string"}, "aws_secret_access_key": {"type": "string"}, "aws_session_token": {"type": "string"}, "aws_role": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"anyOf": [{"type": "string"}, {}]}}]}, "aws_profile": {"type": "string"}, "aws_region": {"type": "string"}, "aws_endpoint_url": {"type": "string"}, "aws_proxy": {"type": "object", "additionalProperties": {"type": "string"}}, "env": {"default": "PROD", "type": "string"}, "database_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "table_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "extract_feature_groups": {"default": true, "type": "boolean"}, "extract_models": {"default": true, "type": "boolean"}, "extract_jobs": {"default": true, "anyOf": [{"type": "object", "additionalProperties": {"type": "string"}}, {"type": "boolean"}]}}, "required": ["aws_region"], "additionalProperties": false}
datahub_ingestion_schema.json
aws_access_key_id
AWS access key ID. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.
{"type": "string"}
datahub_ingestion_schema.json
aws_secret_access_key
AWS secret access key. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.
{"type": "string"}
datahub_ingestion_schema.json
aws_session_token
AWS session token. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.
{"type": "string"}
datahub_ingestion_schema.json
aws_role
AWS roles to assume. If using the string format, the role ARN can be specified directly. If using the object format, the role can be specified in the RoleArn field and additional available arguments are documented at https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts.html?highlight=assume_role#STS.Client.assume_role
{"anyOf": [{"type": "string"}, {"type": "array", "items": {"anyOf": [{"type": "string"}, {}]}}]}
datahub_ingestion_schema.json
aws_profile
Named AWS profile to use. Only used if access key / secret are unset. If not set the default will be used
{"type": "string"}
datahub_ingestion_schema.json
aws_region
AWS region code.
{"type": "string"}
datahub_ingestion_schema.json
aws_endpoint_url
The AWS service endpoint. This is normally [constructed automatically](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html), but can be overridden here.
{"type": "string"}
datahub_ingestion_schema.json
aws_proxy
A set of proxy configs to use with AWS. See the [botocore.config](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html) docs for details.
{"type": "object", "additionalProperties": {"type": "string"}}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
database_pattern
regex patterns for databases to filter in ingestion.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
table_pattern
regex patterns for tables to filter in ingestion.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
extract_feature_groups
Whether to extract feature groups.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
extract_models
Whether to extract models.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
extract_jobs
Whether to extract AutoML jobs.
{"default": true, "anyOf": [{"type": "object", "additionalProperties": {"type": "string"}}, {"type": "boolean"}]}
datahub_ingestion_schema.json
druid_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "stateful_ingestion": {}, "options": {"type": "object"}, "schema_pattern": {"default": {"allow": [".*"], "deny": ["^(lookup|sysgit|view).*"], "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": [{}]}, "username": {"type": "string"}, "password": {"type": "string", "writeOnly": true, "format": "password"}, "host_port": {"type": "string"}, "database": {"type": "string"}, "database_alias": {"type": "string"}, "scheme": {"default": "druid", "type": "string"}, "sqlalchemy_uri": {"type": "string"}}, "required": ["host_port"], "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
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.
{"default": {"allow": [".*"], "deny": ["^(lookup|sysgit|view).*"], "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
username
{"type": "string"}
datahub_ingestion_schema.json
password
password
{"type": "string", "writeOnly": true, "format": "password"}
datahub_ingestion_schema.json
host_port
host URL
{"type": "string"}
datahub_ingestion_schema.json
database
database (catalog)
{"type": "string"}
datahub_ingestion_schema.json
database_alias
[Deprecated] Alias to apply to database when ingesting.
{"type": "string"}
datahub_ingestion_schema.json
sqlalchemy_uri
URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.
{"type": "string"}
datahub_ingestion_schema.json
glue_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"aws_access_key_id": {"type": "string"}, "aws_secret_access_key": {"type": "string"}, "aws_session_token": {"type": "string"}, "aws_role": {"anyOf": [{"type": "string"}, {"type": "array", "items": {"anyOf": [{"type": "string"}, {}]}}]}, "aws_profile": {"type": "string"}, "aws_region": {"type": "string"}, "aws_endpoint_url": {"type": "string"}, "aws_proxy": {"type": "object", "additionalProperties": {"type": "string"}}, "env": {"default": "PROD", "type": "string"}, "database_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "table_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "platform_instance": {"type": "string"}, "stateful_ingestion": {}, "platform": {"default": "glue", "type": "string"}, "extract_owners": {"default": true, "type": "boolean"}, "extract_transforms": {"default": true, "type": "boolean"}, "ignore_unsupported_connectors": {"default": true, "type": "boolean"}, "emit_s3_lineage": {"default": false, "type": "boolean"}, "glue_s3_lineage_direction": {"default": "upstream", "type": "string"}, "domain": {"default": {}, "type": "object", "additionalProperties": {}}, "catalog_id": {"type": "string"}, "ignore_resource_links": {"default": false, "type": "boolean"}, "use_s3_bucket_tags": {"default": false, "type": "boolean"}, "use_s3_object_tags": {"default": false, "type": "boolean"}, "profiling": {"allOf": [{}]}}, "required": ["aws_region"], "additionalProperties": false}
datahub_ingestion_schema.json
aws_access_key_id
AWS access key ID. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.
{"type": "string"}
datahub_ingestion_schema.json
aws_secret_access_key
AWS secret access key. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.
{"type": "string"}
datahub_ingestion_schema.json
aws_session_token
AWS session token. Can be auto-detected, see [the AWS boto3 docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html) for details.
{"type": "string"}
datahub_ingestion_schema.json
aws_role
AWS roles to assume. If using the string format, the role ARN can be specified directly. If using the object format, the role can be specified in the RoleArn field and additional available arguments are documented at https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/sts.html?highlight=assume_role#STS.Client.assume_role
{"anyOf": [{"type": "string"}, {"type": "array", "items": {"anyOf": [{"type": "string"}, {}]}}]}
datahub_ingestion_schema.json
aws_profile
Named AWS profile to use. Only used if access key / secret are unset. If not set the default will be used
{"type": "string"}
datahub_ingestion_schema.json
aws_region
AWS region code.
{"type": "string"}
datahub_ingestion_schema.json
aws_endpoint_url
The AWS service endpoint. This is normally [constructed automatically](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html), but can be overridden here.
{"type": "string"}
datahub_ingestion_schema.json
aws_proxy
A set of proxy configs to use with AWS. See the [botocore.config](https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html) docs for details.
{"type": "object", "additionalProperties": {"type": "string"}}
datahub_ingestion_schema.json
env
The environment that all assets produced by this connector belong to
{"default": "PROD", "type": "string"}
datahub_ingestion_schema.json
database_pattern
regex patterns for databases to filter in ingestion.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
table_pattern
regex patterns for tables to filter in ingestion.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
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
platform
The platform to use for the dataset URNs. Must be one of ['glue', 'athena'].
{"default": "glue", "type": "string"}
datahub_ingestion_schema.json
extract_owners
When enabled, extracts ownership from Glue directly and overwrites existing owners. When disabled, ownership is left empty for datasets.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
extract_transforms
Whether to extract Glue transform jobs.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
ignore_unsupported_connectors
Whether to ignore unsupported connectors. If disabled, an error will be raised.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
emit_s3_lineage
Whether to emit S3-to-Glue lineage.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
glue_s3_lineage_direction
If `upstream`, S3 is upstream to Glue. If `downstream` S3 is downstream to Glue.
{"default": "upstream", "type": "string"}
datahub_ingestion_schema.json
domain
regex patterns for tables to filter to assign domain_key.
{"default": {}, "type": "object", "additionalProperties": {}}
datahub_ingestion_schema.json
catalog_id
The aws account id where the target glue catalog lives. If None, datahub will ingest glue in aws caller's account.
{"type": "string"}
datahub_ingestion_schema.json
ignore_resource_links
If set to True, ignore database resource links.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
use_s3_bucket_tags
If an S3 Buckets Tags should be created for the Tables ingested by Glue. Please Note that this will not apply tags to any folders ingested, only the files.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
use_s3_object_tags
If an S3 Objects Tags should be created for the Tables ingested by Glue.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
profiling
Configs to ingest data profiles from glue table
{"allOf": [{}]}
datahub_ingestion_schema.json
clickhouse-usage_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"env": {"default": "PROD", "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"}, "platform_instance_map": {"type": "object", "additionalProperties": {"type": "string"}}, "platform_instance": {"type": "string"}, "stateful_ingestion": {}, "options": {"default": {}, "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": [{}]}, "username": {"type": "string"}, "password": {"default": "", "type": "string", "writeOnly": true, "format": "password"}, "host_port": {"default": "localhost:8123", "type": "string"}, "database": {"type": "string"}, "database_alias": {"type": "string"}, "sqlalchemy_uri": {"type": "string"}, "database_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "secure": {"type": "boolean"}, "protocol": {"type": "string"}, "uri_opts": {"default": {}, "type": "object", "additionalProperties": {"type": "string"}}, "include_table_lineage": {"default": true, "type": "boolean"}, "include_materialized_views": {"default": true, "type": "boolean"}, "email_domain": {"type": "string"}, "query_log_table": {"default": "system.query_log", "type": "string"}}, "required": ["email_domain"], "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
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
platform_instance_map
A holder for platform -> platform_instance mappings to generate correct dataset urns
{"type": "object", "additionalProperties": {"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
schema_pattern
Deprecated in favour of database_pattern.
{"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
username
{"type": "string"}
datahub_ingestion_schema.json
password
password
{"default": "", "type": "string", "writeOnly": true, "format": "password"}
datahub_ingestion_schema.json
host_port
ClickHouse host URL.
{"default": "localhost:8123", "type": "string"}
datahub_ingestion_schema.json
database
database (catalog)
{"type": "string"}
datahub_ingestion_schema.json
database_alias
[Deprecated] Alias to apply to database when ingesting.
{"type": "string"}
datahub_ingestion_schema.json
sqlalchemy_uri
URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.
{"type": "string"}
datahub_ingestion_schema.json
database_pattern
Regex patterns for databases to filter in ingestion.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
uri_opts
The part of the URI and it's used to provide additional configuration options or parameters for the database connection.
{"default": {}, "type": "object", "additionalProperties": {"type": "string"}}