functions.php
Functions
from_pgsql_limit_offset()
from_pgsql_limit_offset(Client $client, string|SqlQuery $query[, int $pageSize = 1000 ][, int|null $maximum = null ]) : PostgreSqlLimitOffsetExtractor
Parameters
- $client : Client
- $query : string|SqlQuery
- $pageSize : int = 1000
- $maximum : int|null = null
Return values
PostgreSqlLimitOffsetExtractorfrom_pgsql_key_set()
from_pgsql_key_set(Client $client, string|SqlQuery $query, KeySet $keySet[, int $pageSize = 1000 ][, int|null $maximum = null ]) : PostgreSqlKeySetExtractor
Parameters
- $client : Client
- $query : string|SqlQuery
- $keySet : KeySet
- $pageSize : int = 1000
- $maximum : int|null = null
Return values
PostgreSqlKeySetExtractorpgsql_pagination_key_asc()
pgsql_pagination_key_asc(string $column) : Key
Parameters
- $column : string
Return values
Keypgsql_pagination_key_desc()
pgsql_pagination_key_desc(string $column) : Key
Parameters
- $column : string
Return values
Keypgsql_pagination_key_set()
pgsql_pagination_key_set(Key ...$keys) : KeySet
Parameters
- $keys : Key
Return values
KeySetto_pgsql_table()
to_pgsql_table(Client $client, string $table) : PostgreSqlLoader
Parameters
- $client : Client
- $table : string
Return values
PostgreSqlLoaderpgsql_insert_options()
Create insert options for PostgreSQL loader.
pgsql_insert_options([bool $skipConflicts = false ][, array<int, string> $conflictColumns = [] ][, null|string $conflictConstraint = null ][, array<int, string> $updateColumns = [] ]) : InsertOptions
Parameters
- $skipConflicts : bool = false
-
If true, use ON CONFLICT DO NOTHING
- $conflictColumns : array<int, string> = []
-
Column names for ON CONFLICT (columns)
- $conflictConstraint : null|string = null
-
Constraint name for ON CONFLICT ON CONSTRAINT
- $updateColumns : array<int, string> = []
-
Columns to update on conflict (empty = all non-key columns)
Return values
InsertOptionspgsql_update_options()
Create update options for PostgreSQL loader.
pgsql_update_options(array<int, string> $primaryKeys) : UpdateOptions
Parameters
- $primaryKeys : array<int, string>
-
Columns to use in WHERE clause for matching rows
Return values
UpdateOptionspgsql_delete_options()
Create delete options for PostgreSQL loader.
pgsql_delete_options(array<int, string> $primaryKeys) : DeleteOptions
Parameters
- $primaryKeys : array<int, string>
-
Columns to use in WHERE clause for matching rows