Skip to main content

Presto on Hive

Module presto-on-hive

Certified

Important Capabilities

CapabilityStatusNotes
Data ProfilingOptionally enabled via configuration
Detect Deleted EntitiesEnabled via stateful ingestion

This plugin extracts the following:

  • Metadata for Presto views and Hive tables (external / managed)
  • Column types associated with each table / view
  • Detailed table / view property info

CLI based Ingestion

Install the Plugin

pip install 'acryl-datahub[presto-on-hive]'

Starter Recipe

Check out the following recipe to get started with ingestion! See below for full configuration options.

For general pointers on writing and running a recipe, see our main recipe guide.

source:
type: presto-on-hive
config:
# Hive metastore DB connection
host_port: localhost:5432
database: metastore

# specify the schema where metastore tables reside
schema_pattern:
allow:
- "^public"

# credentials
username: user # optional
password: pass # optional

#scheme: 'postgresql+psycopg2' # set this if metastore db is using postgres
#scheme: 'mysql+pymysql' # set this if metastore db is using mysql, default if unset

# set this to have advanced filters on what to ingest
#views_where_clause_suffix: AND d."name" in ('db1')
#tables_where_clause_suffix: AND d."name" in ('db1')

sink:
# sink configs

Config Details

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

View All Configuration Options
FieldRequiredTypeDescriptionDefault
envstringThe environment that all assets produced by this connector belong toPROD
platformstringThe platform that this source connects toNone
platform_instancestringThe instance of the platform that all assets produced by this recipe belong toNone
optionsDict{}
include_viewsbooleanWhether views should be ingested.True
include_tablesbooleanWhether tables should be ingested.True
usernamestringusernameNone
passwordstringpasswordNone
host_portstringHost URL and port to connect to. Example: localhost:3306localhost:3306
databasestringdatabase (catalog)None
database_aliasstringAlias to apply to database when ingesting.None
sqlalchemy_uristringURI of database to connect to. See https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls. Takes precedence over other connection parameters.None
views_where_clause_suffixstringWhere clause to specify what Presto views should be ingested.
tables_where_clause_suffixstringWhere clause to specify what Hive tables should be ingested.
schemas_where_clause_suffixstringWhere clause to specify what Hive schemas should be ingested.
ingestion_job_idstring
metastore_db_namestringName of the Hive metastore's database (usually: metastore). For backward compatibility, if this field is not provided, the database field will be used. If both the 'database' and 'metastore_db_name' fields are set then the 'database' field will be used to filter the hive/presto/trino databaseNone
modeenum(PrestoOnHiveConfigMode)The ingested data will be stored under this platform. Valid options: ['hive', 'presto', 'presto-on-hive', 'trino']presto-on-hive
use_catalog_subtypebooleanContainer Subtype name to be 'Database' or 'Catalog' Valid options: ['True', 'False']True
use_dataset_pascalcase_subtypebooleanDataset Subtype name to be 'Table' or 'View' Valid options: ['True', 'False']False
include_catalog_name_in_idsbooleanAdd the Presto catalog name (e.g. hive) to the generated dataset urns. urn:li:dataset:(urn:li:dataPlatform:hive,hive.user.logging_events,PROD) versus urn:li:dataset:(urn:li:dataPlatform:hive,user.logging_events,PROD)False
stateful_ingestionStatefulStaleMetadataRemovalConfig (see below for fields)
stateful_ingestion.enabledbooleanThe type of the ingestion state provider registered with datahub.False
stateful_ingestion.ignore_old_statebooleanIf set to True, ignores the previous checkpoint state.False
stateful_ingestion.ignore_new_statebooleanIf set to True, ignores the current checkpoint state.False
stateful_ingestion.remove_stale_metadatabooleanSoft-deletes the entities present in the last successful run but missing in the current run with stateful_ingestion enabled.True
schema_patternAllowDenyPattern (see below for fields)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'{'allow': ['.*'], 'deny': [], 'ignoreCase': True}
schema_pattern.allowArray of stringList of regex patterns to include in ingestion['.*']
schema_pattern.denyArray of stringList of regex patterns to exclude from ingestion.[]
schema_pattern.ignoreCasebooleanWhether to ignore case sensitivity during pattern matching.True
table_patternAllowDenyPattern (see below for fields)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.*'{'allow': ['.*'], 'deny': [], 'ignoreCase': True}
table_pattern.allowArray of stringList of regex patterns to include in ingestion['.*']
table_pattern.denyArray of stringList of regex patterns to exclude from ingestion.[]
table_pattern.ignoreCasebooleanWhether to ignore case sensitivity during pattern matching.True
view_patternAllowDenyPattern (see below for fields)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.*'{'allow': ['.*'], 'deny': [], 'ignoreCase': True}
view_pattern.allowArray of stringList of regex patterns to include in ingestion['.*']
view_pattern.denyArray of stringList of regex patterns to exclude from ingestion.[]
view_pattern.ignoreCasebooleanWhether to ignore case sensitivity during pattern matching.True
profile_patternAllowDenyPattern (see below for fields)Regex patterns to filter tables for profiling during ingestion. Allowed by the table_pattern.{'allow': ['.*'], 'deny': [], 'ignoreCase': True}
profile_pattern.allowArray of stringList of regex patterns to include in ingestion['.*']
profile_pattern.denyArray of stringList of regex patterns to exclude from ingestion.[]
profile_pattern.ignoreCasebooleanWhether to ignore case sensitivity during pattern matching.True
domainDict[str, AllowDenyPattern]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.{}
domain.key.allowArray of stringList of regex patterns to include in ingestion['.*']
domain.key.denyArray of stringList of regex patterns to exclude from ingestion.[]
domain.key.ignoreCasebooleanWhether to ignore case sensitivity during pattern matching.True
profilingGEProfilingConfig (see below for fields){'enabled': False, 'limit': None, 'offset': None, '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, 'max_number_of_fields_to_profile': None, 'profile_if_updated_since_days': 1, 'profile_table_size_limit': 1, 'profile_table_row_limit': 50000, 'max_workers': 10, 'query_combiner_enabled': True, 'catch_exceptions': True, 'partition_profiling_enabled': True, 'partition_datetime': None}
profiling.enabledbooleanWhether profiling should be done.False
profiling.limitintegerMax number of documents to profile. By default, profiles all documents.None
profiling.offsetintegerOffset in documents to profile. By default, uses no offset.None
profiling.report_dropped_profilesbooleanWhether to report datasets or dataset columns which were not profiled. Set to True for debugging purposes.False
profiling.turn_off_expensive_profiling_metricsbooleanWhether 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.False
profiling.profile_table_level_onlybooleanWhether to perform profiling at table-level only, or include column-level profiling as well.False
profiling.include_field_null_countbooleanWhether to profile for the number of nulls for each column.True
profiling.include_field_distinct_countbooleanWhether to profile for the number of distinct values for each column.True
profiling.include_field_min_valuebooleanWhether to profile for the min value of numeric columns.True
profiling.include_field_max_valuebooleanWhether to profile for the max value of numeric columns.True
profiling.include_field_mean_valuebooleanWhether to profile for the mean value of numeric columns.True
profiling.include_field_median_valuebooleanWhether to profile for the median value of numeric columns.True
profiling.include_field_stddev_valuebooleanWhether to profile for the standard deviation of numeric columns.True
profiling.include_field_quantilesbooleanWhether to profile for the quantiles of numeric columns.False
profiling.include_field_distinct_value_frequenciesbooleanWhether to profile for distinct value frequencies.False
profiling.include_field_histogrambooleanWhether to profile for the histogram for numeric fields.False
profiling.include_field_sample_valuesbooleanWhether to profile for the sample values for all columns.True
profiling.max_number_of_fields_to_profileintegerA 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.None
profiling.profile_if_updated_since_daysnumberProfile 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.1
profiling.profile_table_size_limitintegerProfile 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 BigQuery1
profiling.profile_table_row_limitintegerProfile 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 BigQuery50000
profiling.max_workersintegerNumber of worker threads to use for profiling. Set to 1 to disable.10
profiling.query_combiner_enabledbooleanThis 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.True
profiling.catch_exceptionsbooleanTrue
profiling.partition_profiling_enabledbooleanTrue
profiling.partition_datetimestringFor partitioned datasets profile only the partition which matches the datetime or profile the latest one if not set. Only Bigquery supports this.None
database_patternAllowDenyPattern (see below for fields)Regex patterns for hive/presto database to filter in ingestion. Specify regex to only match the database name. e.g. to match all tables in database analytics, use the regex 'analytics'{'allow': ['.*'], 'deny': [], 'ignoreCase': True}
database_pattern.allowArray of stringList of regex patterns to include in ingestion['.*']
database_pattern.denyArray of stringList of regex patterns to exclude from ingestion.[]
database_pattern.ignoreCasebooleanWhether to ignore case sensitivity during pattern matching.True

Code Coordinates

  • Class Name: datahub.ingestion.source.sql.presto_on_hive.PrestoOnHiveSource
  • Browse on GitHub

Questions

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