GitHub

Connection

API reference for Connection.

Runs SQL on one database connection. params are bound to the placeholders in order; transform_rows, when given, renames the result's columns.

Functions

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]: ...

execute_raw

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

The driver's own result, as it is.

ParameterTypeDescription
sqlstr
paramsSequence[object]

Returns Effect[object, SqlError]

def execute_raw(self, sql: str, params: Sequence[object], /) -> Effect[object, SqlError]:
    """The driver's own result, as it is."""
    ...

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]: ...

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]: ...

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]: ...

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]: ...