Skip to main content


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


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


This plugin extracts the following:

  • Metadata for databases, schemas, views, and tables
  • Column types associated with each table
  • Also supports PostGIS extensions
  • database_alias (optional) can be used to change the name of database to be ingested
  • Table, row, and column statistics via optional SQL profiling

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: postgres  config:    # Coordinates    host_port: localhost:5432    database: DemoDatabase
    # Credentials    username: user    password: pass
    # Options    database_alias: DatabaseNameToBeIngested
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.

usernamePostgreSQL username.
passwordPostgreSQL password.
host_portโœ…PostgreSQL host URL.
databasePostgreSQL database.
database_aliasAlias to apply to database when ingesting.
env"PROD"Environment to use in namespace when constructing URNs.
options.<option>Any options specified here will be passed to SQLAlchemy's create_engine as kwargs.
See for details.
table_pattern.allowList of regex patterns for tables to include in ingestion.
table_pattern.denyList of regex patterns for tables to exclude from ingestion.
table_pattern.ignoreCaseTrueWhether to ignore case sensitivity during pattern matching.
schema_pattern.allowList of regex patterns for schemas to include in ingestion.
schema_pattern.denyList of regex patterns for schemas to exclude from ingestion.
schema_pattern.ignoreCaseTrueWhether to ignore case sensitivity during pattern matching.
view_pattern.allowList of regex patterns for views to include in ingestion.
view_pattern.denyList of regex patterns for views to exclude from ingestion.
view_pattern.ignoreCaseTrueWhether to ignore case sensitivity during pattern matching.
include_tablesTrueWhether tables should be ingested.
include_viewsTrueWhether views should be ingested.


Coming soon!


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