schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
datahub_ingestion_schema.json
kafka_connection
Kafka connection config
{"default": {"bootstrap": "localhost:9092", "schema_registry_url": "http://localhost:8080/schema-registry/api/", "schema_registry_config": {}, "client_timeout_seconds": 60, "consumer_config": {}}, "allOf": [{}]}
datahub_ingestion_schema.json
include_all_versions
If enabled, include all versions of each aspect. Otherwise, only include the latest version of each aspect.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
mysql_batch_size
Number of records to fetch from MySQL at a time
{"default": 10000, "type": "integer"}
datahub_ingestion_schema.json
mysql_table_name
Name of MySQL table containing all versioned aspects
{"default": "metadata_aspect_v2", "type": "string"}
datahub_ingestion_schema.json
kafka_topic_name
Name of kafka topic containing timeseries MCLs
{"default": "MetadataChangeLog_Timeseries_v1", "type": "string"}
datahub_ingestion_schema.json
commit_state_interval
Number of records to process before committing state
{"default": 1000, "type": "integer"}
datahub_ingestion_schema.json
commit_with_parse_errors
Whether to update createdon timestamp and kafka offset despite parse errors. Enable if you want to ignore the errors.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
bigquery_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"}, "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": [{}]}, "rate_limit": {"default": false, "type": "boolean"}, "requests_per_min": {"default": 60, "type": "integer"}, "temp_table_dataset_prefix": {"default": "_", "type": "string"}, "sharded_table_pattern": {"default": "((.+)[_$])?(\\d{8})$", "deprecated": true, "type": "string"}, "project_id_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "usage": {"default": {"bucket_duration": "DAY", "end_time": "2023-08-15T22:02:13.573606+00:00", "start_time": "2023-08-14T00:00:00+00:00", "top_n_queries": 10, "user_email_pattern": {"allow": [".*"], "deny": [], "ignoreCase": true}, "include_operational_stats": true, "include_read_operational_stats": false, "format_sql_queries": false, "include_top_n_queries": true, "max_query_duration": 900.0, "apply_view_usage_to_tables": false}, "allOf": [{}]}, "include_usage_statistics": {"default": true, "type": "boolean"}, "capture_table_label_as_tag": {"default": false, "type": "boolean"}, "capture_dataset_label_as_tag": {"default": false, "type": "boolean"}, "dataset_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "match_fully_qualified_names": {"default": false, "type": "boolean"}, "include_external_url": {"default": true, "type": "boolean"}, "debug_include_full_payloads": {"default": false, "type": "boolean"}, "number_of_datasets_process_in_batch_if_profiling_enabled": {"default": 200, "type": "integer"}, "column_limit": {"default": 300, "type": "integer"}, "project_id": {"type": "string"}, "project_ids": {"type": "array", "items": {"type": "string"}}, "project_on_behalf": {"type": "string"}, "lineage_use_sql_parser": {"default": true, "type": "boolean"}, "lineage_parse_view_ddl": {"default": true, "type": "boolean"}, "lineage_sql_parser_use_raw_names": {"default": false, "type": "boolean"}, "extract_column_lineage": {"default": false, "type": "boolean"}, "extract_lineage_from_catalog": {"default": false, "type": "boolean"}, "convert_urns_to_lowercase": {"default": false, "type": "boolean"}, "enable_legacy_sharded_table_support": {"default": true, "type": "boolean"}, "scheme": {"default": "bigquery", "type": "string"}, "log_page_size": {"default": 1000, "exclusiveMinimum": 0, "type": "integer"}, "credential": {"allOf": [{}]}, "extra_client_options": {"default": {}, "type": "object"}, "include_table_lineage": {"default": true, "type": "boolean"}, "max_query_duration": {"default": 900.0, "type": "number", "format": "time-delta"}, "bigquery_audit_metadata_datasets": {"type": "array", "items": {"type": "string"}}, "use_exported_bigquery_audit_metadata": {"default": false, "type": "boolean"}, "use_date_sharded_audit_log_tables": {"default": false, "type": "boolean"}, "upstream_lineage_in_report": {"default": false, "type": "boolean"}}, "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
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
rate_limit
Should we rate limit requests made to API.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
requests_per_min
Used to control number of API calls made per min. Only used when `rate_limit` is set to `True`.
{"default": 60, "type": "integer"}
datahub_ingestion_schema.json
temp_table_dataset_prefix
If you are creating temp tables in a dataset with a particular prefix you can use this config to set the prefix for the dataset. This is to support workflows from before bigquery's introduction of temp tables. By default we use `_` because of datasets that begin with an underscore are hidden by default https://cloud.google.com/bigquery/docs/datasets#dataset-naming.
{"default": "_", "type": "string"}
datahub_ingestion_schema.json
sharded_table_pattern
The regex pattern to match sharded tables and group as one table. This is a very low level config parameter, only change if you know what you are doing,
{"default": "((.+)[_$])?(\\d{8})$", "deprecated": true, "type": "string"}
datahub_ingestion_schema.json
project_id_pattern
Regex patterns for project_id to filter in ingestion.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
usage
Usage related configs
{"default": {"bucket_duration": "DAY", "end_time": "2023-08-15T22:02:13.573606+00:00", "start_time": "2023-08-14T00:00:00+00:00", "top_n_queries": 10, "user_email_pattern": {"allow": [".*"], "deny": [], "ignoreCase": true}, "include_operational_stats": true, "include_read_operational_stats": false, "format_sql_queries": false, "include_top_n_queries": true, "max_query_duration": 900.0, "apply_view_usage_to_tables": false}, "allOf": [{}]}
datahub_ingestion_schema.json
include_usage_statistics
Generate usage statistic
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
capture_table_label_as_tag
Capture BigQuery table labels as DataHub tag
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
capture_dataset_label_as_tag
Capture BigQuery dataset labels as DataHub tag
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
dataset_pattern
Regex patterns for dataset 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
match_fully_qualified_names
Whether `dataset_pattern` is matched against fully qualified dataset name `<project_id>.<dataset_name>`.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
include_external_url
Whether to populate BigQuery Console url to Datasets/Tables
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
debug_include_full_payloads
Include full payload into events. It is only for debugging and internal use.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
number_of_datasets_process_in_batch_if_profiling_enabled
Number of partitioned table queried in batch when getting metadata. This is a low level config property which should be touched with care. This restriction is needed because we query partitions system view which throws error if we try to touch too many tables.
{"default": 200, "type": "integer"}
datahub_ingestion_schema.json
column_limit
Maximum number of columns to process in a table. This is a low level config property which should be touched with care. This restriction is needed because excessively wide tables can result in failure to ingest the schema.
{"default": 300, "type": "integer"}
datahub_ingestion_schema.json
project_id
[deprecated] Use project_id_pattern or project_ids instead.
{"type": "string"}
datahub_ingestion_schema.json
project_ids
Ingests specified project_ids. Use this property if you want to specify what projects to ingest or don't want to give project resourcemanager.projects.list to your service account. Overrides `project_id_pattern`.
{"type": "array", "items": {"type": "string"}}
datahub_ingestion_schema.json
project_on_behalf
[Advanced] The BigQuery project in which queries are executed. Will be passed when creating a job. If not passed, falls back to the project associated with the service account.
{"type": "string"}
datahub_ingestion_schema.json
lineage_use_sql_parser
Use sql parser to resolve view/table lineage.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
lineage_parse_view_ddl
Sql parse view ddl to get lineage.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
lineage_sql_parser_use_raw_names
This parameter ignores the lowercase pattern stipulated in the SQLParser. NOTE: Ignored if lineage_use_sql_parser is False.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
extract_column_lineage
If enabled, generate column level lineage. Requires lineage_use_sql_parser to be enabled. This and `incremental_lineage` cannot both be enabled.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
extract_lineage_from_catalog
This flag enables the data lineage extraction from Data Lineage API exposed by Google Data Catalog. NOTE: This extractor can't build views lineage. It's recommended to enable the view's DDL parsing. Read the docs to have more information about: https://cloud.google.com/data-catalog/docs/concepts/about-data-lineage
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
convert_urns_to_lowercase
Convert urns to lowercase.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
enable_legacy_sharded_table_support
Use the legacy sharded table urn suffix added.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
log_page_size
The number of log item will be queried per page for lineage collection
{"default": 1000, "exclusiveMinimum": 0, "type": "integer"}
datahub_ingestion_schema.json
credential
BigQuery credential informations
{"allOf": [{}]}
datahub_ingestion_schema.json
extra_client_options
Additional options to pass to google.cloud.logging_v2.client.Client.
{"default": {}, "type": "object"}
datahub_ingestion_schema.json
include_table_lineage
Option to enable/disable lineage generation. Is enabled by default.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
max_query_duration
Correction to pad start_time and end_time with. For handling the case where the read happens within our time range but the query completion event is delayed and happens after the configured end time.
{"default": 900.0, "type": "number", "format": "time-delta"}
datahub_ingestion_schema.json
bigquery_audit_metadata_datasets
A list of datasets that contain a table named cloudaudit_googleapis_com_data_access which contain BigQuery audit logs, specifically, those containing BigQueryAuditMetadata. It is recommended that the project of the dataset is also specified, for example, projectA.datasetB.
{"type": "array", "items": {"type": "string"}}
datahub_ingestion_schema.json
use_exported_bigquery_audit_metadata
When configured, use BigQueryAuditMetadata in bigquery_audit_metadata_datasets to compute lineage information.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
use_date_sharded_audit_log_tables
Whether to read date sharded tables or time partitioned tables when extracting usage from exported audit logs.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
upstream_lineage_in_report
Useful for debugging lineage information. Set to True to see the raw lineage created internally.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
okta_config
Base configuration class for stateful ingestion for source configs to inherit from.
{"type": "object", "properties": {"stateful_ingestion": {"allOf": [{}]}, "okta_domain": {"type": "string"}, "okta_api_token": {"type": "string"}, "ingest_users": {"default": true, "type": "boolean"}, "ingest_groups": {"default": true, "type": "boolean"}, "ingest_group_membership": {"default": true, "type": "boolean"}, "okta_profile_to_username_attr": {"default": "email", "type": "string"}, "okta_profile_to_username_regex": {"default": "(.*)", "type": "string"}, "okta_profile_to_group_name_attr": {"default": "name", "type": "string"}, "okta_profile_to_group_name_regex": {"default": "(.*)", "type": "string"}, "include_deprovisioned_users": {"default": false, "type": "boolean"}, "include_suspended_users": {"default": false, "type": "boolean"}, "page_size": {"default": 100, "type": "integer"}, "delay_seconds": {"default": 0.01, "anyOf": [{"type": "number"}, {"type": "integer"}]}, "okta_users_filter": {"type": "string"}, "okta_users_search": {"type": "string"}, "okta_groups_filter": {"type": "string"}, "okta_groups_search": {"type": "string"}, "mask_group_id": {"default": true, "type": "boolean"}, "mask_user_id": {"default": true, "type": "boolean"}}, "required": ["okta_domain", "okta_api_token"], "additionalProperties": false}
datahub_ingestion_schema.json
stateful_ingestion
Okta Stateful Ingestion Config.
{"allOf": [{}]}
datahub_ingestion_schema.json
okta_domain
The location of your Okta Domain, without a protocol. Can be found in Okta Developer console. e.g. dev-33231928.okta.com
{"type": "string"}
datahub_ingestion_schema.json
okta_api_token
An API token generated for the DataHub application inside your Okta Developer Console. e.g. 00be4R_M2MzDqXawbWgfKGpKee0kuEOfX1RCQSRx00
{"type": "string"}
datahub_ingestion_schema.json
ingest_users
Whether users should be ingested into DataHub.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
ingest_groups
Whether groups should be ingested into DataHub.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
ingest_group_membership
Whether group membership should be ingested into DataHub. ingest_groups must be True if this is True.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
okta_profile_to_username_attr
Which Okta User Profile attribute to use as input to DataHub username mapping. Common values used are - login, email.
{"default": "email", "type": "string"}
datahub_ingestion_schema.json
okta_profile_to_username_regex
A regex used to parse the DataHub username from the attribute specified in `okta_profile_to_username_attr`.
{"default": "(.*)", "type": "string"}
datahub_ingestion_schema.json
okta_profile_to_group_name_attr
Which Okta Group Profile attribute to use as input to DataHub group name mapping.
{"default": "name", "type": "string"}
datahub_ingestion_schema.json
okta_profile_to_group_name_regex
A regex used to parse the DataHub group name from the attribute specified in `okta_profile_to_group_name_attr`.
{"default": "(.*)", "type": "string"}
datahub_ingestion_schema.json
include_deprovisioned_users
Whether to ingest users in the DEPROVISIONED state from Okta.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
include_suspended_users
Whether to ingest users in the SUSPENDED state from Okta.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
page_size
The number of entities requested from Okta's REST APIs in one request.
{"default": 100, "type": "integer"}
datahub_ingestion_schema.json
delay_seconds
Number of seconds to wait between calls to Okta's REST APIs. (Okta rate limits). Defaults to 10ms.
{"default": 0.01, "anyOf": [{"type": "number"}, {"type": "integer"}]}
datahub_ingestion_schema.json
okta_users_filter
Okta filter expression (not regex) for ingesting users. Only one of `okta_users_filter` and `okta_users_search` can be set. See (https://developer.okta.com/docs/reference/api/users/#list-users-with-a-filter) for more info.
{"type": "string"}
datahub_ingestion_schema.json
okta_users_search
Okta search expression (not regex) for ingesting users. Only one of `okta_users_filter` and `okta_users_search` can be set. See (https://developer.okta.com/docs/reference/api/users/#list-users-with-search) for more info.
{"type": "string"}
datahub_ingestion_schema.json
okta_groups_filter
Okta filter expression (not regex) for ingesting groups. Only one of `okta_groups_filter` and `okta_groups_search` can be set. See (https://developer.okta.com/docs/reference/api/groups/#filters) for more info.
{"type": "string"}
datahub_ingestion_schema.json
okta_groups_search
Okta search expression (not regex) for ingesting groups. Only one of `okta_groups_filter` and `okta_groups_search` can be set. See (https://developer.okta.com/docs/reference/api/groups/#list-groups-with-search) for more info.
{"type": "string"}
datahub_ingestion_schema.json
lookml_config
Any source that is a primary producer of Dataset metadata should inherit this class
{"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "stateful_ingestion": {}, "platform_instance": {"type": "string"}, "explore_naming_pattern": {"default": {"pattern": "{model}.explore.{name}"}, "allOf": [{}]}, "explore_browse_pattern": {"default": {"pattern": "/{env}/{platform}/{project}/explores"}, "allOf": [{}]}, "view_naming_pattern": {"default": {"pattern": "{project}.view.{name}"}, "allOf": [{}]}, "view_browse_pattern": {"default": {"pattern": "/{env}/{platform}/{project}/views"}, "allOf": [{}]}, "tag_measures_and_dimensions": {"default": true, "type": "boolean"}, "platform_name": {"default": "looker", "type": "string"}, "extract_column_level_lineage": {"default": true, "type": "boolean"}, "git_info": {"allOf": [{}]}, "base_folder": {"format": "directory-path", "type": "string"}, "project_dependencies": {"default": {}, "type": "object", "additionalProperties": {"anyOf": [{"type": "string", "format": "directory-path"}, {}]}}, "connection_to_platform_map": {"type": "object", "additionalProperties": {}}, "model_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "view_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "parse_table_names_from_sql": {"default": false, "type": "boolean"}, "sql_parser": {"default": "datahub.utilities.sql_parser.DefaultSQLParser", "type": "string"}, "api": {}, "project_name": {"type": "string"}, "transport_options": {"allOf": [{}]}, "max_file_snippet_length": {"default": 512000, "type": "integer"}, "emit_reachable_views_only": {"default": true, "type": "boolean"}, "populate_sql_logic_for_missing_descriptions": {"default": false, "type": "boolean"}, "process_isolation_for_sql_parsing": {"default": false, "type": "boolean"}, "process_refinements": {"default": false, "type": "boolean"}}, "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
explore_naming_pattern
Pattern for providing dataset names to explores. Allowed variables are ['platform', 'env', 'project', 'model', 'name']
{"default": {"pattern": "{model}.explore.{name}"}, "allOf": [{}]}
datahub_ingestion_schema.json
explore_browse_pattern
Pattern for providing browse paths to explores. Allowed variables are ['platform', 'env', 'project', 'model', 'name']
{"default": {"pattern": "/{env}/{platform}/{project}/explores"}, "allOf": [{}]}
datahub_ingestion_schema.json
view_naming_pattern
Pattern for providing dataset names to views. Allowed variables are ['platform', 'env', 'project', 'model', 'name']
{"default": {"pattern": "{project}.view.{name}"}, "allOf": [{}]}
datahub_ingestion_schema.json
view_browse_pattern
Pattern for providing browse paths to views. Allowed variables are ['platform', 'env', 'project', 'model', 'name']
{"default": {"pattern": "/{env}/{platform}/{project}/views"}, "allOf": [{}]}
datahub_ingestion_schema.json
tag_measures_and_dimensions
When enabled, attaches tags to measures, dimensions and dimension groups to make them more discoverable. When disabled, adds this information to the description of the column.
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
platform_name
Default platform name. Don't change.
{"default": "looker", "type": "string"}
datahub_ingestion_schema.json
extract_column_level_lineage
When enabled, extracts column-level lineage from Views and Explores
{"default": true, "type": "boolean"}
datahub_ingestion_schema.json
git_info
Reference to your git location. If present, supplies handy links to your lookml on the dataset entity page.
{"allOf": [{}]}
datahub_ingestion_schema.json
base_folder
Required if not providing github configuration and deploy keys. A pointer to a local directory (accessible to the ingestion system) where the root of the LookML repo has been checked out (typically via a git clone). This is typically the root folder where the `*.model.lkml` and `*.view.lkml` files are stored. e.g. If you have checked out your LookML repo under `/Users/jdoe/workspace/my-lookml-repo`, then set `base_folder` to `/Users/jdoe/workspace/my-lookml-repo`.
{"format": "directory-path", "type": "string"}
datahub_ingestion_schema.json
project_dependencies
A map of project_name to local directory (accessible to the ingestion system) or Git credentials. Every local_dependencies or private remote_dependency listed in the main project's manifest.lkml file should have a corresponding entry here. If a deploy key is not provided, the ingestion system will use the same deploy key as the main project.
{"default": {}, "type": "object", "additionalProperties": {"anyOf": [{"type": "string", "format": "directory-path"}, {}]}}
datahub_ingestion_schema.json
connection_to_platform_map
A mapping of [Looker connection names](https://docs.looker.com/reference/model-params/connection-for-model) to DataHub platform, database, and schema values.
{"type": "object", "additionalProperties": {}}
datahub_ingestion_schema.json
model_pattern
List of regex patterns for LookML models to include in the extraction.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
view_pattern
List of regex patterns for LookML views to include in the extraction.
{"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}
datahub_ingestion_schema.json
parse_table_names_from_sql
See note below.
{"default": false, "type": "boolean"}
datahub_ingestion_schema.json
sql_parser
See note below.
{"default": "datahub.utilities.sql_parser.DefaultSQLParser", "type": "string"}
datahub_ingestion_schema.json
project_name
Required if you don't specify the `api` section. The project name within which all the model files live. See (https://docs.looker.com/data-modeling/getting-started/how-project-works) to understand what the Looker project name should be. The simplest way to see your projects is to click on `Develop` followed by `Manage LookML Projects` in the Looker application.
{"type": "string"}
datahub_ingestion_schema.json
transport_options
Populates the [TransportOptions](https://github.com/looker-open-source/sdk-codegen/blob/94d6047a0d52912ac082eb91616c1e7c379ab262/python/looker_sdk/rtl/transport.py#L70) struct for looker client
{"allOf": [{}]}