Search Knowledge Base by Keyword

PostgreSQL

< Back

Overview

PostgreSQL is the open-source relational database that has become the default choice for new enterprise applications and for the back end of packaged platforms and virtual appliances. In a typical estate it sits under orchestration, monitoring and observability tooling, under cloud-native internal applications, and inside vendor appliances that expose a read-only database account for reporting. Where a Windows estate would put SQL Server, a modern Linux estate increasingly puts PostgreSQL.

The ReadyWorks connector connects directly to a PostgreSQL server over the network using the postgresql.php driver and a role name and password. A job carries a SQL statement in its Data Selection field, ReadyWorks runs it, and the result set is written to the destination staging table with one column per selected column.

This is the route to data that a platform holds but does not publish. An appliance that reports device state, capacity or licence consumption through a console can usually be read at the database instead, which gives the data fabric the full detail rather than the console’s summary. Staged alongside device and identity data, it feeds the same reconciliation and planning workflows as any API-sourced connector.

The connector is inbound only. It reads query results and writes staging tables, and it issues no writes to the source database.

NOTE: Give ReadyWorks a dedicated role with SELECT only on the tables it needs. PostgreSQL privileges are granular, so this is straightforward to scope.

Connector Properties

Property Value
Identifier PostgreSQL
Name PostgreSQL
Description Connector for accessing PostgreSQL database tables.
Job Types Inbound Only
Order 230
Enabled Yes
Locked Yes
Block Update No
Single Authentication No
Windows Only No
Connector Version 2025-03-12
Hooks None
Additional Job Fields None
Image

Authentication Methods

One method ships: a direct network connection with a PostgreSQL role name and password.

Method Identifier Base Method Script Order Enabled Config Fields
Username / Password PostgreSQL_user PostgreSQL_user postgresql.php 10 Yes 5

NOTE: The form takes a database name and no schema. Unqualified table names in a job’s SQL resolve against the connecting role’s default search path, which on many installations is public only. Qualify tables as schema.table in the Data Selection when the data lives in an application schema.

NOTE: The form has no field for SSL mode, certificate verification or a CA bundle. Place the ReadyWorks server and the PostgreSQL server on a network path you trust.

Method 1: Username / Password (PostgreSQL_user)

Connect to a PostgreSQL Server

Username / Password connects to the PostgreSQL server named in Source Server on the port given in Source Server Port (the default is 5432), authenticates with the supplied role and password, and connects to the database named in Source DB Name. All five fields are required. The password is stored encrypted.

Connection Configuration Fields (5)

Order Label Type Required Default Max Len Tooltip
10 Source Server text Yes 255 Enter name of the source server
20 Source Server Port text Yes 5432 5 Enter port number of the source server
30 Source DB Name text Yes 255 Enter name of the source database
40 Username text Yes 1024 Enter username of the database account
50 Password password Yes 64000 Enter password of the database account

No authentication recipe is stored. The driver script authenticates natively using the fields above.

Inbound Job Fields Enabled (13)

These are the job-level settings exposed for a PostgreSQL extract. Data Selection holds the SQL statement.

Order Label Type Required Default Tooltip
10 Job Description text Yes Enter description of the Job
20 Job Schedule lookup Yes Daily Select frequency Job should run
30 Enabled radio Yes Yes Choose if Job is enabled
60 Allow Empty Table radio Yes Yes Choose if an empty table is allowed
70 Destination Table text Yes Enter name of the destination table
80 Data Identity text No Enter identity of the Job
90 Data Selection textarea No Enter connector specific data selection command of the Job
120 Append New Data to Existing Tables radio No No Choose if new data will append to the existing destination table, or will create a new destination table
130 Fields to Index text No Enter fields to index
150 Request Unique Key Field text No Enter request unique field key of the Job
160 Request Sort By Field text No Enter field to sort by
290 Request Limit text No Enter request limit of the Job
560 Order text Yes Enter order of the Job

Inbound Job Templates (1)

One inbound template ships as a worked example. It arrives disabled and carries a placeholder query, so it is a pattern to copy rather than a job to enable.

# Job Description Destination Table API End Point Enabled What It Pulls
1 PostgreSQL Table Data postgresql_data Not set No A skeleton job carrying the statement SELECT * FROM {tablename} and writing to the postgresql_data staging table. Replace the statement, the destination table and the data identity with your own.

Job Template Configuration

Settings

Setting Value
Order 10
Enabled No
Job Schedule Daily (15 1 * * *)
Destination Table postgresql_data
Data Identity postgresql_data
Allow Empty Table Yes
Append Files to Same Destination Table No
Append New Data to Existing Tables No
Use Unparsed Data No
Convert UUID-Keyed Objects to Rows No
Ignore XML Attributes No
Log Raw API Calls No
Method Type GET
Body Data Sending Method JSON Encoded Data

Job Parameters and Enumeration

PostgreSQL Table Data

Data Selection: SELECT * FROM {tablename}

Outbound Job Templates (0)

This connector ships no outbound templates and does not support outbound jobs.

Tags: