PostgreSQL

Status: experimental

Example Configuration

host: "prod-postgres.company.com"
port: 5432
user: "marmot_reader"
password: "secure_password_123"
ssl_mode: "require"
tags:
  - "postgres"
  - "production"

Configuration

The following configuration options are available:

Property	Type	Required	Description
aws	AWSConfig	false
database_filter	plugin.Filter	false	Filter configuration for databases
discover_foreign_keys	bool	false	Whether to discover foreign key relationships
exclude_system_schemas	bool	false	Whether to exclude system schemas (pg_*)
external_links	[]ExternalLink	false
global_documentation	[]string	false
global_documentation_position	string	false
host	string	false	PostgreSQL server hostname or IP address
include_columns	bool	false	Whether to include column information in table metadata
include_databases	bool	false	Whether to discover databases
include_row_counts	bool	false	Whether to include approximate row counts (requires analyze)
metadata	MetadataConfig	false
password	string	false	Password for authentication
port	int	false	PostgreSQL server port (default: 5432)
schema_filter	plugin.Filter	false	Filter configuration for schemas
ssl_mode	string	false	SSL mode (disable, require, verify-ca, verify-full)
table_filter	plugin.Filter	false	Filter configuration for tables
tags	TagsConfig	false
user	string	false	Username for authentication

Available Metadata

The following metadata fields are available:

Field	Type	Description
allow_connections	bool	Whether connections to this database are allowed
collate	string	Database collation
column_default	string	Default value expression
column_name	string	Column name
comment	string	Column comment/description
comment	string	Object comment/description
connection_limit	int	Maximum allowed connections
constraint_name	string	Foreign key constraint name
created	string	Creation timestamp
ctype	string	Database character classification
data_type	string	Data type
database	string	Database name
encoding	string	Database encoding
host	string	PostgreSQL server hostname
is_nullable	bool	Whether null values are allowed
is_primary_key	bool	Whether column is part of primary key
is_template	bool	Whether database is a template
object_type	string	Object type (table, view, materialized_view)
owner	string	Object owner
port	int	PostgreSQL server port
row_count	int64	Approximate row count
schema	string	Schema name
size	int64	Object size in bytes
source_column	string	Column in the referencing table
source_schema	string	Schema of the referencing table
source_table	string	Name of the referencing table
table_name	string	Object name
target_column	string	Column in the referenced table
target_schema	string	Schema of the referenced table
target_table	string	Name of the referenced table