README

PostgreSQL connector for the EasySQL PHP SDK — local schema introspection and SELECT execution.

Installation

composer require clearsoft/easysql-connectors-postgres

Requirements: PHP >= 8.2, ext-pdo, ext-pdo_pgsql.

Usage

use Clearsoft\EasySQL\Connectors\Postgres\ConnectionConfig;
use Clearsoft\EasySQL\Connectors\Postgres\Connector;

$connector = new Connector(new ConnectionConfig(
    host: '127.0.0.1',   // default
    port: 5432,          // default
    user: 'postgres',    // default
    password: 'secret',  // in-memory only — never written to disk or logged
    database: 'myapp',
    sslmode: 'prefer',   // libpq sslmode: disable|allow|prefer|require|verify-ca|verify-full
    schemas: ['public'], // schemas to introspect
    timeout: 10.0,       // seconds, default
));
$connector->connect();

try {
    $raw = $connector->introspect();          // raw shape for the schema-generation package
    $result = $connector->execute('SELECT * FROM users LIMIT 10', ['status' => 'active']);
    // ['columns' => [...], 'rows' => [...], 'row_count' => N, 'duration_ms' => M]
} finally {
    $connector->close();
}

Behavior

Credentials are supplied per connection and never written to disk, logged, or kept after close(). Driver error messages are sanitized (connection URIs and password=/pwd= assignments) before surfacing.
Introspection reads pg_catalog (pg_class/pg_namespace/pg_attribute/pg_attrdef/pg_constraint) for the configured schemas, excluding partitions; row counts come from reltuples (best effort).
Execution accepts SELECT/WITH/EXPLAIN/SHOW only (client-side safety check mirrors the server); uses prepared statements and returns typed rows.
No global state — several connections can be open at the same time.

Type mapping

Introspection returns the engine-native format_type() string unchanged, along with the postgresql engine identifier and column ordinal. clearsoft/easysql-schema-generation maps those values into the canonical API vocabulary: integer, bigint, smallint, decimal, float, boolean, string, text, binary, date, time, timestamp, interval, json, uuid, or unknown. PostgreSQL arrays map to json; unmapped types fall back to unknown.

Tests

./vendor/bin/phpunit --testsuite connectors-postgres
EASYSQL_TEST_POSTGRES=1 ./vendor/bin/phpunit --testsuite connectors-postgres  # + integration vs local PostgreSQL

Integration env vars: EASYSQL_TEST_POSTGRES_HOST/PORT/USER/PASSWORD/DATABASE/SSLMODE (defaults 127.0.0.1:5433/postgres/postgres/easysql_test/prefer — make db-up maps the container to host port 5433 to avoid clashing with a local PostgreSQL on 5432).

clearsoft / easysql-connectors-postgres

Package info

Security

Statistics