PostgreSQL

Required

Fields required for a valid configuration.

Path	Type	Required	Description	Default	Constraints
required	object	Yes	—	—	no extra properties
required.host	string	Yes	PostgreSQL host	localhost	—
required.port	integer	Yes	PostgreSQL port	5432	min 1, max 65535

Masked

Sensitive fields under(secrets/credentials).

Path	Type	Required	Description	Default	Constraints
masked	object	Yes	—	—	no extra properties
masked.password	string	Yes	Database password	—	—
masked.username	string	Yes	Database username	—	—

Optional

Optional configuration fields.

Path	Type	Required	Description	Default	Constraints
optional	object	No	—	—	no extra properties
optional.connection	object	No	Connection tuning and SSL behavior.	—	no extra properties
optional.connection.connect_timeout_seconds	integer	No	Connection timeout in seconds	10	min 1, max 120
optional.connection.ssl_mode	enum	No	SSL mode for PostgreSQL connection Allowed values: disable, allow, prefer, require, verify-ca, verify-full	prefer	—
optional.scope	object	No	Database, schema, and table selection scope.	—	no extra properties
optional.scope.database	string	No	Single database to scan (optional when include_all_databases is true)	—	—
optional.scope.exclude_schemas	array	No	Schema denylist (exact schema names)	["information_schema","pg_catalog","pg_toast"]	—
optional.scope.exclude_schemas[]	string	No	—	—	—
optional.scope.include_all_databases	boolean	No	Scan all non-template databases visible to this user	false	—
optional.scope.include_schemas	array	No	Optional schema allowlist (exact schema names)	—	—
optional.scope.include_schemas[]	string	No	—	—	—
optional.scope.include_tables	array	No	Optional table allowlist. Accepted forms: schema.table or database.schema.table	—	—
optional.scope.include_tables[]	string	No	—	—	—
optional.scope.maintenance_database	string	No	Database used for database enumeration when include_all_databases is true	postgres	—
optional.scope.table_limit	integer	No	Optional cap on number of table assets extracted	—	min 1

Extracted Metadata

Table

Field	Type	Required	Description
database	string	Yes	Database or catalog name
table_name	string	Yes	Table name
table_type	string	Yes	Object type (TABLE/VIEW)
schema	string	No	Schema name
columns	object[]	No	Columns as {name, type} objects
row_count	integer	No	Estimated number of rows

Examples

Quick discovery scan

Discover all tables across all schemas with random row sampling — works out of the box on any PostgreSQL instance

Config Payload

{
  "type": "POSTGRESQL",
  "required": {
    "host": "your-host",
    "port": 5432
  },
  "masked": {
    "username": "your-username",
    "password": "your-password"
  },
  "optional": {},
  "sampling": {
    "strategy": "AUTOMATIC",
    "rows_per_page": 50
  }
}

Schedule

{
  "enabled": true,
  "preset": "weekday_business",
  "cron": "33 14 * * 1-5",
  "timezone": "UTC"
}

All databases scan with latest sampling

Enumerate all visible databases and prioritize recent rows — ideal for nightly data governance sweeps

Config Payload

{
  "type": "POSTGRESQL",
  "required": {
    "host": "your-host",
    "port": 5432
  },
  "masked": {
    "username": "your-username",
    "password": "your-password"
  },
  "optional": {
    "scope": {
      "include_all_databases": true
    }
  },
  "sampling": {
    "strategy": "AUTOMATIC",
    "fallback_to_random": true,
    "rows_per_page": 50
  }
}

Schedule

{
  "enabled": true,
  "preset": "nightly",
  "cron": "56 0 * * *",
  "timezone": "UTC"
}

PII and secrets compliance scan

Scan specific schemas for PII and hardcoded secrets — typical for pre-audit compliance checks

Config Payload

{
  "type": "POSTGRESQL",
  "required": {
    "host": "your-host",
    "port": 5432
  },
  "masked": {
    "username": "your-username",
    "password": "your-password"
  },
  "optional": {
    "scope": {
      "include_schemas": [
        "public"
      ]
    }
  },
  "sampling": {
    "strategy": "AUTOMATIC",
    "rows_per_page": 30
  },
  "detectors": [
    {
      "type": "SECRETS",
      "enabled": true
    },
    {
      "type": "PII",
      "enabled": true
    }
  ]
}

Schedule

{
  "enabled": true,
  "preset": "weekday_morning",
  "cron": "22 7 * * 1-5",
  "timezone": "UTC"
}