schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
datahub_ingestion_schema.json | include_table_lineage | Whether table lineage should be ingested. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | starburst-trino-usage_config | Base configuration class for stateful ingestion for source configs to inherit from. | {"type": "object", "properties": {"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"}, "env": {"default": "PROD", "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": {"type": "string", "writeOnly": true, "format": "password"}, "host_port": {"type": "string"}, "database": {"type": "string"}, "database_alias": {"type": "string"}, "sqlalchemy_uri": {"type": "string"}, "email_domain": {"type": "string"}, "audit_catalog": {"type": "string"}, "audit_schema": {"type": "string"}}, "required": ["host_port", "database", "email_domain", "audit_catalog", "audit_schema"], "additionalProperties": false} |
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 | 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 | 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 | The name of the catalog from getting the usage | {"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 | email_domain | The email domain which will be appended to the users | {"type": "string"} |
datahub_ingestion_schema.json | audit_catalog | The catalog name where the audit table can be found | {"type": "string"} |
datahub_ingestion_schema.json | audit_schema | The schema name where the audit table can be found | {"type": "string"} |
datahub_ingestion_schema.json | type | The type of the state provider to use. For DataHub use `datahub` | {"type": "string"} |
datahub_ingestion_schema.json | config | The configuration required for initializing the state provider. Default: The datahub_api config if set at pipeline level. Otherwise, the default DatahubClientConfig. See the defaults (https://github.com/datahub-project/datahub/blob/master/metadata-ingestion/src/datahub/ingestion/graph/client.py#L19). | {} |
datahub_ingestion_schema.json | StatefulStaleMetadataRemovalConfig | Base specialized config for Stateful Ingestion with stale metadata removal capability. | {"type": "object", "properties": {"enabled": {"default": false, "type": "boolean"}, "remove_stale_metadata": {"default": true, "type": "boolean"}}, "additionalProperties": false} |
datahub_ingestion_schema.json | enabled | The type of the ingestion state provider registered with datahub. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | remove_stale_metadata | Soft-deletes the entities present in the last successful run but missing in the current run with stateful_ingestion enabled. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | AllowDenyPattern | A class to store allow deny regexes | {"type": "object", "properties": {"allow": {"default": [".*"], "type": "array", "items": {"type": "string"}}, "deny": {"default": [], "type": "array", "items": {"type": "string"}}, "ignoreCase": {"default": true, "type": "boolean"}}, "additionalProperties": false} |
datahub_ingestion_schema.json | allow | List of regex patterns to include in ingestion | {"default": [".*"], "type": "array", "items": {"type": "string"}} |
datahub_ingestion_schema.json | deny | List of regex patterns to exclude from ingestion. | {"default": [], "type": "array", "items": {"type": "string"}} |
datahub_ingestion_schema.json | ignoreCase | Whether to ignore case sensitivity during pattern matching. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | lower_freq_profile_enabled | Whether to do profiling at lower freq or not. This does not do any scheduling just adds additional checks to when not to run profiling. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | profile_day_of_week | Number between 0 to 6 for day of week (both inclusive). 0 is Monday and 6 is Sunday. If not specified, defaults to Nothing and this field does not take affect. | {"type": "integer"} |
datahub_ingestion_schema.json | profile_date_of_month | Number between 1 to 31 for date of month (both inclusive). If not specified, defaults to Nothing and this field does not take affect. | {"type": "integer"} |
datahub_ingestion_schema.json | enabled | Whether profiling should be done. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | operation_config | Experimental feature. To specify operation configs. | {"allOf": [{}]} |
datahub_ingestion_schema.json | limit | Max number of documents to profile. By default, profiles all documents. | {"type": "integer"} |
datahub_ingestion_schema.json | offset | Offset in documents to profile. By default, uses no offset. | {"type": "integer"} |
datahub_ingestion_schema.json | report_dropped_profiles | Whether to report datasets or dataset columns which were not profiled. Set to `True` for debugging purposes. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | turn_off_expensive_profiling_metrics | Whether to turn off expensive profiling or not. This turns off profiling for quantiles, distinct_value_frequencies, histogram & sample_values. This also limits maximum number of fields being profiled to 10. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | profile_table_level_only | Whether to perform profiling at table-level only, or include column-level profiling as well. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | include_field_null_count | Whether to profile for the number of nulls for each column. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | include_field_distinct_count | Whether to profile for the number of distinct values for each column. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | include_field_min_value | Whether to profile for the min value of numeric columns. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | include_field_max_value | Whether to profile for the max value of numeric columns. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | include_field_mean_value | Whether to profile for the mean value of numeric columns. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | include_field_median_value | Whether to profile for the median value of numeric columns. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | include_field_stddev_value | Whether to profile for the standard deviation of numeric columns. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | include_field_quantiles | Whether to profile for the quantiles of numeric columns. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | include_field_distinct_value_frequencies | Whether to profile for distinct value frequencies. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | include_field_histogram | Whether to profile for the histogram for numeric fields. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | include_field_sample_values | Whether to profile for the sample values for all columns. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | field_sample_values_limit | Upper limit for number of sample values to collect for all columns. | {"default": 20, "type": "integer"} |
datahub_ingestion_schema.json | max_number_of_fields_to_profile | A positive integer that specifies the maximum number of columns to profile for any table. `None` implies all columns. The cost of profiling goes up significantly as the number of columns to profile goes up. | {"exclusiveMinimum": 0, "type": "integer"} |
datahub_ingestion_schema.json | profile_if_updated_since_days | Profile table only if it has been updated since these many number of days. If set to `null`, no constraint of last modified time for tables to profile. Supported only in `snowflake` and `BigQuery`. | {"exclusiveMinimum": 0, "type": "number"} |
datahub_ingestion_schema.json | profile_table_size_limit | Profile tables only if their size is less then specified GBs. If set to `null`, no limit on the size of tables to profile. Supported only in `snowflake` and `BigQuery` | {"default": 5, "type": "integer"} |
datahub_ingestion_schema.json | profile_table_row_limit | Profile tables only if their row count is less then specified count. If set to `null`, no limit on the row count of tables to profile. Supported only in `snowflake` and `BigQuery` | {"default": 5000000, "type": "integer"} |
datahub_ingestion_schema.json | profile_table_row_count_estimate_only | Use an approximate query for row count. This will be much faster but slightly less accurate. Only supported for Postgres and MySQL. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | max_workers | Number of worker threads to use for profiling. Set to 1 to disable. | {"default": 10, "type": "integer"} |
datahub_ingestion_schema.json | query_combiner_enabled | *This feature is still experimental and can be disabled if it causes issues.* Reduces the total number of queries issued and speeds up profiling by dynamically combining SQL queries where possible. | {"default": true, "type": "boolean"} |
datahub_ingestion_schema.json | partition_datetime | For partitioned datasets profile only the partition which matches the datetime or profile the latest one if not set. Only Bigquery supports this. | {"type": "string", "format": "date-time"} |
datahub_ingestion_schema.json | StatefulIngestionConfig | Basic Stateful Ingestion Specific Configuration for any source. | {"type": "object", "properties": {"enabled": {"default": false, "type": "boolean"}}, "additionalProperties": false} |
datahub_ingestion_schema.json | enabled | The type of the ingestion state provider registered with datahub. | {"default": false, "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 | MySQL host URL. | {"default": "localhost:3306", "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 | 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 | KafkaConsumerConnectionConfig | Configuration class for holding connectivity information for Kafka consumers | {"type": "object", "properties": {"bootstrap": {"default": "localhost:9092", "type": "string"}, "schema_registry_url": {"default": "http://localhost:8080/schema-registry/api/", "type": "string"}, "schema_registry_config": {"type": "object"}, "client_timeout_seconds": {"default": 60, "type": "integer"}, "consumer_config": {"type": "object"}}, "additionalProperties": false} |
datahub_ingestion_schema.json | schema_registry_config | Extra schema registry config serialized as JSON. These options will be passed into Kafka's SchemaRegistryClient. https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html?#schemaregistryclient | {"type": "object"} |
datahub_ingestion_schema.json | client_timeout_seconds | The request timeout used when interacting with the Kafka APIs. | {"default": 60, "type": "integer"} |
datahub_ingestion_schema.json | consumer_config | Extra consumer config serialized as JSON. These options will be passed into Kafka's DeserializingConsumer. See https://docs.confluent.io/platform/current/clients/confluent-kafka-python/html/index.html#deserializingconsumer and https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md . | {"type": "object"} |
datahub_ingestion_schema.json | BucketDuration | An enumeration. | {"enum": ["DAY", "HOUR"], "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 | 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 | apply_view_usage_to_tables | Whether to apply view's usage to its base tables. If set to False, uses sql parser and applies usage to views / tables mentioned in the query. If set to True, usage is applied to base tables only. | {"default": false, "type": "boolean"} |
datahub_ingestion_schema.json | project_id | Project id to set the credentials | {"type": "string"} |
datahub_ingestion_schema.json | private_key_id | Private key id | {"type": "string"} |
datahub_ingestion_schema.json | private_key | Private key in a form of '-----BEGIN PRIVATE KEY-----\nprivate-key\n-----END PRIVATE KEY-----\n' | {"type": "string"} |
datahub_ingestion_schema.json | client_email | Client email | {"type": "string"} |
datahub_ingestion_schema.json | client_id | Client Id | {"type": "string"} |
datahub_ingestion_schema.json | auth_uri | Authentication uri | {"default": "https://accounts.google.com/o/oauth2/auth", "type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.