DataHub

CLI based Ingestion

Install the Plugin

pip install 'acryl-datahub[datahub]'

Config Details

Options

Note that a . is used to denote nested fields in the YAML recipe.

Field	Description
commit_state_interval integer	Number of records to process before committing state Default: 1000
include_all_versions boolean	If enabled, include all versions of each aspect. Otherwise, only include the latest version of each aspect. Default: False
kafka_topic_name string	Name of kafka topic containing timeseries MCLs Default: MetadataChangeLog_Timeseries_v1
mysql_table_name string	Name of MySQL table containing all versioned aspects Default: metadata_aspect_v2
kafka_connection KafkaConsumerConnectionConfig	Kafka connection config Default: {'bootstrap': 'localhost:9092', 'schema_registry_u...
kafka_connection.bootstrap string	Default: localhost:9092
kafka_connection.client_timeout_seconds integer	The request timeout used when interacting with the Kafka APIs. Default: 60
kafka_connection.consumer_config object	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 .
kafka_connection.schema_registry_config object	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
kafka_connection.schema_registry_url string	Default: http://localhost:8080/schema-registry/api/
mysql_connection MySQLConfig	MySQL connection config Default: {'env': 'PROD', 'platform_instance': None, 'statef...
mysql_connection.database string	database (catalog)
mysql_connection.database_alias string	[Deprecated] Alias to apply to database when ingesting.
mysql_connection.host_port string	MySQL host URL. Default: localhost:3306
mysql_connection.include_table_location_lineage boolean	If the source supports it, include table lineage to the underlying storage location. Default: True
mysql_connection.include_tables boolean	Whether tables should be ingested. Default: True
mysql_connection.include_views boolean	Whether views should be ingested. Default: True
mysql_connection.options object	Any options specified here will be passed to SQLAlchemy.create_engine as kwargs.
mysql_connection.password string(password)	password
mysql_connection.platform_instance string	The instance of the platform that all assets produced by this recipe belong to
mysql_connection.scheme string	Default: mysql+pymysql
mysql_connection.sqlalchemy_uri string	URI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.
mysql_connection.username string	username
mysql_connection.env string	The environment that all assets produced by this connector belong to Default: PROD
mysql_connection.database_pattern AllowDenyPattern	Regex patterns for databases to filter in ingestion. Default: {'allow': ['.*'], 'deny': [], 'ignoreCase': True}
mysql_connection.database_pattern.allow array(string)
mysql_connection.database_pattern.deny array(string)
mysql_connection.database_pattern.ignoreCase boolean	Whether to ignore case sensitivity during pattern matching. Default: True
mysql_connection.domain map(str,AllowDenyPattern)	A class to store allow deny regexes
mysql_connection.domain.key.allow array(string)
mysql_connection.domain.key.deny array(string)
mysql_connection.domain.key.ignoreCase boolean	Whether to ignore case sensitivity during pattern matching. Default: True
mysql_connection.profile_pattern AllowDenyPattern	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}
mysql_connection.profile_pattern.allow array(string)
mysql_connection.profile_pattern.deny array(string)
mysql_connection.profile_pattern.ignoreCase boolean	Whether to ignore case sensitivity during pattern matching. Default: True
mysql_connection.schema_pattern AllowDenyPattern	Deprecated in favour of database_pattern. Default: {'allow': ['.*'], 'deny': [], 'ignoreCase': True}
mysql_connection.schema_pattern.allow array(string)
mysql_connection.schema_pattern.deny array(string)
mysql_connection.schema_pattern.ignoreCase boolean	Whether to ignore case sensitivity during pattern matching. Default: True
mysql_connection.table_pattern AllowDenyPattern	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}
mysql_connection.table_pattern.allow array(string)
mysql_connection.table_pattern.deny array(string)
mysql_connection.table_pattern.ignoreCase boolean	Whether to ignore case sensitivity during pattern matching. Default: True
mysql_connection.view_pattern AllowDenyPattern	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}
mysql_connection.view_pattern.allow array(string)
mysql_connection.view_pattern.deny array(string)
mysql_connection.view_pattern.ignoreCase boolean	Whether to ignore case sensitivity during pattern matching. Default: True
mysql_connection.profiling GEProfilingConfig	Default: {'enabled': False, 'limit': None, 'offset': None, ...
mysql_connection.profiling.catch_exceptions boolean	Default: True
mysql_connection.profiling.enabled boolean	Whether profiling should be done. Default: False
mysql_connection.profiling.field_sample_values_limit integer	Upper limit for number of sample values to collect for all columns. Default: 20
mysql_connection.profiling.include_field_distinct_count boolean	Whether to profile for the number of distinct values for each column. Default: True
mysql_connection.profiling.include_field_distinct_value_frequencies boolean	Whether to profile for distinct value frequencies. Default: False
mysql_connection.profiling.include_field_histogram boolean	Whether to profile for the histogram for numeric fields. Default: False
mysql_connection.profiling.include_field_max_value boolean	Whether to profile for the max value of numeric columns. Default: True
mysql_connection.profiling.include_field_mean_value boolean	Whether to profile for the mean value of numeric columns. Default: True
mysql_connection.profiling.include_field_median_value boolean	Whether to profile for the median value of numeric columns. Default: True
mysql_connection.profiling.include_field_min_value boolean	Whether to profile for the min value of numeric columns. Default: True
mysql_connection.profiling.include_field_null_count boolean	Whether to profile for the number of nulls for each column. Default: True
mysql_connection.profiling.include_field_quantiles boolean	Whether to profile for the quantiles of numeric columns. Default: False
mysql_connection.profiling.include_field_sample_values boolean	Whether to profile for the sample values for all columns. Default: True
mysql_connection.profiling.include_field_stddev_value boolean	Whether to profile for the standard deviation of numeric columns. Default: True
mysql_connection.profiling.limit integer	Max number of documents to profile. By default, profiles all documents.
mysql_connection.profiling.max_number_of_fields_to_profile integer	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.
mysql_connection.profiling.max_workers integer	Number of worker threads to use for profiling. Set to 1 to disable. Default: 20
mysql_connection.profiling.offset integer	Offset in documents to profile. By default, uses no offset.
mysql_connection.profiling.partition_datetime string(date-time)	For partitioned datasets profile only the partition which matches the datetime or profile the latest one if not set. Only Bigquery supports this.
mysql_connection.profiling.partition_profiling_enabled boolean	Default: True
mysql_connection.profiling.profile_if_updated_since_days number	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.
mysql_connection.profiling.profile_table_level_only boolean	Whether to perform profiling at table-level only, or include column-level profiling as well. Default: False
mysql_connection.profiling.profile_table_row_count_estimate_only boolean	Use an approximate query for row count. This will be much faster but slightly less accurate. Only supported for Postgres and MySQL. Default: False
mysql_connection.profiling.profile_table_row_limit integer	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
mysql_connection.profiling.profile_table_size_limit integer	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
mysql_connection.profiling.query_combiner_enabled boolean	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
mysql_connection.profiling.report_dropped_profiles boolean	Whether to report datasets or dataset columns which were not profiled. Set to True for debugging purposes. Default: False
mysql_connection.profiling.turn_off_expensive_profiling_metrics boolean	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
mysql_connection.stateful_ingestion StatefulStaleMetadataRemovalConfig	Base specialized config for Stateful Ingestion with stale metadata removal capability.
mysql_connection.stateful_ingestion.enabled boolean	The type of the ingestion state provider registered with datahub. Default: False
mysql_connection.stateful_ingestion.remove_stale_metadata boolean	Soft-deletes the entities present in the last successful run but missing in the current run with stateful_ingestion enabled. Default: True
stateful_ingestion StatefulIngestionConfig	Stateful Ingestion Config Default: {'enabled': True, 'max_checkpoint_state_size': 167...
stateful_ingestion.enabled boolean	The type of the ingestion state provider registered with datahub. Default: False

Schema

The JSONSchema for this configuration is inlined below.

{
  "title": "DataHubSourceConfig",
  "description": "Base configuration class for stateful ingestion for source configs to inherit from.",
  "type": "object",
  "properties": {
    "stateful_ingestion": {
      "title": "Stateful Ingestion",
      "description": "Stateful Ingestion Config",
      "default": {
        "enabled": true,
        "max_checkpoint_state_size": 16777216,
        "state_provider": {
          "type": "datahub",
          "config": null
        },
        "ignore_old_state": false,
        "ignore_new_state": false
      },
      "allOf": [
        {
          "$ref": "#/definitions/StatefulIngestionConfig"
        }
      ]
    },
    "mysql_connection": {
      "title": "Mysql Connection",
      "description": "MySQL connection config",
      "default": {
        "env": "PROD",
        "platform_instance": null,
        "stateful_ingestion": null,
        "options": {},
        "schema_pattern": {
          "allow": [
            ".*"
          ],
          "deny": [],
          "ignoreCase": true
        },
        "table_pattern": {
          "allow": [
            ".*"
          ],
          "deny": [],
          "ignoreCase": true
        },
        "view_pattern": {
          "allow": [
            ".*"
          ],
          "deny": [],
          "ignoreCase": true
        },
        "profile_pattern": {
          "allow": [
            ".*"
          ],
          "deny": [],
          "ignoreCase": true
        },
        "domain": {},
        "include_views": true,
        "include_tables": true,
        "include_table_location_lineage": true,
        "profiling": {
          "enabled": false,
          "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": 20,
          "query_combiner_enabled": true,
          "catch_exceptions": true,
          "partition_profiling_enabled": true,
          "partition_datetime": null
        },
        "username": "datahub",
        "host_port": "localhost:3306",
        "database": "datahub",
        "database_alias": null,
        "scheme": "mysql+pymysql",
        "sqlalchemy_uri": null,
        "database_pattern": {
          "allow": [
            ".*"
          ],
          "deny": [],
          "ignoreCase": true
        }
      },
      "allOf": [
        {
          "$ref": "#/definitions/MySQLConfig"
        }
      ]
    },
    "kafka_connection": {
      "title": "Kafka Connection",
      "description": "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": [
        {
          "$ref": "#/definitions/KafkaConsumerConnectionConfig"
        }
      ]
    },
    "include_all_versions": {
      "title": "Include All Versions",
      "description": "If enabled, include all versions of each aspect. Otherwise, only include the latest version of each aspect.",
      "default": false,
      "type": "boolean"
    },
    "mysql_table_name": {
      "title": "Mysql Table Name",
      "description": "Name of MySQL table containing all versioned aspects",
      "default": "metadata_aspect_v2",
      "type": "string"
    },
    "kafka_topic_name": {
      "title": "Kafka Topic Name",
      "description": "Name of kafka topic containing timeseries MCLs",
      "default": "MetadataChangeLog_Timeseries_v1",
      "type": "string"
    },
    "commit_state_interval": {
      "title": "Commit State Interval",
      "description": "Number of records to process before committing state",
      "default": 1000,
      "type": "integer"
    }
  },
  "definitions": {
    "DynamicTypedStateProviderConfig": {
      "title": "DynamicTypedStateProviderConfig",
      "type": "object",
      "properties": {
        "type": {
          "title": "Type",
          "description": "The type of the state provider to use. For DataHub use `datahub`",
          "type": "string"
        },
        "config": {
          "title": "Config",
          "description": "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)."
        }
      },
      "required": [
        "type"
      ],
      "additionalProperties": false
    },
    "StatefulIngestionConfig": {
      "title": "StatefulIngestionConfig",
      "description": "Basic Stateful Ingestion Specific Configuration for any source.",
      "type": "object",
      "properties": {
        "enabled": {
          "title": "Enabled",
          "description": "The type of the ingestion state provider registered with datahub.",
          "default": false,
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "StatefulStaleMetadataRemovalConfig": {
      "title": "StatefulStaleMetadataRemovalConfig",
      "description": "Base specialized config for Stateful Ingestion with stale metadata removal capability.",
      "type": "object",
      "properties": {
        "enabled": {
          "title": "Enabled",
          "description": "The type of the ingestion state provider registered with datahub.",
          "default": false,
          "type": "boolean"
        },
        "remove_stale_metadata": {
          "title": "Remove Stale Metadata",
          "description": "Soft-deletes the entities present in the last successful run but missing in the current run with stateful_ingestion enabled.",
          "default": true,
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "AllowDenyPattern": {
      "title": "AllowDenyPattern",
      "description": "A class to store allow deny regexes",
      "type": "object",
      "properties": {
        "allow": {
          "title": "Allow",
          "description": "List of regex patterns to include in ingestion",
          "default": [
            ".*"
          ],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "deny": {
          "title": "Deny",
          "description": "List of regex patterns to exclude from ingestion.",
          "default": [],
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "ignoreCase": {
          "title": "Ignorecase",
          "description": "Whether to ignore case sensitivity during pattern matching.",
          "default": true,
          "type": "boolean"
        }
      },
      "additionalProperties": false
    },
    "GEProfilingConfig": {
      "title": "GEProfilingConfig",
      "type": "object",
      "properties": {
        "enabled": {
          "title": "Enabled",
          "description": "Whether profiling should be done.",
          "default": false,
          "type": "boolean"
        },
        "limit": {
          "title": "Limit",
          "description": "Max number of documents to profile. By default, profiles all documents.",
          "type": "integer"
        },
        "offset": {
          "title": "Offset",
          "description": "Offset in documents to profile. By default, uses no offset.",
          "type": "integer"
        },
        "report_dropped_profiles": {
          "title": "Report Dropped Profiles",
          "description": "Whether to report datasets or dataset columns which were not profiled. Set to `True` for debugging purposes.",
          "default": false,
          "type": "boolean"
        },
        "turn_off_expensive_profiling_metrics": {
          "title": "Turn Off Expensive Profiling Metrics",
          "description": "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"
        },
        "profile_table_level_only": {
          "title": "Profile Table Level Only",
          "description": "Whether to perform profiling at table-level only, or include column-level profiling as well.",
          "default": false,
          "type": "boolean"
        },
        "include_field_null_count": {
          "title": "Include Field Null Count",
          "description": "Whether to profile for the number of nulls for each column.",
          "default": true,
          "type": "boolean"
        },
        "include_field_distinct_count": {
          "title": "Include Field Distinct Count",
          "description": "Whether to profile for the number of distinct values for each column.",
          "default": true,
          "type": "boolean"
        },
        "include_field_min_value": {
          "title": "Include Field Min Value",
          "description": "Whether to profile for the min value of numeric columns.",
          "default": true,
          "type": "boolean"
        },
        "include_field_max_value": {
          "title": "Include Field Max Value",
          "description": "Whether to profile for the max value of numeric columns.",
          "default": true,
          "type": "boolean"
        },
        "include_field_mean_value": {
          "title": "Include Field Mean Value",
          "description": "Whether to profile for the mean value of numeric columns.",
          "default": true,
          "type": "boolean"
        },
        "include_field_median_value": {
          "title": "Include Field Median Value",
          "description": "Whether to profile for the median value of numeric columns.",
          "default": true,
          "type": "boolean"
        },
        "include_field_stddev_value": {
          "title": "Include Field Stddev Value",
          "description": "Whether to profile for the standard deviation of numeric columns.",
          "default": true,
          "type": "boolean"
        },
        "include_field_quantiles": {
          "title": "Include Field Quantiles",
          "description": "Whether to profile for the quantiles of numeric columns.",
          "default": false,
          "type": "boolean"
        },
        "include_field_distinct_value_frequencies": {
          "title": "Include Field Distinct Value Frequencies",
          "description": "Whether to profile for distinct value frequencies.",
          "default": false,
          "type": "boolean"
        },
        "include_field_histogram": {
          "title": "Include Field Histogram",
          "description": "Whether to profile for the histogram for numeric fields.",
          "default": false,
          "type": "boolean"
        },
        "include_field_sample_values": {
          "title": "Include Field Sample Values",
          "description": "Whether to profile for the sample values for all columns.",
          "default": true,
          "type": "boolean"
        },
        "field_sample_values_limit": {
          "title": "Field Sample Values Limit",
          "description": "Upper limit for number of sample values to collect for all columns.",
          "default": 20,
          "type": "integer"
        },
        "max_number_of_fields_to_profile": {
          "title": "Max Number Of Fields To Profile",
          "description": "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"
        },
        "profile_if_updated_since_days": {
          "title": "Profile If Updated Since Days",
          "description": "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"
        },
        "profile_table_size_limit": {
          "title": "Profile Table Size Limit",
          "description": "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"
        },
        "profile_table_row_limit": {
          "title": "Profile Table Row Limit",
          "description": "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"
        },
        "profile_table_row_count_estimate_only": {
          "title": "Profile Table Row Count Estimate Only",
          "description": "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"
        },
        "max_workers": {
          "title": "Max Workers",
          "description": "Number of worker threads to use for profiling. Set to 1 to disable.",
          "default": 20,
          "type": "integer"
        },
        "query_combiner_enabled": {
          "title": "Query Combiner Enabled",
          "description": "*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"
        },
        "catch_exceptions": {
          "title": "Catch Exceptions",
          "default": true,
          "type": "boolean"
        },
        "partition_profiling_enabled": {
          "title": "Partition Profiling Enabled",
          "default": true,
          "type": "boolean"
        },
        "partition_datetime": {
          "title": "Partition Datetime",
          "description": "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"
        }
      },
      "additionalProperties": false
    },
    "MySQLConfig": {
      "title": "MySQLConfig",
      "description": "Base configuration class for stateful ingestion for source configs to inherit from.",
      "type": "object",
      "properties": {
        "env": {
          "title": "Env",
          "description": "The environment that all assets produced by this connector belong to",
          "default": "PROD",
          "type": "string"
        },
        "platform_instance": {
          "title": "Platform Instance",
          "description": "The instance of the platform that all assets produced by this recipe belong to",
          "type": "string"
        },
        "stateful_ingestion": {
          "$ref": "#/definitions/StatefulStaleMetadataRemovalConfig"
        },
        "options": {
          "title": "Options",
          "description": "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"
        },
        "schema_pattern": {
          "title": "Schema Pattern",
          "description": "Deprecated in favour of database_pattern.",
          "default": {
            "allow": [
              ".*"
            ],
            "deny": [],
            "ignoreCase": true
          },
          "allOf": [
            {
              "$ref": "#/definitions/AllowDenyPattern"
            }
          ]
        },
        "table_pattern": {
          "title": "Table Pattern",
          "description": "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": [
            {
              "$ref": "#/definitions/AllowDenyPattern"
            }
          ]
        },
        "view_pattern": {
          "title": "View Pattern",
          "description": "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": [
            {
              "$ref": "#/definitions/AllowDenyPattern"
            }
          ]
        },
        "profile_pattern": {
          "title": "Profile Pattern",
          "description": "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": [
            {
              "$ref": "#/definitions/AllowDenyPattern"
            }
          ]
        },
        "domain": {
          "title": "Domain",
          "description": "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": {
            "$ref": "#/definitions/AllowDenyPattern"
          }
        },
        "include_views": {
          "title": "Include Views",
          "description": "Whether views should be ingested.",
          "default": true,
          "type": "boolean"
        },
        "include_tables": {
          "title": "Include Tables",
          "description": "Whether tables should be ingested.",
          "default": true,
          "type": "boolean"
        },
        "include_table_location_lineage": {
          "title": "Include Table Location Lineage",
          "description": "If the source supports it, include table lineage to the underlying storage location.",
          "default": true,
          "type": "boolean"
        },
        "profiling": {
          "title": "Profiling",
          "default": {
            "enabled": false,
            "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": 20,
            "query_combiner_enabled": true,
            "catch_exceptions": true,
            "partition_profiling_enabled": true,
            "partition_datetime": null
          },
          "allOf": [
            {
              "$ref": "#/definitions/GEProfilingConfig"
            }
          ]
        },
        "username": {
          "title": "Username",
          "description": "username",
          "type": "string"
        },
        "password": {
          "title": "Password",
          "description": "password",
          "type": "string",
          "writeOnly": true,
          "format": "password"
        },
        "host_port": {
          "title": "Host Port",
          "description": "MySQL host URL.",
          "default": "localhost:3306",
          "type": "string"
        },
        "database": {
          "title": "Database",
          "description": "database (catalog)",
          "type": "string"
        },
        "database_alias": {
          "title": "Database Alias",
          "description": "[Deprecated] Alias to apply to database when ingesting.",
          "type": "string"
        },
        "scheme": {
          "title": "Scheme",
          "default": "mysql+pymysql",
          "type": "string"
        },
        "sqlalchemy_uri": {
          "title": "Sqlalchemy Uri",
          "description": "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"
        },
        "database_pattern": {
          "title": "Database Pattern",
          "description": "Regex patterns for databases to filter in ingestion.",
          "default": {
            "allow": [
              ".*"
            ],
            "deny": [],
            "ignoreCase": true
          },
          "allOf": [
            {
              "$ref": "#/definitions/AllowDenyPattern"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "KafkaConsumerConnectionConfig": {
      "title": "KafkaConsumerConnectionConfig",
      "description": "Configuration class for holding connectivity information for Kafka consumers",
      "type": "object",
      "properties": {
        "bootstrap": {
          "title": "Bootstrap",
          "default": "localhost:9092",
          "type": "string"
        },
        "schema_registry_url": {
          "title": "Schema Registry Url",
          "default": "http://localhost:8080/schema-registry/api/",
          "type": "string"
        },
        "schema_registry_config": {
          "title": "Schema Registry Config",
          "description": "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"
        },
        "client_timeout_seconds": {
          "title": "Client Timeout Seconds",
          "description": "The request timeout used when interacting with the Kafka APIs.",
          "default": 60,
          "type": "integer"
        },
        "consumer_config": {
          "title": "Consumer Config",
          "description": "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"
        }
      },
      "additionalProperties": false
    }
  }
}

Code Coordinates

• Class Name: datahub.ingestion.source.datahub.datahub_source.DataHubSource
• Browse on GitHub

Questions

If you've got any questions on configuring ingestion for DataHub, feel free to ping us on our Slack.