> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getcollate.io/llms.txt
> Use this file to discover all available pages before exploring further.

# PostgreSQL Connector | Collate Database Integration

> Connect PostgreSQL to Collate with our comprehensive database connector guide. Step-by-step setup, configuration examples, and metadata extraction tips.

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/post.webp" name="PostgreSQL" stage="PROD" availableFeatures={["Metadata", "Query Usage", "Data Profiler", "Data Quality", "dbt", "Lineage", "Column-level Lineage", "Owners", "Tags", "Stored Procedures", "Sample Data", "Reverse Metadata (Collate Only)", "Auto-Classification"]} unavailableFeatures={["Stored Procedures Lineage"]} />

This section provides guides and references to use the PostgreSQL connector.
Configure and schedule PostgreSQL metadata and profiler workflows from the Collate UI:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Query Usage](/how-to-guides/guide-for-data-users/ingestion/workflows/usage)
* [Data Profiler](/how-to-guides/data-quality-observability/profiler/profiler-workflow)
* [Data Quality](/how-to-guides/data-quality-observability/quality)
* [Lineage](/how-to-guides/guide-for-data-users/ingestion/lineage)
* [dbt Integration](/connectors/database/dbt)
* [Enable Security](#securing-postgresql-connection-with-ssl-in-collate)
* [Troubleshooting](/connectors/database/postgres/troubleshooting)
* [Reverse Metadata](#reverse-metadata)

## Requirements

<Tip>
  **Tip**: Collate supports only officially supported PostgreSQL versions. Check the [PostgreSQL versioning policy](https://www.postgresql.org/support/versioning/) for supported versions.
</Tip>

### Usage and Lineage

For the usage and lineage workflow, Collate relies on the [`pg_stat_statements`](https://www.postgresql.org/docs/current/pgstatstatements.html) extension to read query history. Enable the extension and grant your user read access to query statistics.

**1. Load the extension at server startup** by adding the following to your `postgresql.conf`:

```ini theme={null}
shared_preload_libraries = 'pg_stat_statements'
```

After making this change, restart the PostgreSQL server.

**2. Enable the extension and grant access** by running the following SQL as a superuser:

```sql theme={null}
CREATE EXTENSION IF NOT EXISTS pg_stat_statements;

-- Grant read access to the Collate user
GRANT pg_read_all_stats TO your_user;
```

For more information, see the [usage workflow](/how-to-guides/guide-for-data-users/ingestion/workflows/usage) and [lineage workflow](/how-to-guides/guide-for-data-users/ingestion/lineage) guides.

<Warning>
  **Important**: `pg_stat_statements` is **not a query log**: it is a fixed-size, in-memory statistics collector. This has important implications for lineage and usage completeness:

  * **Entry eviction**: It stores entries in a hash table controlled by `pg_stat_statements.max` (default: **5000**). When full, the least-executed entries are silently evicted. Queries can disappear before Collate reads them.
  * **Query normalization**: Queries are deduplicated by shape. Literal values are replaced with placeholders (for example, `SELECT * FROM users WHERE id = $1`). Individual executions are not stored.
  * **No timestamps**: There is no time data. Only cumulative `calls` count and `total_exec_time` since the last reset are tracked. The **query log duration** setting in Collate will have no impact. Only the **query limit** matters.
  * **Resets clear everything**: A server restart or `pg_stat_statements_reset()` wipes all entries.
</Warning>

For the most complete lineage and usage data, apply the following recommendations:

* **Increase `pg_stat_statements.max`** to at least `10000` (or higher) in `postgresql.conf` to reduce entry eviction.
* **Set `pg_stat_statements.track = 'all'`** in `postgresql.conf` to capture queries inside functions and procedures.
* **Schedule frequent ingestion runs** (for example, every 1–2 hours) to capture queries before they are evicted.
* **Avoid calling `pg_stat_statements_reset()`** before ingestion. If periodic resets are needed, schedule them after ingestion completes.

If your organization restricts direct access to `pg_stat_statements`, or you need more control over query retention, set the **Query Statement Source** connection property to a custom view or table (for example, `my_schema.custom_query_history`). The custom source must expose the same columns that Collate reads from `pg_stat_statements`: `userid` (oid), `dbid` (oid), `query` (text), and either `total_exec_time` (double precision, PostgreSQL 13+) or `total_time` (double precision, PostgreSQL \< 13). If not set, Collate defaults to `pg_stat_statements`.

### IAM Authentication

To connect via IAM, you need the following:

1. Database is configured to use IAM authentication.
   Ensure that the RDS has IAM DB authentication enabled. Otherwise, select **Modify** to enable it.
2. The user has the necessary IAM permissions.
   Even if you use IAM to connect to PostgreSQL, you need to specify a user to prepare the connection. Create a user as follows:
   ```sql theme={null}
   CREATE USER iam_user WITH LOGIN;
   GRANT rds_iam TO iam_user;
   ```
3. The AWS Role has the necessary permissions.
   The role used to perform the ingestion needs the following permissions:
   ```json theme={null}
   {
       "Version": "2012-10-17",
       "Statement": [
           {
               "Effect": "Allow",
               "Action": [
                   "rds-db:connect"
               ],
               "Resource": [
                   "arn:aws:rds-db:eu-west-1:<aws_account_number>:dbuser:<rds_db_resource_id>/<postgres_user>"
               ]
           }
       ]
   }
   ```
   Otherwise, you might encounter issues such as:
   PAM authentication failed for user "\<user>"

## Stored Procedures

When executing stored procedures in PostgreSQL, lineage extraction relies on capturing the SQL queries executed within the procedure. However, by default, PostgreSQL does not track the internal queries of a stored procedure in `pg_stat_statements`.

### Enabling Query Tracking for Lineage

To ensure Collate captures lineage from stored procedures, follow these steps:

1. **Enable Logging for All Statements**.
   Modify the `postgresql.conf` file and set:
   ```ini theme={null}
   log_statement = 'all'
   ```
   This will log all executed SQL statements, including those inside stored procedures.
2. **Configure `pg_stat_statements` to Track Nested Queries**.
   By default, `pg_stat_statements` may only capture top-level procedure calls and not the internal queries. To change this behavior, update:
   ```ini theme={null}
   pg_stat_statements.track = 'all'
   ```
   This ensures that statements executed within procedures are recorded.

## Metadata Ingestion

To ingest metadata from PostgreSQL, you need to create a service connection. The service connects PostgreSQL with Collate. Once you create a service, Collate automatically starts ingesting metadata.

### Step 1: Add New Service

Open the Services page and start a new service.

1. Navigate to **Settings** > **Services** and select **Database Services**.

   <img src="https://mintcdn.com/collatedocs/uYKcw5sAfx_Tl0Ed/public/images/connectors/metadata-ingestion/classic/database/visit-services.png?fit=max&auto=format&n=uYKcw5sAfx_Tl0Ed&q=85&s=5304825b90c50f5a15fa71c33219e821" alt="Navigate to Services" width="3022" height="1614" data-path="public/images/connectors/metadata-ingestion/classic/database/visit-services.png" />

2. Click **Add New Service**.

   <img src="https://mintcdn.com/collatedocs/uYKcw5sAfx_Tl0Ed/public/images/connectors/metadata-ingestion/classic/database/add-new-service.png?fit=max&auto=format&n=uYKcw5sAfx_Tl0Ed&q=85&s=bd63025347d410a6bbceb0af6b55820a" alt="Add New Service" width="2838" height="1258" data-path="public/images/connectors/metadata-ingestion/classic/database/add-new-service.png" />

### Step 2: Select a Service and Connector

From the service type dropdown, select **Database Services**, then click the **PostgreSQL** connector tile.

<img src="https://mintcdn.com/collatedocs/bWmb7UY94lEjxxg4/public/images/ai-2.0/connectors/metadata-ingestion/Database/select-service/postgres.png?fit=max&auto=format&n=bWmb7UY94lEjxxg4&q=85&s=c52a4cbfff5fb9e9aee5767797481189" alt="Select Service" width="1900" height="900" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/select-service/postgres.png" />

### Step 3: Add Service Name and Description

* Enter a unique, descriptive **Service Name**. Collate identifies services by their service name. Enter a name that distinguishes this deployment from other PostgreSQL services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.

<img src="https://mintcdn.com/collatedocs/bWmb7UY94lEjxxg4/public/images/ai-2.0/connectors/metadata-ingestion/Database/service-name/postgres.png?fit=max&auto=format&n=bWmb7UY94lEjxxg4&q=85&s=cb3b975a7c83dea66c32bc03cf27f8f1" alt="Add New Service Name" width="1510" height="844" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/service-name/postgres.png" />

<Note>
  **Note**: The service name can't be changed after you set it.
</Note>

### Step 4: Configure Connection Options

Specify where ingestion runs, provide your source credentials, and verify the connection.

#### Select Ingestion Runner

Select an **Ingestion Runner**: the runner where the ingestion pipeline will execute.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/select-ingestion-runner.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=1249f828648614445e8a976ea1933487" alt="Add Name and Select Ingestion Runner" width="1444" height="506" data-path="public/images/ai-2.0/connectors/metadata-ingestion/select-ingestion-runner.png" />

#### Enter Connection Details

Enter the connection details for PostgreSQL. The right-hand panel in the UI displays inline help for each field.

<img src="https://mintcdn.com/collatedocs/kTp2dTyiNAX4Np5A/public/images/ai-2.0/connectors/metadata-ingestion/Database/connection-details/postgres.png?fit=max&auto=format&n=kTp2dTyiNAX4Np5A&q=85&s=078364a8629b0b65ea330343d0d5d3a1" alt="Configure Service Connection" width="1452" height="1328" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/connection-details/postgres.png" />

* **Username**: Specify the user to connect to PostgreSQL. It should have enough privileges to read all the metadata.
* **Auth Type**: Basic Auth or IAM-based auth to connect to instances or cloud RDS.
  * **Basic Auth**:
    * **Password**: Password to connect to PostgreSQL.
  * **IAM Based Auth**:

    * **AWS Access Key ID and AWS Secret Access Key**: When you interact with AWS, you specify your AWS security credentials to verify who you are and whether you have
      permission to access the resources that you are requesting. AWS uses the security credentials to authenticate and
      authorize your requests ([docs](https://docs.aws.amazon.com/IAM/latest/UserGuide/security-creds.html)).
      Access keys consist of two parts: an **access key ID** (for example, `AKIAIOSFODNN7EXAMPLE`), and a **secret access key** (for example, `wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY`).
      You must use both the access key ID and secret access key together to authenticate your requests.
      For more information, see [how to manage your access keys](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html).
    * **AWS Region**: Each AWS Region is a separate geographic area in which AWS clusters data centers ([docs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html)).
      Because AWS can have instances in multiple regions, specify the region where the service you want to reach is located.
      The AWS Region is the only required parameter when configuring a connection. When connecting to the
      services programmatically, different methods exist to extract and use the rest of the AWS configuration.
      For more information, see [configuring your credentials](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#configuring-credentials).
    * **AWS Session Token (optional)**: If you are using temporary credentials to access your services, provide the AWS Access Key ID
      and AWS Secret Access Key. These also include an AWS Session Token.
      For more information, see [Using temporary credentials with AWS resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html).
    * **Endpoint URL (optional)**: To connect programmatically to an AWS service, you use an endpoint. An *endpoint* is the URL of the
      entry point for an AWS web service. The AWS SDKs and the AWS Command Line Interface (AWS CLI) automatically use the
      default endpoint for each service in an AWS Region. Specify an alternate endpoint for your API requests if needed.
      Find more information on [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html).
    * **Profile Name**: A named profile is a collection of settings and credentials you apply to an AWS CLI command.
      When you specify a profile to run a command, the settings and credentials are used to run that command.
      Multiple named profiles can be stored in the config and credentials files.
      Specify this field to use a profile other than `default`.
      Find more information about [Named profiles for the AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html).
    * **Assume Role Arn**: Typically, you use `AssumeRole` within your account or for cross-account access. In this field you'll set the
      `ARN` (Amazon Resource Name) of the policy of the other account.
      A user who wants to access a role in a different account must also have permissions that are delegated from the account
      administrator. The administrator must attach a policy that lets the user call `AssumeRole` for the `ARN` of the role in the other account.
      This is a required field if you'd like to `AssumeRole`.
      Find more information on [AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html).

    <Tip>
      **Tip**: When using Assume Role authentication, ensure you provide the following details:

      * **AWS Region**: Specify the AWS Region for your deployment.
      * **Assume Role ARN**: Provide the ARN of the role in your AWS account that Collate will assume.
    </Tip>

    * **Assume Role Session Name**: An identifier for the assumed role session. Use the role session name to uniquely identify a session when the same role
      is assumed by different principals or for different reasons.
      By default, Collate uses the name `OpenMetadataSession`.
      Find more information about the [Role Session Name](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=An%20identifier%20for%20the%20assumed%20role%20session.).
    * **Assume Role Source Identity**: The source identity specified by the principal that is calling the `AssumeRole` operation. Use source identity
      information in AWS CloudTrail logs to determine who took actions with a role.
      Find more information about [Source Identity](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html#:~:text=Required%3A%20No-,SourceIdentity,-The%20source%20identity).
* **Host and Port**: Enter the fully qualified hostname and port number for your PostgreSQL deployment in the Host and Port field.

#### SSL Modes

There are a couple of types of SSL modes that PostgreSQL supports which can be added to ConnectionArguments, they are as follows:

* **disable**: SSL is disabled and the connection is not encrypted.
* **allow**: SSL is used if the server requires it.
* **prefer**: SSL is used if the server supports it.
* **require**: SSL is required.
* **verify-ca**: SSL must be used and the server certificate must be verified.
* **verify-full**: SSL must be used. The server certificate must be verified, and the server hostname must match the hostname attribute on the certificate.

#### SSL Configuration

To integrate SSL in the Metadata Ingestion Config, add the SSL config under `sslConfig`, which is placed in the source.

#### Advanced Configuration

Database Services include an Advanced Configuration section for passing extra arguments to the connector and, if needed, changing the connection scheme. You need this only for advanced connectivity scenarios or customizations.

* **Connection Options (Optional)**: Enter the details for any additional connection options that can be sent to the database during the connection. These details must be added as key-value pairs.
* **Connection Arguments (Optional)**: Enter the details for any additional connection arguments such as security or protocol configs that can be sent during the connection. These details must be added as key-value pairs.

#### Test Connection

1. Click **Test Connection** to verify the credentials.
2. After the test succeeds, click **Save**.

<img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/test-connection.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=3365cff7bb9d82c85a2ff9ab559d6f11" alt="Test Connection" width="1446" height="188" data-path="public/images/ai-2.0/connectors/metadata-ingestion/test-connection.png" />

### Step 5: Configure Ingestion Options

In the **What to Ingest** step, use filter patterns to control which assets Collate ingests from your database service. Filter rules match asset names using the following match types.

#### How Filter Patterns Work

* **Include**: Add one or more comma-separated values. Each value uses one of the following match types. Collate ingests only assets whose names match at least one rule. Leave blank to include all assets.
* **Exclude**: Add one or more comma-separated values. Each value uses one of the following match types. Collate skips any asset whose name matches a rule. Leave blank to exclude nothing.

Rules match asset names using one of five match types:

* **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`.
* **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`.
* **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`.
* **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`.
* **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`.

When both Include and Exclude are set, Exclude takes priority.

<Tip>
  **Tip**: Leave all filter patterns empty to ingest all databases, schemas, and tables available in the source.
</Tip>

#### Filter Options

The Database, Schema, Table, and Stored Procedure sections each include the following filter options:

* **Database**: Controls which databases Collate ingests from the source.
* **Schema**: Controls which schemas within the ingested databases are included.
* **Table**: Controls which tables and views within the ingested schemas are included.
* **Stored Procedure**: Controls which stored procedures are included in metadata ingestion.

Each section provides the following controls:

* **Scan Mode**: Choose between the following scan modes:
  * **Scan all**: Ingests every asset of that type the connector can access. This is the default.
  * **Only specific**: Enables include rules so only assets matching at least one rule are ingested.
* **Exclude system toggle**: Use this toggle to filter out system-reserved names defined by the connector for that asset type.
* **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
* **Preview**: Shows a real-time summary of what will be in scope based on your current rules.
* **Include rules**: In **Only specific** mode, click **+ Add** to define a rule. Added rules appear as chips. An asset is included if it matches any rule.

<Tip>
  **Tip**: If [AutoPilot](/how-to-guides/admin-guide/applications/autopilot) is enabled, usage tracking, data lineage, and other downstream workflows start automatically after the first metadata ingestion completes.
</Tip>

### Step 6: Create & Deploy

Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. Collate saves the service configuration and immediately begins pulling metadata from the source.

To monitor ingestion progress or view the service you just added, go to **Settings** > **Services** and select your service.

## Configure Metadata Agent and Schedule Ingestion

The **Metadata Agent** extracts schemas, tables, columns, and other structural metadata from your source and keeps your Collate catalog in sync. It powers discovery, lineage, and governance across your data assets.

When you click **Create & Deploy**, Collate automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page.

To configure the additional Metadata Agent and schedule ingestion, follow these steps:

1. Navigate to **Settings** > **Services** and select the **Databases** service.

2. Select your service and click the **Agents** tab.

3. Click **Add Agent** and select **Metadata** from the dropdown.
   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/add-metadata-agent.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=accad7d1c4ddf209781bff851d51d464" alt="Add Metadata Agent" width="2398" height="1144" data-path="public/images/ai-2.0/connectors/metadata-ingestion/add-metadata-agent.png" />
   For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page.

4. On the **Configure Ingestion** page, do the following and click **Next**.

   * **Name this Ingestion**: Enter a unique, recognizable name for this ingestion pipeline.

     <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=d5ec1f0f3742cadab8cd54c602c97239" alt="Name this Ingestion" width="1578" height="644" data-path="public/images/ai-2.0/connectors/metadata-ingestion/metadata-agent-name.png" />

   * **Agent Setup**: Configure core parameters for metadata extraction. The following fields are available:

     | Field | Default | Description |
     | - | - | - |
     | **Default Owner** | — | Owner applied to any entity that has no owner from a more specific field below. Accepts a user or a team, by name or email. |
     | **Service Owner** | — | Not applied during ingestion. This field doesn't affect the owners of databases, schemas, or tables. |
     | **Database Owner** | — | Owner assigned to every database this agent ingests. Accepts either one owner for all of them, or a mapping of specific owners per database. |
     | **Database Schema Owner** | — | Owner assigned to every schema this agent ingests. Accepts either one owner for all of them, or a mapping of specific owners per schema. |
     | **Table Owner** | — | Owner assigned to every table this agent ingests. Accepts either one owner for all of them, or a mapping of specific owners per table. |
     | **Enable Inheritance** | On | When on, a schema or table with no match of its own inherits the owner resolved for its parent. Default Owner still applies when nothing else resolves an owner. |
     | **Query Log Duration** | 1 | How many days of query logs to look back through when processing stored procedure results. |
     | **Query Parsing Timeout Limit** | 300 | How many seconds to spend parsing a single query before giving up on it and moving to the next. Raise this if large or complex queries are being skipped. |
     | **Number of Threads** | 1 | How many tables to ingest in parallel. Raising this can speed up ingestion on databases with many tables, at the cost of more load on the source. |
     | **Incremental Extraction** | Off | When on, a run extracts only entities that changed since the last successful run, instead of re-scanning everything every time. Faster on large, mostly-unchanged databases. |
     | **Successful Pipeline Run Lookback Days** | 7 | Only used when Incremental Extraction is on. How many days back to search for a prior successful run to use as the starting point for "what changed since then." |
     | **Safety Margin Days** | 1 | Only used when Incremental Extraction is on. Extra days added before that starting point, as a buffer so changes that were still in flight when the last run finished aren't missed. |
     | **Extract JSON Schema** | Off | Sample values in JSON columns to infer and ingest their schema, so the individual fields inside a JSON column are visible in Collate rather than just "JSON". Requires `SELECT` permission on the sampled tables; if that permission is missing, the JSON column is still ingested, just without a detailed schema. |
     | **JSON Schema Sample Size** | 10 | Only used when Extract JSON Schema is on. Number of rows sampled per JSON column to infer its schema. A larger sample gives more accurate results but takes longer to run. |

     For more information, see [Hierarchical Owner Configuration](/how-to-guides/guide-for-data-users/ingestion/workflows/metadata/hierarchical-owner-configuration).

     <img src="https://mintcdn.com/collatedocs/kTp2dTyiNAX4Np5A/public/images/ai-2.0/connectors/metadata-ingestion/Database/database-agent-setup.png?fit=max&auto=format&n=kTp2dTyiNAX4Np5A&q=85&s=429839e5b479082a6909dd2a7734513d" alt="Agent Setup" width="1570" height="1396" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/database-agent-setup.png" />

   * **Filter Patterns**: Apply include or exclude rules to scope which databases, schemas, tables, and stored procedures this agent ingests. These follow the same filter options described in **Step 5**.

     <img src="https://mintcdn.com/collatedocs/kTp2dTyiNAX4Np5A/public/images/ai-2.0/connectors/metadata-ingestion/Database/database-filter-pattern.png?fit=max&auto=format&n=kTp2dTyiNAX4Np5A&q=85&s=8a0c5fcc3475acf8acc94e6eecb55a11" alt="Filter Patterns" width="1560" height="1030" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/database-filter-pattern.png" />

   * **Scope & Behaviour**: Control how the agent handles metadata during ingestion. Toggle each option on or off based on your needs:

     | Toggle | Default | Description |
     | - | - | - |
     | **Include Tables** | On | Ingest tables and their columns. Turn off to skip tables entirely, for example if this agent exists only to pull tags or stored procedures. |
     | **Include Tags** | On | Ingest tags already defined on tables/columns in the source system (for example, a classification tag applied in Snowflake) and bring them into Collate as tags on the same assets. |
     | **Include Stored Procedures** | On | Ingest stored procedures as their own assets, so they show up in the catalog and can be linked into lineage. |
     | **Include DDL Statements** | Off | Also ingest the raw `CREATE TABLE` / `CREATE VIEW` statement for each asset, so it's viewable in Collate alongside the asset's metadata. |
     | **Include Owners** | Off | When an ingested asset's owner in the source system is an email that matches an existing Collate user, assign that user as the asset's owner. Never overwrites an owner an asset already has in Collate. |
     | **Include Custom Properties** | Off | Ingest source-specific metadata that doesn't map to a standard Collate field (for example, a database-specific attribute) into custom properties on the asset, if custom properties have been defined for that entity type. |
     | **Mark Deleted Tables** | On | If a table this agent previously ingested no longer exists in the source, soft-delete it in Collate too. Only affects tables within schemas this agent actually scans. |
     | **Mark Deleted Stored Procedures** | On | Same as Mark Deleted Tables, but for stored procedures. |
     | **Mark Deleted Schemas** | Off | If an entire schema this agent previously ingested no longer exists in the source, soft-delete the schema and everything in it. |
     | **Mark Deleted Databases** | Off | If an entire database this agent previously ingested no longer exists in the source, soft-delete the database and everything in it. |
     | **Override Metadata** | Off | On: values from the source (descriptions, tags, owners, display names) overwrite what's currently in Collate, even if someone edited it there. A description or display name that the source doesn't send never replaces an existing value, and existing table constraints are kept when the source sends none. Off: Collate only fills in fields that are still empty, so manual edits in Collate are preserved. |
     | **Enable Debug Log** | Off | Run this ingestion at DEBUG log verbosity instead of the normal level. Turn on when troubleshooting a failing or unexpected run; leave off otherwise, since debug logs are much larger. |

     <Note>
       **Note**: Available toggles vary by connector. Stored procedure options only appear for connectors that support stored procedures.
     </Note>

     <img src="https://mintcdn.com/collatedocs/kTp2dTyiNAX4Np5A/public/images/ai-2.0/connectors/metadata-ingestion/Database/database-scope-behaviour.png?fit=max&auto=format&n=kTp2dTyiNAX4Np5A&q=85&s=6ada5b2870c990f494d1dac400e73459" alt="Scope & Behaviour" width="1566" height="1436" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/database-scope-behaviour.png" />

   * **Advanced Config**: Driver-level options (connection arguments, scheme, and timeouts). Most connections never need these, and they vary by connector. This section also has one ingestion-scope toggle:

     | Toggle | Default | Description |
     | - | - | - |
     | **Include Views** | On | Ingest views in addition to tables. Turn off to skip views entirely. Because view lineage is derived from parsing each view's SQL definition, turning this off also stops view-based lineage from being generated for this service. |

     <img src="https://mintcdn.com/collatedocs/kTp2dTyiNAX4Np5A/public/images/ai-2.0/connectors/metadata-ingestion/Database/database-advance.png?fit=max&auto=format&n=kTp2dTyiNAX4Np5A&q=85&s=63ef86d9e746b6d31f0571b599792357" alt="Advanced Config" width="1564" height="352" data-path="public/images/ai-2.0/connectors/metadata-ingestion/Database/database-advance.png" />

5. On the **Schedule Interval** page, set when the agent runs:

   * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   * **On-Demand**: No automatic schedule. Trigger the agent manually when needed.

   <img src="https://mintcdn.com/collatedocs/bv5oe4uRjuorTJO1/public/images/ai-2.0/connectors/metadata-ingestion/schedule.png?fit=max&auto=format&n=bv5oe4uRjuorTJO1&q=85&s=25cc1d78f6f2a8bd115830d034d1d8d1" alt="Schedule Interval" width="1588" height="1044" data-path="public/images/ai-2.0/connectors/metadata-ingestion/schedule.png" />

6. Click **Add** to deploy the agent.

## Securing PostgreSQL Connection with SSL in Collate

To establish secure connections between Collate and a PostgreSQL database, you can configure SSL using different SSL modes provided by PostgreSQL, each offering varying levels of security.
Under `Advanced Config`, specify the SSL mode appropriate for your connection, such as `prefer`, `verify-ca`, `allow`, and others. After selecting the SSL mode, provide the CA certificate used for SSL validation (`caCertificate`). Note that PostgreSQL requires only the CA certificate for SSL validation.

<Tip>
  **Tip**: For IAM authentication, choose the `allow` mode or another SSL mode that fits your requirements.
</Tip>

<img src="https://mintcdn.com/collatedocs/qybQN_VCNOUNg9nn/public/images/connectors/ssl_connection.png?fit=max&auto=format&n=qybQN_VCNOUNg9nn&q=85&s=e90fd6e04057c3481ac6ca1987423a30" alt="SSL Configuration" height="450px" data-path="public/images/connectors/ssl_connection.png" />

## Reverse Metadata

<Step title="Reverse Metadata">
  ### Description Management

  PostgreSQL supports description updates at all levels:

  * Database level
  * Schema level
  * Table level
  * Column level

  ### Owner Management

  PostgreSQL supports owner management at the following levels:

  * Database level
  * Schema level
  * Table level

  ### Tag Management

  ❌ Tag management is not supported for PostgreSQL.

  ### Custom SQL Template

  PostgreSQL supports custom SQL templates for metadata changes. The template is interpreted using python f-strings.

  Here are examples of custom SQL queries for metadata changes:

  ```sql theme={null}
  -- Update database owner
  ALTER DATABASE {database} OWNER TO {owner};
  ```

  The list of variables for custom SQL can be found [here](/how-to-guides/admin-guide/applications/reverse-metadata#custom-sql-templates).

  For more information about reverse metadata ingestion, see [Reverse Metadata Application](/how-to-guides/admin-guide/applications/reverse-metadata).

  ### Requirements for Reverse Metadata

  In addition to the basic ingestion requirements, for reverse metadata ingestion the user needs:

  * `SUPERUSER` privilege to the user

  ```sql theme={null}
  -- Grant superuser privilege to the user
  ALTER ROLE USER_NAME SUPERUSER;
  ```
</Step>

## Troubleshooting

<Columns cols={2}>
  <Card title="PostgreSQL Troubleshooting" href="/connectors/database/postgres/troubleshooting">
    Learn more about how to troubleshoot common PostgreSQL connector issues and resolve configuration or ingestion errors.
  </Card>
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.