schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
datahub_ingestion_schema.json
max_file_snippet_length
When extracting the view definition from a lookml file, the maximum number of characters to extract.
{"default": 512000, "type": "integer"}
datahub_ingestion_schema.json
emit_reachable_views_only
When enabled, only views that are reachable from explores defined in the model files are emitted
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
populate_sql_logic_for_missing_descriptions
When enabled, field descriptions will include the sql logic for computed fields if descriptions are missing
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
process_isolation_for_sql_parsing
When enabled, sql parsing will be executed in a separate process to prevent memory leaks.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
process_refinements
When enabled, looker refinement will be processed to adapt an existing view.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
redshift_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"store_last_profiling_timestamps": {"default": false, "type": "boolean"}, "incremental_lineage": {"default": true, "type": "boolean"}, "sql_parser_use_external_process": {"default": false, "type": "boolean"}, "store_last_lineage_extraction_timestamp": {"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"}, "s3_lineage_config": {"default": {"path_specs": [], "strip_urls": true}, "allOf": [{}]}, "env": {"default": "PROD", "type": "string"}, "platform_instance_map": {"type": "object", "additionalProperties": {"type": "string"}}, "platform_instance": {"type": "string"}, "stateful_ingestion": {}, "options": {"type": "object"}, "schema_pattern": {"default": {"allow": [".*"], "deny": ["information_schema"], "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": {"default": "dev", "type": "string"}, "database_alias": {"type": "string"}, "scheme": {"default": "redshift+psycopg2", "hidden_from_schema": true, "type": "string"}, "sqlalchemy_uri": {"type": "string"}, "default_schema": {"default": "public", "type": "string"}, "include_table_lineage": {"default": true, "type": "boolean"}, "include_copy_lineage": {"default": true, "type": "boolean"}, "include_usage_statistics": {"default": false, "type": "boolean"}, "include_unload_lineage": {"default": true, "type": "boolean"}, "capture_lineage_query_parser_failures": {"default": false, "hide_from_schema": true, "type": "boolean"}, "table_lineage_mode": {"default": "stl_scan_based", "allOf": [{}]}, "extra_client_options": {"default": {}, "type": "object"}, "match_fully_qualified_names": {"default": false, "type": "boolean"}}, "required": ["host_port"], "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
incremental_lineage
When enabled, emits lineage as incremental to existing lineage already in DataHub. When disabled, re-states lineage on each run.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
sql_parser_use_external_process
When enabled, sql parser will run in isolated in a separate process. This can affect processing time but can protect from sql parser's mem leak.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
store_last_lineage_extraction_timestamp
Enable checking last lineage extraction date 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
s3_lineage_config
Common config for S3 lineage generation
{"default": {"path_specs": [], "strip_urls": true}, "allOf": [{}]}
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
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
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
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
{"default": "dev", "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
default_schema
The default schema to use if the sql parser fails to parse the schema with `sql_based` lineage collector
{"default": "public", "type": "string"}
datahub_ingestion_schema.json
include_table_lineage
Whether table lineage should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_copy_lineage
Whether lineage should be collected from copy commands
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_usage_statistics
Generate usage statistic. email_domain config parameter needs to be set if enabled
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
include_unload_lineage
Whether lineage should be collected from unload commands
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
capture_lineage_query_parser_failures
Whether to capture lineage query parser errors with dataset properties for debugging
{"default": false, "hide_from_schema": true, "type": "boolean"}
datahub_ingestion_schema.json
table_lineage_mode
Which table lineage collector mode to use. Available modes are: [stl_scan_based, sql_based, mixed]
{"default": "stl_scan_based", "allOf": [{}]}
datahub_ingestion_schema.json
match_fully_qualified_names
Whether `schema_pattern` is matched against fully qualified schema name `<database>.<schema>`.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
redshift-usage-legacy_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"}, "s3_lineage_config": {"allOf": [{}]}, "platform_instance_map": {"type": "object", "additionalProperties": {"type": "string"}}, "platform_instance": {"type": "string"}, "stateful_ingestion": {}, "options": {"default": {}, "type": "object"}, "schema_pattern": {"default": {"allow": [".*"], "deny": ["information_schema"], "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"}, "sqlalchemy_uri": {"type": "string"}, "default_schema": {"default": "public", "type": "string"}, "include_table_lineage": {"default": true, "type": "boolean"}, "include_copy_lineage": {"default": true, "type": "boolean"}, "include_unload_lineage": {"default": true, "type": "boolean"}, "capture_lineage_query_parser_failures": {"default": false, "type": "boolean"}, "table_lineage_mode": {"default": "stl_scan_based", "allOf": [{}]}, "email_domain": {"type": "string"}}, "required": ["host_port", "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
s3_lineage_config
Common config for S3 lineage generation
{"allOf": [{}]}
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
options
Any options specified here will be passed to SQLAlchemy's create_engine as kwargs.See https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine for details.
{"default": {}, "type": "object"}
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
default_schema
The default schema to use if the sql parser fails to parse the schema with `sql_based` lineage collector
{"default": "public", "type": "string"}
datahub_ingestion_schema.json
include_table_lineage
Whether table lineage should be ingested.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_copy_lineage
Whether lineage should be collected from copy commands
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
include_unload_lineage
Whether lineage should be collected from unload commands
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
capture_lineage_query_parser_failures
Whether to capture lineage query parser errors with dataset properties for debuggings
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
table_lineage_mode
Which table lineage collector mode to use. Available modes are: [stl_scan_based, sql_based, mixed]
{"default": "stl_scan_based", "allOf": [{}]}
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
vertica_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": [], "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": "vertica+vertica_python", "type": "string"}, "sqlalchemy_uri": {"type": "string"}, "models_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "include_projections": {"default": true, "type": "boolean"}, "include_models": {"default": true, "type": "boolean"}, "include_view_lineage": {"default": true, "type": "boolean"}, "include_projection_lineage": {"default": true, "type": "boolean"}}, "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. 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
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"}