GitHub

PgSqlConnection

API reference for PgSqlConnection.

A Connection on a session; with stream_acquirer, each stream runs on a session of its own.

Attributes

AttributeTypeDescription
connection= connection
stream_acquirer= stream_acquirer

Functions

__init__

__init__(connection, stream_acquirer=None) -> None
ParameterTypeDescription
connectionPgConnection
stream_acquirerEffect[PgConnection, SqlError, Scope] | None = None
def __init__(
    self,
    connection: PgConnection,
    stream_acquirer: Effect[PgConnection, SqlError, Scope] | None = None,
) -> None:
    self.connection = connection
    self.stream_acquirer = stream_acquirer

execute

execute(sql, params, transform_rows) -> Effect[Sequence[Row], SqlError]
ParameterTypeDescription
sqlstr
paramsSequence[object]
transform_rowsTransformRows | None

Returns Effect[Sequence[Row], SqlError]

def execute(
    self, sql: str, params: Sequence[object], transform_rows: TransformRows | None, /
) -> Effect[Sequence[Row], SqlError]:
    return self._rows(sql, params, True, transform_rows)

execute_unprepared

execute_unprepared(sql, params, transform_rows) -> Effect[Sequence[Row], SqlError]
ParameterTypeDescription
sqlstr
paramsSequence[object]
transform_rowsTransformRows | None

Returns Effect[Sequence[Row], SqlError]

def execute_unprepared(
    self, sql: str, params: Sequence[object], transform_rows: TransformRows | None, /
) -> Effect[Sequence[Row], SqlError]:
    return self._rows(sql, params, False, transform_rows)

execute_raw

execute_raw(sql, params) -> Effect[object, SqlError]

The statement's Result.

ParameterTypeDescription
sqlstr
paramsSequence[object]

Returns Effect[object, SqlError]

def execute_raw(self, sql: str, params: Sequence[object], /) -> Effect[object, SqlError]:
    """The statement's ``Result``."""
    return self.connection.query(sql, params)

execute_values

execute_values(sql, params) -> Effect[Sequence[ValueRow], SqlError]
ParameterTypeDescription
sqlstr
paramsSequence[object]

Returns Effect[Sequence[ValueRow], SqlError]

def execute_values(
    self, sql: str, params: Sequence[object], /
) -> Effect[Sequence[ValueRow], SqlError]:
    return self.connection.query_values(sql, params)

execute_values_unprepared

execute_values_unprepared(sql, params) -> Effect[Sequence[ValueRow], SqlError]
ParameterTypeDescription
sqlstr
paramsSequence[object]

Returns Effect[Sequence[ValueRow], SqlError]

def execute_values_unprepared(
    self, sql: str, params: Sequence[object], /
) -> Effect[Sequence[ValueRow], SqlError]:
    return self.connection.query_values(sql, params, False)

execute_stream

execute_stream(sql, params, transform_rows) -> Stream[Row, SqlError]
ParameterTypeDescription
sqlstr
paramsSequence[object]
transform_rowsTransformRows | None

Returns Stream[Row, SqlError]

def execute_stream(
    self, sql: str, params: Sequence[object], transform_rows: TransformRows | None, /
) -> Stream[Row, SqlError]:
    from pyfect import stream

    if self.stream_acquirer is None:
        rows: Stream[Row, SqlError] = self.connection.stream(sql, params)
    else:
        rows = stream.unwrap(self.stream_acquirer.map(lambda c: c.stream(sql, params)))
    if transform_rows is None:
        return rows
    transform = transform_rows
    return rows.map_array(lambda chunk: tuple(transform(chunk)))