Table of Contents


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

PropertyValue
IdentifierPostgreSQL
NamePostgreSQL
DescriptionConnector for accessing PostgreSQL database tables.
Job TypesInbound Only
Order230
EnabledYes
LockedYes
Block UpdateNo
Single AuthenticationNo
Windows OnlyNo
Connector Version2025-03-12
HooksNone
Additional Job FieldsNone
Image

Authentication Methods

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

MethodIdentifierBase MethodScriptOrderEnabledConfig Fields
Username / PasswordPostgreSQL_userPostgreSQL_userpostgresql.php10Yes5

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)

OrderLabelTypeRequiredDefaultMax LenTooltip
10Source ServertextYes255Enter name of the source server
20Source Server PorttextYes54325Enter port number of the source server
30Source DB NametextYes255Enter name of the source database
40UsernametextYes1024Enter username of the database account
50PasswordpasswordYes64000Enter 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.

OrderLabelTypeRequiredDefaultTooltip
10Job DescriptiontextYesEnter description of the Job
20Job SchedulelookupYesDailySelect frequency Job should run
30EnabledradioYesYesChoose if Job is enabled
60Allow Empty TableradioYesYesChoose if an empty table is allowed
70Destination TabletextYesEnter name of the destination table
80Data IdentitytextNoEnter identity of the Job
90Data SelectiontextareaNoEnter connector specific data selection command of the Job
120Append New Data to Existing TablesradioNoNoChoose if new data will append to the existing destination table, or will create a new destination table
130Fields to IndextextNoEnter fields to index
150Request Unique Key FieldtextNoEnter request unique field key of the Job
160Request Sort By FieldtextNoEnter field to sort by
290Request LimittextNoEnter request limit of the Job
560OrdertextYesEnter 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 DescriptionDestination TableAPI End PointEnabledWhat It Pulls
1PostgreSQL Table Datapostgresql_dataNot setNoA 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

SettingValue
Order10
EnabledNo
Job ScheduleDaily (15 1 * * *)
Destination Tablepostgresql_data
Data Identitypostgresql_data
Allow Empty TableYes
Append Files to Same Destination TableNo
Append New Data to Existing TablesNo
Use Unparsed DataNo
Convert UUID-Keyed Objects to RowsNo
Ignore XML AttributesNo
Log Raw API CallsNo
Method TypeGET
Body Data Sending MethodJSON 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.

Last updated on 11/4/2026

Attachments