Skip to main content

​
Overview

PostgreSQL is an advanced open-source relational database that supports both SQL (relational) and JSON (non-relational) querying. Datazone provides native integration with PostgreSQL databases, allowing you to easily connect and extract data from your PostgreSQL instances.

​
Connection Parameters

Set on the source when you create it. Names match the API and CLI payload.
​
string
required
Name — a unique identifier for your PostgreSQL source.
​
string
required
Host — hostname or IP address of your PostgreSQL server.
​
string
required
Port — port the server listens on. Defaults to 5432 when omitted.
​
string
required
Database Name — the database to connect to.
​
string
default:"public"
Schema Name — schema that extracts resolve table names within.
​
string
required
User — username with read permission on the tables you intend to extract.
​
string
required
Password — password for the specified user. Stored encrypted.

​
Extract Parameters

Set per extract, in source_parameters. See Shared Extract Parameters for mode, replication_key, and schema_mapping.
​
string
required
Table Name — the table or view to extract, resolved within the source’s schema_name.
​
integer
default:"1000000"
Rows fetched and written per batch.
​
string
default:"*"
Columns to read, as a comma-separated list.
​
string
Row filter pushed down to PostgreSQL, written without the WHERE keyword — for example status = 'active'.

​
Required Permissions

The PostgreSQL user account needs the following permissions:
  • SELECT - For reading data from tables
  • USAGE - For accessing schemas
  • CONNECT - For connecting to the database

​
Limitations

Be aware of the following limitations when working with PostgreSQL sources:
  • Supported PostgreSQL versions: 9.6 and above
  • Some PostgreSQL-specific types will be converted to standard types

​
Next Steps

After configuring your PostgreSQL source:
  1. Create extracts to specify which tables to ingest
  2. Configure scheduling for recurring extracts
  3. Integrate the source into your data pipelines
For more information about working with extracts and pipelines, refer to their respective documentation sections.