Skip to main content
This gem runs in .
This page describes how to configure PostgreSQL Source and Target gems, including connection setup, schema options, and available write modes. Use the Postgres Source or Target gem to read from or write to a PostgreSQL database within your pipeline.

Create a Postgres gem

To create a Postgres Source or Target gem in your pipeline:
1

Add a Source or Target gem to the pipeline

  1. Open your pipeline in the Studio.
  2. Click on Source/Target in the canvas.
  3. Select Source or Target from the dropdown.
  4. Click on the gem to open the configuration.
2

Select Postgres format

In the Type tab, select Postgres. Then, click Next.
3

Set location details

In the Location tab, set your connection details and table location. To learn more, jump to Source location and Target location.
4

Set table properties

In the Properties tab, set the table properties. To learn more, jump to Source properties and Target properties.
5

Preview data (Source only)

In the Preview tab, load a sample of the data and verify that it looks correct.

Source configuration

Use these settings to configure a Postgres Source gem for reading data.

Source location

ParameterDescription
Format typeTable format for the source. For PostgreSQL tables, set to postgres.
Select or create connectionSelect or create a new Postgres connection in the Prophecy fabric you will use.
SchemaSchema containing the table you want to read from.
NameExact name of the PostgreSQL table to read data from.
QuerySQL query to read data from. If provided, this takes precedence over the schema and table name fields.

Source properties

Infer or manually configure the schema of your Source gem. Optionally, add a description for your table. Additional properties are not supported at this time.

Target configuration

Use these settings to configure a Postgres Target gem for writing data.

Target location

ParameterDescription
Format typeTable format for the target. For PostgreSQL tables, set to postgres.
Select or create connectionSelect or create a new Postgres connection in the Prophecy fabric you will use.
SchemaSchema where the target table resides or will be created.
NameName of the PostgreSQL table to write data to. If the table doesn’t exist, it will be created automatically.

Target properties

PropertyDescriptionDefault
DescriptionDescription of the table.None
Write ModeWhether to overwrite the table, append new data to the table, or throw an error if the table exists.None

Configure a Postgres connection

Use these settings to create a Postgres connection:
ParameterDescription
Connection NameName for the connection.
ServerPostgreSQL server hostname or IP address.
PortPort used to connect to the PostgreSQL server.
DatabasePostgreSQL database name.
UsernameUsername used for pipeline development and scheduled execution.
PasswordPassword used for pipeline development and scheduled execution.
Knowledge Graph IndexerChoose whether to enable the Knowledge Graph Indexer for this connection.