Postgres

Use the Postgres Connector to send data from Decodable to Postgres. The Postgres connector connects to a Postgres table through Postgres JDBC connections. If you are looking for instructions on how to get data from Postgres into Decodable, see Postgres CDC.

Overview

Connector name

postgres

Type

sink

Delivery guarantee

exactly once

Prerequisites

In order for Decodable to connect to a PostgreSQL database server successfully, the following must be true:

  • Your JDBC connection must be publicly accessible. Decodable will establish a connection to the Postgres database by using a username and password to authenticate.

  • The Postgres user must have select, update, delete, and insert permissions for the table that you want to send data to.

Steps

Follow these steps to get data into PostgreSQL from Decodable. These steps assume that you are using the Decodable web interface. However, if you want to use the Decodable CLI to create the connection, you can refer to the Property Name column for information about what the underlying property names are.

  1. From the Connections page, select the Postgres Connector and complete the following fields.

    UI Field Property Name in the Decodable CLI Description

    Host

    hostname

    The IP address or host name of the PostgreSQL database server.

    Port

    port

    Optional. The port number of the PostgreSQL database server.

    Defaults to 5432.

    Database

    database-name

    The name of the Postgres database.

    Schema

    schema-name

    Optional. The schema containing your database table. Defaults to public.

    Table Name

    table-name

    The table in the destination database you want to send data to.

    Username

    username

    The username to use when connecting to the Postgres database.

    Password

    password

    The secret containing the password credentials. If you are using the Decodable CLI, run decodable secret list to view available secrets or decodable secret --help for help with creating a new secret.

    Note: For security purposes, Decodable will never display secret values in plaintext. You can manage which users have permissions to create, delete, or modify secrets in the Access Control management view. See Roles, groups, and permissions for more information.

    JDBC Options

    properties.jdbc.options

    Optional. Any additional JDBC options that you want this connection to use. See Connection Parameters in the JDBC documentation for a full list of available JDBC options.

  2. Select the stream that you’d like to connect to this connector. This will be the stream that contains data that you want to send from Decodable into Postgres. Then, select Next.

  3. Define the connection’s schema. Select New Schema to manually enter the fields and field types present or Import Schema if you want to paste the schema in the form of an Avro or JSON array.

    1. The stream’s schema must match the schema of the data that you plan on sending through this connection.

    2. For more information about creating a stream or defining the stream schema, see Create and manage streams.

  4. Select Next when you are finished providing defining the connection’s schema.

  5. Give the newly created connection a Name and Description and select Save.