interfaceCopySupport

packages/ztd-query-core/src/Platform/CopySupport.php:16

interface CopySupport

How a dialect writes COPY, where it has one at all.

COPY moves rows in and out of a table without a statement per row, so simulating it means knowing how the rows are written, how they are read back, and what the statement is written against.

Methods§

public function tableName(string $relation): string

source §

Table name.

Parameters

$relation string

Returns

string

public function target(
    string $relation,
    ?string $fields,
    TableDefinition $definition,
): CopyTarget

source §

Target.

Parameters

`$relation`	`string`
`$fields`	`?string`
`$definition`	`TableDefinition`

Returns

CopyTarget

public function selectSql(CopyTarget $target): string

source §

Select sql.

Parameters

$target CopyTarget

Returns

string

public function insertSql(CopyTarget $target, int $rowCount, bool $overrideSystemValue): string

source §

Insert sql.

Parameters

`$target`	`CopyTarget`
`$rowCount`	`int`
`$overrideSystemValue`	`bool`

Returns

string

public function encodeRow(list<mixed> $values, string $separator, string $nullAs): string

source §

Parameters

`$values`	`list<mixed>`
`$separator`	`string`
`$nullAs`	`string`

Returns

string

public function decodeRow(string $row, string $separator, string $nullAs): list<string|null>

source §

Parameters

`$row`	`string`
`$separator`	`string`
`$nullAs`	`string`

Returns

list<string|null>

public function isCopyStatement(string $sql): bool

source §

Reports whether copy statement.

Parameters

$sql string

Returns

bool

Test cases 5§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Other tests reaching this symbol 5

Relations§

Implemented by 2

Type declarations 4