schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
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 | ingest_groups_users | This option is useful only when `ingest_users` is set to False and `ingest_group_membership` to True. As effect, only the users which belongs to the selected groups will be ingested. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | users_pattern | regex patterns for users to filter in ingestion. | {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]} |
datahub_ingestion_schema.json | groups_pattern | regex patterns for groups to include in ingestion. | {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]} |
datahub_ingestion_schema.json | filtered_tracking | If enabled, report will contain names of filtered users and groups. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | mask_group_id | Whether workunit ID's for groups should be masked to avoid leaking sensitive information. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | mask_user_id | Whether workunit ID's for users should be masked to avoid leaking sensitive information. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | kafka_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": {}, "connection": {"default": {"bootstrap": "localhost:9092", "schema_registry_url": "http://localhost:8080/schema-registry/api/", "schema_registry_config": {}, "client_timeout_seconds": 60, "consumer_config": {}}, "allOf": [{}]}, "topic_patterns": {"default": {"allow": [".*"], "deny": ["^_.*"], "ignoreCase": true}, "allOf": [{}]}, "domain": {"default": {}, "type": "object", "additionalProperties": {}}, "topic_subject_map": {"default": {}, "type": "object", "additionalProperties": {"type": "string"}}, "schema_registry_class": {"default": "datahub.ingestion.source.confluent_schema_registry.ConfluentSchemaRegistry", "type": "string"}, "ignore_warnings_on_schema_type": {"default": false, "type": "boolean"}, "disable_topic_record_naming_strategy": {"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 | domain | A map of domain names to allow deny patterns. Domains can be urn-based (`urn:li:domain:13ae4d85-d955-49fc-8474-9004c663a810`) or bare (`13ae4d85-d955-49fc-8474-9004c663a810`). | {"default": {}, "type": "object", "additionalProperties": {}} |
datahub_ingestion_schema.json | topic_subject_map | Provides the mapping for the `key` and the `value` schemas of a topic to the corresponding schema registry subject name. Each entry of this map has the form `<topic_name>-key`:`<schema_registry_subject_name_for_key_schema>` and `<topic_name>-value`:`<schema_registry_subject_name_for_value_schema>` for the key and the value schemas associated with the topic, respectively. This parameter is mandatory when the [RecordNameStrategy](https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#how-the-naming-strategies-work) is used as the subject naming strategy in the kafka schema registry. NOTE: When provided, this overrides the default subject name resolution even when the `TopicNameStrategy` or the `TopicRecordNameStrategy` are used. | {"default": {}, "type": "object", "additionalProperties": {"type": "string"}} |
datahub_ingestion_schema.json | schema_registry_class | The fully qualified implementation class(custom) that implements the KafkaSchemaRegistryBase interface. | {"default": "datahub.ingestion.source.confluent_schema_registry.ConfluentSchemaRegistry", "type": "string"} |
datahub_ingestion_schema.json | ignore_warnings_on_schema_type | Disables warnings reported for non-AVRO/Protobuf value or key schemas if set. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | disable_topic_record_naming_strategy | Disables the utilization of the TopicRecordNameStrategy for Schema Registry subjects. For more information, visit: https://docs.confluent.io/platform/current/schema-registry/serdes-develop/index.html#handling-differences-between-preregistered-and-client-derived-schemas:~:text=io.confluent.kafka.serializers.subject.TopicRecordNameStrategy | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | file | File path or URL to lineage file to ingest. | {"type": "string"} |
datahub_ingestion_schema.json | preserve_upstream | Whether we want to query datahub-gms for upstream data. False means it will hard replace upstream data for a given entity. True means it will query the backend for existing upstreams and include it in the ingestion run | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | postgres_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": ["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"}, "scheme": {"default": "postgresql+psycopg2", "type": "string"}, "sqlalchemy_uri": {"type": "string"}, "database_pattern": {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]}, "initial_database": {"default": "postgres", "type": "string"}, "include_view_lineage": {"default": false, "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 | 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). If set to Null, all databases will be considered for ingestion. | {"type": "string"} |
datahub_ingestion_schema.json | database_alias | [Deprecated] Alias to apply to database when ingesting. | {"type": "string"} |
datahub_ingestion_schema.json | scheme | database scheme | {"default": "postgresql+psycopg2", "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. Note: this is not used if `database` or `sqlalchemy_uri` are provided. | {"default": {"allow": [".*"], "deny": [], "ignoreCase": true}, "allOf": [{}]} |
datahub_ingestion_schema.json | initial_database | Initial database used to query for the list of databases, when ingesting multiple databases. Note: this is not used if `database` or `sqlalchemy_uri` are provided. | {"default": "postgres", "type": "string"} |
datahub_ingestion_schema.json | include_view_lineage | Include table lineage for views | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | gcs_config | Base configuration class for stateful ingestion for source configs to inherit from. | {"type": "object", "properties": {"path_specs": {"type": "array", "items": {}}, "env": {"default": "PROD", "type": "string"}, "platform_instance": {"type": "string"}, "stateful_ingestion": {}, "credential": {"allOf": [{}]}, "max_rows": {"default": 100, "type": "integer"}, "number_of_files_to_sample": {"default": 100, "type": "integer"}}, "required": ["path_specs", "credential"], "additionalProperties": false} |
datahub_ingestion_schema.json | path_specs | List of PathSpec. See [below](#path-spec) the details about PathSpec | {"type": "array", "items": {}} |
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 | credential | Google cloud storage [HMAC keys](https://cloud.google.com/storage/docs/authentication/hmackeys) | {"allOf": [{}]} |
datahub_ingestion_schema.json | max_rows | Maximum number of rows to use when inferring schemas for TSV and CSV files. | {"default": 100, "type": "integer"} |
datahub_ingestion_schema.json | number_of_files_to_sample | Number of files to list to sample for schema inference. This will be ignored if sample_files is set to False in the pathspec. | {"default": 100, "type": "integer"} |
datahub_ingestion_schema.json | filename | File path or URL of CSV file to ingest. | {"type": "string"} |
datahub_ingestion_schema.json | write_semantics | Whether the new tags, terms and owners to be added will override the existing ones added only by this source or not. Value for this config can be "PATCH" or "OVERRIDE" | {"default": "PATCH", "type": "string"} |
datahub_ingestion_schema.json | delimiter | Delimiter to use when parsing CSV | {"default": ",", "type": "string"} |
datahub_ingestion_schema.json | array_delimiter | Delimiter to use when parsing array fields (tags, terms and owners) | {"default": "|", "type": "string"} |
datahub_ingestion_schema.json | metabase_config | Any non-Dataset source that produces lineage to Datasets should inherit this class.
e.g. Orchestrators, Pipelines, BI Tools etc. | {"type": "object", "properties": {"env": {"default": "PROD", "type": "string"}, "platform_instance_map": {"type": "object", "additionalProperties": {"type": "string"}}, "connect_uri": {"default": "localhost:3000", "type": "string"}, "username": {"type": "string"}, "password": {"type": "string", "writeOnly": true, "format": "password"}, "database_alias_map": {"type": "object"}, "engine_platform_map": {"type": "object", "additionalProperties": {"type": "string"}}, "database_id_to_instance_map": {"type": "object", "additionalProperties": {"type": "string"}}, "default_schema": {"default": "public", "type": "string"}}, "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 | A holder for platform -> platform_instance mappings to generate correct dataset urns | {"type": "object", "additionalProperties": {"type": "string"}} |
datahub_ingestion_schema.json | connect_uri | Metabase host URL. | {"default": "localhost:3000", "type": "string"} |
datahub_ingestion_schema.json | username | Metabase username. | {"type": "string"} |
datahub_ingestion_schema.json | password | Metabase password. | {"type": "string", "writeOnly": true, "format": "password"} |
datahub_ingestion_schema.json | database_alias_map | Database name map to use when constructing dataset URN. | {"type": "object"} |
datahub_ingestion_schema.json | engine_platform_map | Custom mappings between metabase database engines and DataHub platforms | {"type": "object", "additionalProperties": {"type": "string"}} |
datahub_ingestion_schema.json | database_id_to_instance_map | Custom mappings between metabase database id and DataHub platform instance | {"type": "object", "additionalProperties": {"type": "string"}} |
datahub_ingestion_schema.json | default_schema | Default schema name to use when schema is not provided in an SQL query | {"default": "public", "type": "string"} |
datahub_ingestion_schema.json | athena_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": false, "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": "awsathena+rest", "type": "string"}, "username": {"type": "string"}, "password": {"type": "string", "writeOnly": true, "format": "password"}, "database": {"type": "string"}, "aws_region": {"type": "string"}, "aws_role_arn": {"type": "string"}, "aws_role_assumption_duration": {"default": 3600, "type": "integer"}, "s3_staging_dir": {"deprecated": true, "type": "string"}, "work_group": {"type": "string"}, "catalog_name": {"default": "awsdatacatalog", "type": "string"}, "query_result_location": {"type": "string"}}, "required": ["aws_region", "work_group", "query_result_location"], "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": false, "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 credential. If not specified, detected with boto3 rules. See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html | {"type": "string"} |
datahub_ingestion_schema.json | password | Same detection scheme as username | {"type": "string", "writeOnly": true, "format": "password"} |
datahub_ingestion_schema.json | database | The athena database to ingest from. If not set it will be autodetected | {"type": "string"} |
datahub_ingestion_schema.json | aws_region | Aws region where your Athena database is located | {"type": "string"} |
datahub_ingestion_schema.json | aws_role_arn | AWS Role arn for Pyathena to assume in its connection | {"type": "string"} |
datahub_ingestion_schema.json | aws_role_assumption_duration | Duration to assume the AWS Role for. Maximum of 43200 (12 hours) | {"default": 3600, "type": "integer"} |
datahub_ingestion_schema.json | s3_staging_dir | [deprecated in favor of `query_result_location`] S3 query location | {"deprecated": true, "type": "string"} |
datahub_ingestion_schema.json | work_group | The name of your Amazon Athena Workgroups | {"type": "string"} |
datahub_ingestion_schema.json | catalog_name | Athena Catalog Name | {"default": "awsdatacatalog", "type": "string"} |
datahub_ingestion_schema.json | query_result_location | S3 path to the [query result bucket](https://docs.aws.amazon.com/athena/latest/ug/querying.html#query-results-specify-location) which should be used by AWS Athena to store results of thequeries executed by DataHub. | {"type": "string"} |
datahub_ingestion_schema.json | trino_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"}, "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. 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"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.