PostgreSQL · Marmot Plugin Registry

marmotdata/postgresql

Discover databases, schemas, and tables from PostgreSQL instances

Registry

Databases

PostgreSQL

Databases AssetsLineage

Experimental

Marmot >=0.13.0

Version 0.5.0 (latest)

Version 0.4.0

Version 0.3.0

Version 0.2.0

Version 0.1.3

Version 0.1.2

Version 0.1.1

Version 0.1.0

Source

Install

The PostgreSQL plugin discovers databases, schemas, and tables from PostgreSQL instances. It captures column information, table metrics, and foreign key relationships for lineage. Tables and views are identified in their MRN by database.schema.object, for example mrn://asset/table/postgresql/shop.public.orders. Set zone to a short name such as prod-eu when you run two servers of the same kind, and it becomes part of every MRN. The name is one you choose, not a cloud availability zone.

Required Permissions

The user needs read access to the information schema:

GRANT CONNECT ON DATABASE your_db TO marmot_reader;
GRANT USAGE ON SCHEMA public TO marmot_reader;
GRANT SELECT ON ALL TABLES IN SCHEMA public TO marmot_reader;

In the UI

Point and click, no config file needed.

Open Runs and choose Create pipeline.
Pick PostgreSQL from the plugin list.
Fill in the settings, set a schedule and save.

Read the UI guide

With the CLI

Save a YAML config, then run marmot ingest.

Read the CLI guide

Not using plugins? Other ways to populate Marmot

Terraform Declare assets as infrastructure as code.

Pulumi Define assets as TypeScript, Python or Go resources.

Kubernetes operator Sync assets from Kubernetes custom resources.

Configuration

Fields marked Required must be set.

Fields

YAML

tags List of text

Tags to apply to discovered assets
external_links List of groups

External links to show on all assets
- name Text
  
  Display name for the link
  
  Required when external_links is set
- icon Text
  
  Icon identifier for the link
- url Text
  
  URL to the external resource
  
  Required when external_links is set
filter Group of settings

Filter discovered assets by name (regex)
- include List of text
  
  Include patterns for resource names (regex)
- exclude List of text
  
  Exclude patterns for resource names (regex)
zone Text

Tells this system apart from others of the same technology and becomes part of every asset's MRN
host Text Required

PostgreSQL server hostname or IP address
port Number

PostgreSQL server port

Default 5432
user Text Required

Username for authentication
password Secret

Password for authentication
ssl_mode One of

SSL mode (disable, require, verify-ca, verify-full)

Values disable, require, verify-ca, verify-full

Default disable
include_databases Yes or no

Whether to discover databases

Default true
include_columns Yes or no

Whether to include column information in table metadata

Default true
enable_metrics Yes or no

Whether to include table metrics

Default true
discover_foreign_keys Yes or no

Whether to discover foreign key relationships

Default true
exclude_system_schemas Yes or no

Whether to exclude system schemas (pg_*)

Default true
query_database Text

Database that data queries run against when this source answers queries

Default postgres

Required Permissions

In the UI

With the CLI

Not using plugins? Other ways to populate Marmot

Configuration

Assets emitted

Postgres

Postgres Column

Postgres Foreign Key