Flow PHP

InsertOptions

Read onlyYes

FinalYes

Configuration options for INSERT operations in PostgreSQL loader.

Supports ON CONFLICT handling for upsert operations.

Properties

$conflictColumns : array<string|int, mixed>
$conflictConstraint : string|null
$skipConflicts : bool
$updateColumns : array<string|int, mixed>

Methods

__construct() : mixed
hasConflictHandling() : bool
skipConflicts() : self: Create options for skipping conflicting rows (ON CONFLICT DO NOTHING).
upsertOnColumns() : self: Create options for upserting on specific columns.
upsertOnConstraint() : self: Create options for upserting on a constraint.

$conflictColumns


        public
            array<string|int, mixed>
    $conflictColumns
     = []

$conflictConstraint


        public
            string|null
    $conflictConstraint
     = null

$skipConflicts


        public
            bool
    $skipConflicts
     = false

$updateColumns


        public
            array<string|int, mixed>
    $updateColumns
     = []

__construct()


    public
                    __construct([bool $skipConflicts = false ][, array<int, string> $conflictColumns = [] ][, null|string $conflictConstraint = null ][, array<int, string> $updateColumns = [] ]) : mixed

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)

hasConflictHandling()


    public
                    hasConflictHandling() : bool

Return values

bool

skipConflicts()

Create options for skipping conflicting rows (ON CONFLICT DO NOTHING).


    public
            static        skipConflicts() : self

Return values

self

upsertOnColumns()

Create options for upserting on specific columns.


    public
            static        upsertOnColumns(array<int, string> $columns[, array<int, string> $updateColumns = [] ]) : self

Parameters

$columns : array<int, string>: Columns to detect conflicts on
$updateColumns : array<int, string> = []: Columns to update on conflict (empty = all non-key columns)

Return values

self

upsertOnConstraint()

Create options for upserting on a constraint.


    public
            static        upsertOnConstraint(string $constraintName[, array<int, string> $updateColumns = [] ]) : self

Parameters

$constraintName : string: Name of the constraint to detect conflicts on
$updateColumns : array<int, string> = []: Columns to update on conflict (empty = all non-key columns)

Return values

self