Druid

For context on getting started with ingestion, check out our metadata ingestion guide.

Setup

To install this plugin, run pip install 'acryl-datahub[druid]'.

Capabilities

Capability	Status	Details
Platform Instance	✔️	link

This plugin extracts the following:

Metadata for databases, schemas, and tables
Column types associated with each table
Table, row, and column statistics via optional SQL profiling

Note: It is important to explicitly define the deny schema pattern for internal Druid databases (lookup & sys) if adding a schema pattern. Otherwise, the crawler may crash before processing relevant databases. This deny pattern is defined by default but is overriden by user-submitted configurations.

Quickstart 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: druid
  config:
    # Coordinates
    host_port: "localhost:8082"

    # Credentials
    username: admin
    password: password

sink:
  # sink configs

Config details

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

As a SQL-based service, the Athena integration is also supported by our SQL profiler. See here for more details on configuration.

Field	Required	Default	Description
`username`			Database username.
`password`			Database password.
`host_port`	✅		Host URL and port to connect to.
`database`			Database to ingest.
`database_alias`			Alias to apply to database when ingesting.
`env`		`"PROD"`	Environment to use in namespace when constructing URNs.
`platform_instance`		None	The Platform instance to use while constructing URNs.
`options.<option>`			Any options specified here will be passed to SQLAlchemy's `create_engine` as kwargs. See https://docs.sqlalchemy.org/en/14/core/engines.html#sqlalchemy.create_engine for details.
`table_pattern.allow`			List of regex patterns for tables to include in ingestion.
`table_pattern.deny`			List of regex patterns for tables to exclude from ingestion.
`table_pattern.ignoreCase`		`True`	Whether to ignore case sensitivity during pattern matching.
`schema_pattern.allow`			List of regex patterns for schemas to include in ingestion.
`schema_pattern.deny`		`"^(lookup \| sys).\*"`	List of regex patterns for schemas to exclude from ingestion.
`schema_pattern.ignoreCase`		`True`	Whether to ignore case sensitivity during pattern matching.
`view_pattern.allow`			List of regex patterns for views to include in ingestion.
`view_pattern.deny`			List of regex patterns for views to exclude from ingestion.
`view_pattern.ignoreCase`		`True`	Whether to ignore case sensitivity during pattern matching.
`include_tables`		`True`	Whether tables should be ingested.
`include_views`		`True`	Whether views should be ingested.

Compatibility

Coming soon!

Questions

If you've got any questions on configuring this source, feel free to ping us on our Slack!

6.8 KiB Raw Blame History