OpenMetadata/openmetadata-docs/content/v1.7.x-SNAPSHOT/connectors/database/postgres/index.md

title	slug
PostgreSQL	/connectors/database/postgres

{% connectorDetailsHeader name="PostgreSQL" stage="PROD" platform="OpenMetadata" availableFeatures=["Metadata", "Query Usage", "Data Profiler", "Data Quality", "dbt", "Lineage", "Column-level Lineage", "Owners", "Tags", "Stored Procedures", "Sample Data", "Stored Procedures Lineage", "Reverse Metadata Ingestion"] unavailableFeatures=[] / %}

In this section, we provide guides and references to use the PostgreSQL connector.

Configure and schedule PostgreSQL metadata and profiler workflows from the OpenMetadata UI:

• Requirements
• Metadata Ingestion
• Query Usage
• Data Profiler
• Data Quality
• Lineage
• dbt Integration
• Enable Security
• Reverse Metadata
• Troubleshooting

{% partial file="/v1.7/connectors/ingestion-modes-tiles.md" variables={yamlPath: "/connectors/database/postgres/yaml"} /%}

Requirements

{% note %} Starting from OpenMetadata version 1.6.5, support for Stored Procedures Lineage has been introduced. This feature enables tracking the relationships and dependencies between stored procedures and other database objects, enhancing lineage visibility and data traceability. {% /note %}

{% note %} Note that we only support officially supported PostgreSQL versions. You can check the version list here. {% /note %}

Usage and Lineage considerations

When extracting lineage and usage information from PostgreSQL we base our finding on the pg_stat_statements table. You can find more information about it on the official docs.

Another interesting consideration here is explained in the following SO question. As a summary:

• The pg_stat_statements has no time data embedded in it.
• It will show all queries from the last reset (one can call pg_stat_statements_reset()).

Then, when extracting usage and lineage data, the query log duration will have no impact, only the query limit.

Note: For usage and lineage grant your user pg_read_all_stats permission.

GRANT pg_read_all_stats TO your_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 OpenMetadata captures lineage from stored procedures, follow these steps:

1. Enable Logging for All Statements

Modify the postgresql.conf file and set:    ini    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    pg_stat_statements.track = 'all'    

This ensures that statements executed within procedures are recorded.

Metadata Ingestion

{% partial file="/v1.7/connectors/metadata-ingestion-ui.md" variables={ connector: "PostgreSQL", selectServicePath: "/images/v1.7/connectors/postgres/select-service.png", addNewServicePath: "/images/v1.7/connectors/postgres/add-new-service.png", serviceConnectionPath: "/images/v1.7/connectors/postgres/service-connection.png", } /%}

{% stepsContainer %} {% extraContent parentTagName="stepsContainer" %}

Connection Details

• 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 / cloud rds.

  • Basic Auth:

    • Password: Password to connect to PostgreSQL.

  • IAM Based Auth:

    • AWS Access Key ID & 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).

    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.

    You can find further information on how to manage your access keys here.

    • AWS Region: Each AWS Region is a separate geographic area in which AWS clusters data centers (docs).

    As AWS can have instances in multiple regions, we need to know the region the service you want reach belongs to.

    Note that the AWS Region is the only required parameter when configuring a connection. When connecting to the services programmatically, there are different ways in which we can extract and use the rest of AWS configurations.

    You can find further information about configuring your credentials here.

    • AWS Session Token (optional): If you are using temporary credentials to access your services, you will need to inform the AWS Access Key ID and AWS Secrets Access Key. Also, these will include an AWS Session Token.

    You can find more information on Using temporary credentials with AWS resources.

    • 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. But you can specify an alternate endpoint for your API requests.

    Find more information on AWS service endpoints.

    • Profile Name: A named profile is a collection of settings and credentials that you can apply to a 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.

    You can inform this field if you'd like to use a profile other than default.

    Find here more information about Named profiles for the AWS CLI.

    • 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 allows the user to 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.

    {%note%} 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 OpenMetadata will assume.
      {%/note%}

    • 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, we'll use the name OpenMetadataSession.

    Find more information about the Role Session Name.

    • Assume Role Source Identity: The source identity specified by the principal that is calling the AssumeRole operation. You can use source identity information in AWS CloudTrail logs to determine who took actions with a role.

    Find more information about Source Identity.

• 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

In order to integrate SSL in the Metadata Ingestion Config, the user will have to add the SSL config under sslConfig which is placed in the source.

{% partial file="/v1.7/connectors/database/advanced-configuration.md" /%}

{% /extraContent %}

{% partial file="/v1.7/connectors/test-connection.md" /%}

{% partial file="/v1.7/connectors/database/configure-ingestion.md" /%}

{% partial file="/v1.7/connectors/ingestion-schedule-and-deploy.md" /%}

{% /stepsContainer %}

Securing PostgreSQL Connection with SSL in OpenMetadata

To establish secure connections between OpenMetadata 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.

{% note %}

For IAM authentication, it is recommended to choose the allow mode or another SSL mode that fits your specific requirements.

{% /note %}

{% image src="/images/v1.7/connectors/ssl_connection.png" alt="SSL Configuration" height="450px" caption="SSL Configuration" /%}

{% partial file="/v1.7/connectors/database/related.md" /%}

Reverse Metadata

{% note %} This feature is specific to Collate and requires the Collate Enterprise License. {% /note %}

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.

Examples will be provided in a future update.

Requirements for Reverse Metadata

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

• SUPERUSER privilege to the user

-- Grant superuser privilege to the user
ALTER ROLE USER_NAME SUPERUSER;

For more details about reverse metadata ingestion, visit our Reverse Metadata Documentation.