Class PostgreSQLCodeGenConnection

PostgreSQL implementation of CodeGenConnection. Wraps a pg.Pool and adapts it to the generic interface.

Parameter handling:

SQL Server uses @ParamName for parameter placeholders
PostgreSQL uses , , etc. for positional parameters
This implementation translates @ParamName references to positional `` parameters

Example

import pg from 'pg';
const pool = new pg.Pool({ connectionString: '...', });
const conn = new PostgreSQLCodeGenConnection(pool);

// Simple query
const result = await conn.query("SELECT id, name FROM entities");

// Parameterized query (uses @-prefix notation, auto-translated to $N)
const result2 = await conn.queryWithParams(
    "SELECT id FROM entities WHERE name = @Name",
    { Name: 'Users' }
);

Implements

CodeGenConnection

Index

Constructors

constructor

new PostgreSQLCodeGenConnection(pool: Pool): PostgreSQLCodeGenConnection
Parameters
- pool: Pool
Returns PostgreSQLCodeGenConnection
- Defined in CodeGenLib/src/Database/providers/postgresql/PostgreSQLCodeGenConnection.ts:69

Accessors

Dialect

get Dialect(): SQLDialect
The SQL dialect for this connection's platform. Exposes identifier quoting, timestamp expressions, etc. — used by callers (e.g. validator-function emission in EntitySubClassGeneratorBase) that need to author dialect-aware SQL but don't have access to a CodeGenDatabaseProvider instance.

Returns SQLDialect
Implementation of CodeGenConnection.Dialect
- Defined in CodeGenLib/src/Database/providers/postgresql/PostgreSQLCodeGenConnection.ts:74

Pool

get Pool(): Pool
Provides access to the underlying pg.Pool for cases where PostgreSQL-specific functionality is needed.

Returns Pool
- Defined in CodeGenLib/src/Database/providers/postgresql/PostgreSQLCodeGenConnection.ts:82

Methods

beginTransaction

beginTransaction(): Promise<CodeGenTransaction>
Begins a new database transaction.

Returns Promise<CodeGenTransaction>
A CodeGenTransaction handle for executing queries within the transaction.
Implementation of CodeGenConnection.beginTransaction
- Defined in CodeGenLib/src/Database/providers/postgresql/PostgreSQLCodeGenConnection.ts:112

executeStoredProcedure

executeStoredProcedure(
name: string,
params: Record<string, unknown>,
): Promise<CodeGenQueryResult>
Executes a stored procedure (SQL Server) or function call (PostgreSQL).
Parameters
- name: string
  The fully qualified routine name (e.g., "[dbo].[spCreateEntity]").
- params: Record<string, unknown>
  Named parameters for the routine.
Returns Promise<CodeGenQueryResult>
The query result with a recordset array.
Implementation of CodeGenConnection.executeStoredProcedure
- Defined in CodeGenLib/src/Database/providers/postgresql/PostgreSQLCodeGenConnection.ts:101

query

query(sql: string): Promise<CodeGenQueryResult>
Executes a SQL query without parameters.
Parameters
- sql: string
  The SQL statement to execute.
Returns Promise<CodeGenQueryResult>
The query result with a recordset array.
Implementation of CodeGenConnection.query
- Defined in CodeGenLib/src/Database/providers/postgresql/PostgreSQLCodeGenConnection.ts:86

queryWithParams

queryWithParams(
sql: string,
params: Record<string, unknown>,
): Promise<CodeGenQueryResult>
Executes a SQL query with named parameters. Parameters are passed as key-value pairs and the implementation is responsible for binding them safely (e.g.,
Parameters
- sql: string
  The SQL statement with parameter placeholders.
- params: Record<string, unknown>
  Named parameters as key-value pairs.
Returns Promise<CodeGenQueryResult>
The query result with a recordset array.

Name
for SQL Server, $1/$2 for PostgreSQL).

For SQL Server, the parameter names in the SQL should use @-prefix notation matching the keys in the params object. For PostgreSQL, the implementation translates @-prefixed names to $N notation.
Implementation of CodeGenConnection.queryWithParams
- Defined in CodeGenLib/src/Database/providers/postgresql/PostgreSQLCodeGenConnection.ts:95

Class PostgreSQLCodeGenConnection

Example

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns PostgreSQLCodeGenConnection

Accessors

Dialect

Returns SQLDialect

Pool

Returns Pool

Methods

beginTransaction

Returns Promise<CodeGenTransaction>

executeStoredProcedure

Parameters

Returns Promise<CodeGenQueryResult>

query

Parameters

Returns Promise<CodeGenQueryResult>

queryWithParams

Parameters

Returns Promise<CodeGenQueryResult>

Name

Settings

On This Page