Flow PHP

df()

Alias for data_frame() : Flow.


    
                    df([Config|ConfigBuilder|null $config = null ]) : Flow

Parameters

$config : Config|ConfigBuilder|null = null

Return values

Flow

data_frame()


    
                    data_frame([Config|ConfigBuilder|null $config = null ]) : Flow

Parameters

$config : Config|ConfigBuilder|null = null

Return values

Flow

telemetry_options()


    
                    telemetry_options([bool $trace_loading = false ][, bool $trace_transformations = false ][, bool $trace_cache = false ][, bool $collect_metrics = false ][, FilesystemTelemetryOptions|null $filesystem = null ]) : TelemetryOptions

Parameters

$trace_loading : bool = false
$trace_transformations : bool = false
$trace_cache : bool = false
$collect_metrics : bool = false
$filesystem : FilesystemTelemetryOptions|null = null

Return values

TelemetryOptions

from_rows()


    
                    from_rows(Rows ...$rows) : RowsExtractor

Parameters

$rows : Rows

Return values

RowsExtractor

from_path_partitions()


    
                    from_path_partitions(Path|string $path) : PathPartitionsExtractor

Parameters

$path : Path|string

Return values

PathPartitionsExtractor

from_array()


    
                    from_array(iterable<string|int, array<string|int, mixed>> $array[, null|Schema $schema = null ]) : ArrayExtractor

Parameters

$array : iterable<string|int, array<string|int, mixed>>

$schema : null|Schema = null

@deprecated use withSchema() method instead

Return values

ArrayExtractor

from_cache()


    
                    from_cache(string $id[, null|Extractor $fallback_extractor = null ][, bool $clear = false ]) : CacheExtractor

Parameters

$id : string

cache id from which data will be extracted

$fallback_extractor : null|Extractor = null

extractor that will be used when cache is empty - @deprecated use withFallbackExtractor() method instead

$clear : bool = false

clear cache after extraction - @deprecated use withClearOnFinish() method instead

Return values

CacheExtractor

from_all()


    
                    from_all(Extractor ...$extractors) : ChainExtractor

Parameters

$extractors : Extractor

Return values

ChainExtractor

from_memory()


    
                    from_memory(Memory $memory) : MemoryExtractor

Parameters

$memory : Memory

Return values

MemoryExtractor

files()


    
                    files(string|Path $directory) : FilesExtractor

Parameters

$directory : string|Path

Return values

FilesExtractor

filesystem_cache()


    
                    filesystem_cache([Path|string|null $cache_dir = null ][, Filesystem $filesystem = new NativeLocalFilesystem() ][, Serializer $serializer = new FloeSerializer() ]) : FilesystemCache

Parameters

$cache_dir : Path|string|null = null
$filesystem : Filesystem = new NativeLocalFilesystem()
$serializer : Serializer = new FloeSerializer()

Return values

FilesystemCache

batched_by()


    
                    batched_by(Extractor $extractor, string|Reference $column[, null|int<1, max> $min_size = null ]) : BatchByExtractor

Parameters

$extractor : Extractor
$column : string|Reference
$min_size : null|int<1, max> = null

Return values

BatchByExtractor

batches()


    
                    batches(Extractor $extractor, int<1, max> $size) : BatchExtractor

Parameters

$extractor : Extractor
$size : int<1, max>

Return values

BatchExtractor

from_pipeline()


    
                    from_pipeline(Pipeline $pipeline) : PipelineExtractor

Parameters

$pipeline : Pipeline

Return values

PipelineExtractor

from_data_frame()


    
                    from_data_frame(DataFrame $data_frame) : DataFrameExtractor

Parameters

$data_frame : DataFrame

Return values

DataFrameExtractor

from_sequence_date_period()


    
                    from_sequence_date_period(string $entry_name, DateTimeInterface $start, DateInterval $interval, DateTimeInterface $end[, int $options = 0 ]) : SequenceExtractor

Parameters

$entry_name : string
$start : DateTimeInterface
$interval : DateInterval
$end : DateTimeInterface
$options : int = 0

Return values

SequenceExtractor

from_sequence_date_period_recurrences()


    
                    from_sequence_date_period_recurrences(string $entry_name, DateTimeInterface $start, DateInterval $interval, int $recurrences[, int $options = 0 ]) : SequenceExtractor

Parameters

$entry_name : string
$start : DateTimeInterface
$interval : DateInterval
$recurrences : int
$options : int = 0

Return values

SequenceExtractor

from_sequence_number()


    
                    from_sequence_number(string $entry_name, string|int|float $start, string|int|float $end[, int|float $step = 1 ]) : SequenceExtractor

Parameters

$entry_name : string
$start : string|int|float
$end : string|int|float
$step : int|float = 1

Return values

SequenceExtractor

to_callable()


    
                    to_callable(callable $callable) : CallbackLoader

Parameters

$callable : callable

Return values

CallbackLoader

to_memory()


    
                    to_memory(Memory $memory) : MemoryLoader

Parameters

$memory : Memory

Return values

MemoryLoader

to_array()

Convert rows to an array and store them in passed array variable.


    
                    to_array(array<string|int, mixed> &$array) : ArrayLoader

Parameters

$array : array<string|int, mixed>

Tags

Return values

ArrayLoader

to_output()


    
                    to_output([int|bool $truncate = 20 ][, Output $output = Output::rows ][, Formatter $formatter = new AsciiTableFormatter() ][, SchemaFormatter $schemaFormatter = new ASCIISchemaFormatter() ]) : StreamLoader

Parameters

$truncate : int|bool = 20
$output : Output = Output::rows
$formatter : Formatter = new AsciiTableFormatter()
$schemaFormatter : SchemaFormatter = new ASCIISchemaFormatter()

Return values

StreamLoader

to_stderr()


    
                    to_stderr([int|bool $truncate = 20 ][, Output $output = Output::rows ][, Formatter $formatter = new AsciiTableFormatter() ][, SchemaFormatter $schemaFormatter = new ASCIISchemaFormatter() ]) : StreamLoader

Parameters

$truncate : int|bool = 20
$output : Output = Output::rows
$formatter : Formatter = new AsciiTableFormatter()
$schemaFormatter : SchemaFormatter = new ASCIISchemaFormatter()

Return values

StreamLoader

to_stdout()


    
                    to_stdout([int|bool $truncate = 20 ][, Output $output = Output::rows ][, Formatter $formatter = new AsciiTableFormatter() ][, SchemaFormatter $schemaFormatter = new ASCIISchemaFormatter() ]) : StreamLoader

Parameters

$truncate : int|bool = 20
$output : Output = Output::rows
$formatter : Formatter = new AsciiTableFormatter()
$schemaFormatter : SchemaFormatter = new ASCIISchemaFormatter()

Return values

StreamLoader

to_stream()


    
                    to_stream(string $uri[, int|bool $truncate = 20 ][, Output $output = Output::rows ][, string $mode = 'w' ][, Formatter $formatter = new AsciiTableFormatter() ][, SchemaFormatter $schemaFormatter = new ASCIISchemaFormatter() ]) : StreamLoader

Parameters

$uri : string
$truncate : int|bool = 20
$output : Output = Output::rows
$mode : string = 'w'
$formatter : Formatter = new AsciiTableFormatter()
$schemaFormatter : SchemaFormatter = new ASCIISchemaFormatter()

Return values

StreamLoader

to_transformation()


    
                    to_transformation(Transformer|Transformation $transformer, Loader $loader) : TransformerLoader

Parameters

$transformer : Transformer|Transformation
$loader : Loader

Return values

TransformerLoader

to_branch()


    
                    to_branch(ScalarFunction $condition, Loader $loader) : BranchingLoader

Parameters

$condition : ScalarFunction
$loader : Loader

Return values

BranchingLoader

rename_style()


    
                    rename_style(StringStyles $style) : RenameCaseEntryStrategy

Parameters

$style : StringStyles

Return values

RenameCaseEntryStrategy

rename_replace()


    
                    rename_replace(array<string|int, string>|string $search, array<string|int, string>|string $replace) : RenameReplaceEntryStrategy

Parameters

$search : array<string|int, string>|string
$replace : array<string|int, string>|string

Return values

RenameReplaceEntryStrategy

rename_map()


    
                    rename_map(array<string, string> $renames) : RenameMapEntryStrategy

Parameters

$renames : array<string, string>: Map of old_name => new_name

Return values

RenameMapEntryStrategy

bool_entry()


    
                    bool_entry(string $name, bool|null $value[, Metadata|null $metadata = null ]) : Entry)

Parameters

$name : string
$value : bool|null
$metadata : Metadata|null = null

Return values

Entry)

boolean_entry()


    
                    boolean_entry(string $name, bool|null $value[, Metadata|null $metadata = null ]) : Entry)

Parameters

$name : string
$value : bool|null
$metadata : Metadata|null = null

Return values

Entry)

datetime_entry()


    
                    datetime_entry(string $name, DateTimeInterface|string|null $value[, Metadata|null $metadata = null ]) : DateTimeInterface>)

Parameters

$name : string
$value : DateTimeInterface|string|null
$metadata : Metadata|null = null

Tags

Return values

DateTimeInterface>)

time_entry()


    
                    time_entry(string $name, DateInterval|string|null $value[, Metadata|null $metadata = null ]) : DateInterval>)

Parameters

$name : string
$value : DateInterval|string|null
$metadata : Metadata|null = null

Tags

Return values

DateInterval>)

date_entry()


    
                    date_entry(string $name, DateTimeInterface|string|null $value[, Metadata|null $metadata = null ]) : DateTimeInterface>)

Parameters

$name : string
$value : DateTimeInterface|string|null
$metadata : Metadata|null = null

Tags

Return values

DateTimeInterface>)

int_entry()


    
                    int_entry(string $name, int|null $value[, Metadata|null $metadata = null ]) : Entry)

Parameters

$name : string
$value : int|null
$metadata : Metadata|null = null

Return values

Entry)

integer_entry()


    
                    integer_entry(string $name, int|null $value[, Metadata|null $metadata = null ]) : Entry)

Parameters

$name : string
$value : int|null
$metadata : Metadata|null = null

Return values

Entry)

enum_entry()


    
                    enum_entry(string $name, UnitEnum|null $enum[, Metadata|null $metadata = null ]) : UnitEnum>)

Parameters

$name : string
$enum : UnitEnum|null
$metadata : Metadata|null = null

Return values

UnitEnum>)

float_entry()


    
                    float_entry(string $name, float|int|string|null $value[, Metadata|null $metadata = null ]) : Entry)

Parameters

$name : string
$value : float|int|string|null
$metadata : Metadata|null = null

Return values

Entry)

json_entry()


    
                    json_entry(string $name, null|array<string|int, mixed>|Json|string $data[, Metadata|null $metadata = null ]) : Json>)

Parameters

$name : string
$data : null|array<string|int, mixed>|Json|string
$metadata : Metadata|null = null

Tags

Return values

Json>)

json_object_entry()


    
                    json_object_entry(string $name, null|array<string|int, mixed>|Json|string $data[, Metadata|null $metadata = null ]) : Json>)

Parameters

$name : string
$data : null|array<string|int, mixed>|Json|string
$metadata : Metadata|null = null

Tags

Return values

Json>)

str_entry()


    
                    str_entry(string $name, string|null $value[, Metadata|null $metadata = null ]) : Entry)

Parameters

$name : string
$value : string|null
$metadata : Metadata|null = null

Return values

Entry)

null_entry()

Creates an entry of the null type. Used when a column value is null and its final type is not yet known.


    
                    null_entry(string $name[, Metadata|null $metadata = null ]) : Entry<string|int, null>

When guessing a schema from rows, a null column stays a NullDefinition until a later row reveals a real type, at which point the schema merge turns it into that type made nullable.

Parameters

$name : string
$metadata : Metadata|null = null

Return values

Entry<string|int, null>

string_entry()


    
                    string_entry(string $name, string|null $value[, Metadata|null $metadata = null ]) : Entry)

Parameters

$name : string
$value : string|null
$metadata : Metadata|null = null

Return values

Entry)

uuid_entry()


    
                    uuid_entry(string $name, Uuid|string|null $value[, Metadata|null $metadata = null ]) : Uuid>)

Parameters

$name : string
$value : Uuid|string|null
$metadata : Metadata|null = null

Return values

Uuid>)

xml_entry()


    
                    xml_entry(string $name, DOMDocument|XMLDocument|string|null $value[, Metadata|null $metadata = null ]) : XMLDocument>)

Parameters

$name : string
$value : DOMDocument|XMLDocument|string|null
$metadata : Metadata|null = null

Tags

Return values

XMLDocument>)

xml_element_entry()


    
                    xml_element_entry(string $name, DOMElement|Element|string|null $value[, Metadata|null $metadata = null ]) : Element>)

Parameters

$name : string
$value : DOMElement|Element|string|null
$metadata : Metadata|null = null

Tags

Return values

Element>)

html_entry()


    
                    html_entry(string $name, HTMLDocument|string|null $value[, Metadata|null $metadata = null ]) : HTMLDocument>)

Parameters

$name : string
$value : HTMLDocument|string|null
$metadata : Metadata|null = null

Return values

HTMLDocument>)

html_element_entry()


    
                    html_element_entry(string $name, HTMLElement|string|null $value[, Metadata|null $metadata = null ]) : HTMLElement>)

Parameters

$name : string
$value : HTMLElement|string|null
$metadata : Metadata|null = null

Return values

HTMLElement>)

entries()


    
                    entries(Entry<string|int, mixed> ...$entries) : Entries

Parameters

$entries : Entry<string|int, mixed>

Return values

Entries

struct_entry()


    
                    struct_entry(string $name, TShape|null $value, StructureType<string|int, mixed>|Type<string|int, TShape> $type[, Metadata|null $metadata = null ]) : TShape>)

Parameters

$name : string
$value : TShape|null
$type : StructureType<string|int, mixed>|Type<string|int, TShape>
$metadata : Metadata|null = null

Tags

Return values

TShape>)

structure_entry()


    
                    structure_entry(string $name, TShape|null $value, StructureType<string|int, mixed>|Type<string|int, TShape> $type[, Metadata|null $metadata = null ]) : TShape>)

Parameters

$name : string
$value : TShape|null
$type : StructureType<string|int, mixed>|Type<string|int, TShape>
$metadata : Metadata|null = null

Tags

Return values

TShape>)

list_entry()


    
                    list_entry(string $name, null|array<int, mixed> $value, Type<string|int, mixed> $type[, Metadata|null $metadata = null ]) : Entry)

Parameters

$name : string
$value : null|array<int, mixed>
$type : Type<string|int, mixed>
$metadata : Metadata|null = null

Return values

Entry)

map_entry()


    
                    map_entry(string $name, array<string|int, mixed>|null $value, Type<string|int, mixed> $mapType[, Metadata|null $metadata = null ]) : Entry>)

Parameters

$name : string
$value : array<string|int, mixed>|null
$mapType : Type<string|int, mixed>
$metadata : Metadata|null = null

Return values

Entry>)

row()


    
                    row(Entry<string|int, mixed> ...$entry) : Row

Parameters

$entry : Entry<string|int, mixed>

Return values

Row

rows()


    
                    rows(Row ...$row) : Rows

Parameters

$row : Row

Return values

Rows

rows_partitioned()


    
                    rows_partitioned(array<string|int, Row> $rows, array<string|int, Partition|string>|Partitions $partitions) : Rows

Parameters

$rows : array<string|int, Row>
$partitions : array<string|int, Partition|string>|Partitions

Return values

Rows

col()

An alias for `ref`.


    
                    col(string $entry) : EntryReference

Parameters

$entry : string

Return values

EntryReference

entry()

An alias for `ref`.


    
                    entry(string $entry) : EntryReference

Parameters

$entry : string

Return values

EntryReference

ref()


    
                    ref(string $entry) : EntryReference

Parameters

$entry : string

Return values

EntryReference

structure_ref()


    
                    structure_ref(string $entry) : StructureFunctions

Parameters

$entry : string

Return values

StructureFunctions

list_ref()


    
                    list_ref(string $entry) : ListFunctions

Parameters

$entry : string

Return values

ListFunctions

refs()


    
                    refs(string|Reference ...$entries) : References

Parameters

$entries : string|Reference

Return values

References

select()


    
                    select(string|Reference ...$entries) : Select

Parameters

$entries : string|Reference

Return values

Select

drop()


    
                    drop(string|Reference ...$entries) : Drop

Parameters

$entries : string|Reference

Return values

Drop

add_row_index()


    
                    add_row_index([string $column = 'index' ][, StartFrom $startFrom = StartFrom::ZERO ]) : AddRowIndex

Parameters

$column : string = 'index'
$startFrom : StartFrom = StartFrom::ZERO

Return values

AddRowIndex

batch_size()


    
                    batch_size(int<1, max> $size) : BatchSize

Parameters

$size : int<1, max>

Return values

BatchSize

limit()


    
                    limit(int|null $limit) : Limit

Parameters

$limit : int|null

Return values

Limit

mask_columns()


    
                    mask_columns([array<int, string> $columns = [] ][, string $mask = '******' ]) : MaskColumns

Parameters

$columns : array<int, string> = []
$mask : string = '******'

Return values

MaskColumns

optional()


    
                    optional(ScalarFunction $function) : Optional

Parameters

$function : ScalarFunction

Return values

Optional

lit()


    
                    lit(mixed $value) : Literal

Parameters

$value : mixed

Return values

Literal

exists()


    
                    exists(ScalarFunction $ref) : Exists

Parameters

$ref : ScalarFunction

Return values

Exists

when()


    
                    when(mixed $condition, mixed $then[, mixed $else = null ]) : When

Parameters

$condition : mixed
$then : mixed
$else : mixed = null

Return values

When

array_get()


    
                    array_get(ScalarFunction $ref, ScalarFunction|string $path) : ArrayGet

Parameters

$ref : ScalarFunction
$path : ScalarFunction|string

Return values

ArrayGet

array_get_collection()


    
                    array_get_collection(ScalarFunction $ref, array<string|int, mixed>|ScalarFunction $keys) : ArrayGetCollection

Parameters

$ref : ScalarFunction
$keys : array<string|int, mixed>|ScalarFunction

Return values

ArrayGetCollection

array_get_collection_first()


    
                    array_get_collection_first(ScalarFunction $ref, string ...$keys) : ArrayGetCollection

Parameters

$ref : ScalarFunction
$keys : string

Return values

ArrayGetCollection

array_exists()


    
                    array_exists(array<string|int, mixed>|ScalarFunction $ref, ScalarFunction|string $path) : ArrayPathExists

Parameters

$ref : array<string|int, mixed>|ScalarFunction
$path : ScalarFunction|string

Return values

ArrayPathExists

array_merge()


    
                    array_merge(array<string|int, mixed>|ScalarFunction $left, array<string|int, mixed>|ScalarFunction $right) : ArrayMerge

Parameters

$left : array<string|int, mixed>|ScalarFunction
$right : array<string|int, mixed>|ScalarFunction

Return values

ArrayMerge

array_merge_collection()


    
                    array_merge_collection(array<string|int, mixed>|ScalarFunction $array) : ArrayMergeCollection

Parameters

$array : array<string|int, mixed>|ScalarFunction

Return values

ArrayMergeCollection

array_key_rename()


    
                    array_key_rename(ScalarFunction $ref, ScalarFunction|string $path, ScalarFunction|string $newName) : ArrayKeyRename

Parameters

$ref : ScalarFunction
$path : ScalarFunction|string
$newName : ScalarFunction|string

Return values

ArrayKeyRename

array_keys_style_convert()


    
                    array_keys_style_convert(ScalarFunction $ref[, StringStyles|string $style = StringStyles::SNAKE ]) : ArrayKeysStyleConvert

Parameters

$ref : ScalarFunction
$style : StringStyles|string = StringStyles::SNAKE

Return values

ArrayKeysStyleConvert

array_sort()


    
                    array_sort(ScalarFunction $function[, ScalarFunction|Sort|null $sort_function = null ][, ScalarFunction|int|null $flags = null ][, ScalarFunction|bool $recursive = true ]) : ArraySort

Parameters

$function : ScalarFunction
$sort_function : ScalarFunction|Sort|null = null
$flags : ScalarFunction|int|null = null
$recursive : ScalarFunction|bool = true

Return values

ArraySort

array_reverse()


    
                    array_reverse(array<string|int, mixed>|ScalarFunction $function[, ScalarFunction|bool $preserveKeys = false ]) : ArrayReverse

Parameters

$function : array<string|int, mixed>|ScalarFunction
$preserveKeys : ScalarFunction|bool = false

Return values

ArrayReverse

now()


    
                    now([DateTimeZone|ScalarFunction $time_zone = new DateTimeZone('UTC') ]) : Now

Parameters

$time_zone : DateTimeZone|ScalarFunction = new DateTimeZone('UTC')

Return values

Now

between()


    
                    between(mixed $value, mixed $lower_bound, mixed $upper_bound[, ScalarFunction|Boundary $boundary = Boundary::LEFT_INCLUSIVE ]) : Between

Parameters

$value : mixed
$lower_bound : mixed
$upper_bound : mixed
$boundary : ScalarFunction|Boundary = Boundary::LEFT_INCLUSIVE

Return values

Between

to_date_time()


    
                    to_date_time(mixed $ref[, ScalarFunction|string $format = 'Y-m-d H:i:s' ][, ScalarFunction|DateTimeZone $timeZone = new DateTimeZone('UTC') ]) : ToDateTime

Parameters

$ref : mixed
$format : ScalarFunction|string = 'Y-m-d H:i:s'
$timeZone : ScalarFunction|DateTimeZone = new DateTimeZone('UTC')

Return values

ToDateTime

to_date()


    
                    to_date(mixed $ref[, ScalarFunction|string $format = 'Y-m-d' ][, ScalarFunction|DateTimeZone $timeZone = new DateTimeZone('UTC') ]) : ToDate

Parameters

$ref : mixed
$format : ScalarFunction|string = 'Y-m-d'
$timeZone : ScalarFunction|DateTimeZone = new DateTimeZone('UTC')

Return values

ToDate

date_time_format()


    
                    date_time_format(ScalarFunction $ref, string $format) : DateTimeFormat

Parameters

$ref : ScalarFunction
$format : string

Return values

DateTimeFormat

split()


    
                    split(ScalarFunction|string $value, ScalarFunction|string $separator[, ScalarFunction|int $limit = PHP_INT_MAX ]) : Split

Parameters

$value : ScalarFunction|string
$separator : ScalarFunction|string
$limit : ScalarFunction|int = PHP_INT_MAX

Return values

Split

combine()


    
                    combine(array<string|int, mixed>|ScalarFunction $keys, array<string|int, mixed>|ScalarFunction $values) : Combine

Parameters

$keys : array<string|int, mixed>|ScalarFunction
$values : array<string|int, mixed>|ScalarFunction

Return values

Combine

concat()

Concat all values. If you want to concatenate values with separator use concat_ws function.


    
                    concat(ScalarFunction|string ...$functions) : Concat

Parameters

$functions : ScalarFunction|string

Return values

Concat

concat_ws()

Concat all values with separator.


    
                    concat_ws(ScalarFunction|string $separator, ScalarFunction|string ...$functions) : ConcatWithSeparator

Parameters

$separator : ScalarFunction|string
$functions : ScalarFunction|string

Return values

ConcatWithSeparator

hash()


    
                    hash(mixed $value[, Algorithm $algorithm = new NativePHPHash() ]) : Hash

Parameters

$value : mixed
$algorithm : Algorithm = new NativePHPHash()

Return values

Hash

cast()


    
                    cast(mixed $value, Type<string|int, mixed>|string $type) : Cast

Parameters

$value : mixed
$type : Type<string|int, mixed>|string

Return values

Cast

coalesce()


    
                    coalesce(ScalarFunction ...$values) : Coalesce

Parameters

$values : ScalarFunction

Return values

Coalesce

count()


    
                    count([EntryReference|null $function = null ]) : Count

Parameters

$function : EntryReference|null = null

Return values

Count

call()

Calls a user-defined function with the given parameters.


    
                    call(callable|ScalarFunction $callable[, array<string|int, mixed> $parameters = [] ][, null|Type<string|int, mixed> $return_type = null ]) : CallUserFunc

Parameters

$callable : callable|ScalarFunction
$parameters : array<string|int, mixed> = []
$return_type : null|Type<string|int, mixed> = null

Return values

CallUserFunc

array_unpack()


    
                    array_unpack(array<string|int, mixed>|ScalarFunction $array[, array<string|int, mixed>|ScalarFunction $skip_keys = [] ][, ScalarFunction|string|null $entry_prefix = null ]) : ArrayUnpack

Parameters

$array : array<string|int, mixed>|ScalarFunction
$skip_keys : array<string|int, mixed>|ScalarFunction = []
$entry_prefix : ScalarFunction|string|null = null

Return values

ArrayUnpack

array_expand()

Expands each value into entry, if there are more than one value, multiple rows will be created.


    
                    array_expand(ScalarFunction $function[, ArrayExpand $expand = ArrayExpand::VALUES ]) : ArrayExpand

Array keys are ignored, only values are used to create new rows.

Before: +--+-------------------+ |id| array| +--+-------------------+ | 1|{"a":1,"b":2,"c":3}| +--+-------------------+

After: +--+--------+ |id|expanded| +--+--------+ | 1| 1| | 1| 2| | 1| 3| +--+--------+

Parameters

$function : ScalarFunction
$expand : ArrayExpand = ArrayExpand::VALUES

Return values

ArrayExpand

size()


    
                    size(mixed $value) : Size

Parameters

$value : mixed

Return values

Size

uuid_v4()


    
                    uuid_v4() : Uuid

Return values

Uuid

uuid_v7()


    
                    uuid_v7([ScalarFunction|DateTimeInterface|null $value = null ]) : Uuid

Parameters

$value : ScalarFunction|DateTimeInterface|null = null

Return values

Uuid

ulid()


    
                    ulid([ScalarFunction|string|null $value = null ]) : Ulid

Parameters

$value : ScalarFunction|string|null = null

Return values

Ulid

lower()


    
                    lower(ScalarFunction|string $value) : ToLower

Parameters

$value : ScalarFunction|string

Return values

ToLower

capitalize()


    
                    capitalize(ScalarFunction|string $value) : Capitalize

Parameters

$value : ScalarFunction|string

Return values

Capitalize

upper()


    
                    upper(ScalarFunction|string $value) : ToUpper

Parameters

$value : ScalarFunction|string

Return values

ToUpper

all()


    
                    all(ScalarFunction ...$functions) : All

Parameters

$functions : ScalarFunction

Return values

All

any()


    
                    any(ScalarFunction ...$values) : Any

Parameters

$values : ScalarFunction

Return values

Any

not()


    
                    not(ScalarFunction $value) : Not

Parameters

$value : ScalarFunction

Return values

Not

to_timezone()


    
                    to_timezone(ScalarFunction|DateTimeInterface $value, ScalarFunction|DateTimeZone|string $timeZone) : ToTimeZone

Parameters

$value : ScalarFunction|DateTimeInterface
$timeZone : ScalarFunction|DateTimeZone|string

Return values

ToTimeZone

ignore_error_handler()


    
                    ignore_error_handler() : IgnoreError

Return values

IgnoreError

skip_rows_handler()


    
                    skip_rows_handler() : SkipRows

Return values

SkipRows

throw_error_handler()


    
                    throw_error_handler() : ThrowError

Return values

ThrowError

regex_replace()


    
                    regex_replace(ScalarFunction|string $pattern, ScalarFunction|string $replacement, ScalarFunction|string $subject[, ScalarFunction|int|null $limit = null ]) : RegexReplace

Parameters

$pattern : ScalarFunction|string
$replacement : ScalarFunction|string
$subject : ScalarFunction|string
$limit : ScalarFunction|int|null = null

Return values

RegexReplace

regex_match_all()


    
                    regex_match_all(ScalarFunction|string $pattern, ScalarFunction|string $subject[, ScalarFunction|int $flags = 0 ][, ScalarFunction|int $offset = 0 ]) : RegexMatchAll

Parameters

$pattern : ScalarFunction|string
$subject : ScalarFunction|string
$flags : ScalarFunction|int = 0
$offset : ScalarFunction|int = 0

Return values

RegexMatchAll

regex_match()


    
                    regex_match(ScalarFunction|string $pattern, ScalarFunction|string $subject[, ScalarFunction|int $flags = 0 ][, ScalarFunction|int $offset = 0 ]) : RegexMatch

Parameters

$pattern : ScalarFunction|string
$subject : ScalarFunction|string
$flags : ScalarFunction|int = 0
$offset : ScalarFunction|int = 0

Return values

RegexMatch

regex()


    
                    regex(ScalarFunction|string $pattern, ScalarFunction|string $subject[, ScalarFunction|int $flags = 0 ][, ScalarFunction|int $offset = 0 ]) : Regex

Parameters

$pattern : ScalarFunction|string
$subject : ScalarFunction|string
$flags : ScalarFunction|int = 0
$offset : ScalarFunction|int = 0

Return values

Regex

regex_all()


    
                    regex_all(ScalarFunction|string $pattern, ScalarFunction|string $subject[, ScalarFunction|int $flags = 0 ][, ScalarFunction|int $offset = 0 ]) : RegexAll

Parameters

$pattern : ScalarFunction|string
$subject : ScalarFunction|string
$flags : ScalarFunction|int = 0
$offset : ScalarFunction|int = 0

Return values

RegexAll

sprintf()


    
                    sprintf(ScalarFunction|string $format, ScalarFunction|float|int|string|null ...$args) : Sprintf

Parameters

$format : ScalarFunction|string
$args : ScalarFunction|float|int|string|null

Return values

Sprintf

sanitize()


    
                    sanitize(ScalarFunction|string $value[, ScalarFunction|string $placeholder = '*' ][, ScalarFunction|int|null $skipCharacters = null ]) : Sanitize

Parameters

$value : ScalarFunction|string
$placeholder : ScalarFunction|string = '*'
$skipCharacters : ScalarFunction|int|null = null

Return values

Sanitize

round()


    
                    round(ScalarFunction|int|float $value[, ScalarFunction|int $precision = 2 ][, ScalarFunction|int $mode = PHP_ROUND_HALF_UP ]) : Round

Parameters

$value : ScalarFunction|int|float
$precision : ScalarFunction|int = 2
$mode : ScalarFunction|int = PHP_ROUND_HALF_UP

Return values

Round

number_format()


    
                    number_format(ScalarFunction|int|float $value[, ScalarFunction|int $decimals = 2 ][, ScalarFunction|string $decimal_separator = '.' ][, ScalarFunction|string $thousands_separator = ',' ]) : NumberFormat

Parameters

$value : ScalarFunction|int|float
$decimals : ScalarFunction|int = 2
$decimal_separator : ScalarFunction|string = '.'
$thousands_separator : ScalarFunction|string = ','

Return values

NumberFormat

to_entry()


    
                    to_entry(string $name, array<string|int, mixed> $data[, EntryFactory $entryFactory = new EntryFactory() ]) : Entry<string|int, mixed>

Parameters

$name : string
$data : array<string|int, mixed>
$entryFactory : EntryFactory = new EntryFactory()

Return values

Entry<string|int, mixed>

array_to_row()


    
                    array_to_row(array<string|int, array<string|int, mixed>>|array<string|int, mixed|string> $data[, Hydrator $hydrator = new AdaptiveRowHydrator() ][, array<string|int, Partition>|Partitions $partitions = [] ][, null|Schema $schema = null ]) : Row

Parameters

$data : array<string|int, array<string|int, mixed>>|array<string|int, mixed|string>
$hydrator : Hydrator = new AdaptiveRowHydrator()
$partitions : array<string|int, Partition>|Partitions = []
$schema : null|Schema = null

Return values

Row

array_to_rows()


    
                    array_to_rows(array<string|int, array<string|int, mixed>>|array<string|int, mixed|string> $data[, Hydrator $hydrator = new AdaptiveRowHydrator() ][, array<string|int, Partition>|Partitions $partitions = [] ][, null|Schema $schema = null ]) : Rows

Parameters

$data : array<string|int, array<string|int, mixed>>|array<string|int, mixed|string>
$hydrator : Hydrator = new AdaptiveRowHydrator()
$partitions : array<string|int, Partition>|Partitions = []
$schema : null|Schema = null

Return values

Rows

rank()


    
                    rank() : Rank

Return values

Rank

dens_rank()


    
                    dens_rank() : DenseRank

Return values

DenseRank

dense_rank()


    
                    dense_rank() : DenseRank

Return values

DenseRank

average()


    
                    average(EntryReference|string $ref[, int $scale = 2 ][, Rounding $rounding = Rounding::HALF_UP ]) : Average

Parameters

$ref : EntryReference|string
$scale : int = 2
$rounding : Rounding = Rounding::HALF_UP

Return values

Average

greatest()


    
                    greatest(mixed ...$values) : Greatest

Parameters

$values : mixed

Return values

Greatest

least()


    
                    least(mixed ...$values) : Least

Parameters

$values : mixed

Return values

Least

collect()


    
                    collect(EntryReference|string $ref) : Collect

Parameters

$ref : EntryReference|string

Return values

Collect

string_agg()


    
                    string_agg(EntryReference|string $ref[, string $separator = ', ' ][, SortOrder|null $sort = null ]) : StringAggregate

Parameters

$ref : EntryReference|string
$separator : string = ', '
$sort : SortOrder|null = null

Return values

StringAggregate

collect_unique()


    
                    collect_unique(EntryReference|string $ref) : CollectUnique

Parameters

$ref : EntryReference|string

Return values

CollectUnique

window()


    
                    window() : Window

Return values

Window

unbounded_preceding()


    
                    unbounded_preceding() : FrameBound

Return values

FrameBound

preceding()


    
                    preceding(int $offset) : FrameBound

Parameters

$offset : int

Return values

FrameBound

current_row()


    
                    current_row() : FrameBound

Return values

FrameBound

following()


    
                    following(int $offset) : FrameBound

Parameters

$offset : int

Return values

FrameBound

unbounded_following()


    
                    unbounded_following() : FrameBound

Return values

FrameBound

sum()


    
                    sum(EntryReference|string $ref[, ScalarFunction|bool $exact = false ]) : Sum

Parameters

$ref : EntryReference|string
$exact : ScalarFunction|bool = false

Return values

Sum

first()


    
                    first(EntryReference|string $ref) : First

Parameters

$ref : EntryReference|string

Return values

First

last()


    
                    last(EntryReference|string $ref) : Last

Parameters

$ref : EntryReference|string

Return values

Last

max()


    
                    max(EntryReference|string $ref) : Max

Parameters

$ref : EntryReference|string

Return values

Max

min()


    
                    min(EntryReference|string $ref) : Min

Parameters

$ref : EntryReference|string

Return values

Min

row_number()


    
                    row_number() : RowNumber

Return values

RowNumber

schema()


    
                    schema(Definition<string|int, mixed> ...$definitions) : Schema

Parameters

$definitions : Definition<string|int, mixed>

Return values

Schema

schema_to_json()


    
                    schema_to_json(Schema $schema[, bool $pretty = false ]) : string

Parameters

$schema : Schema
$pretty : bool = false

Return values

string

schema_to_php()


    
                    schema_to_php(Schema $schema[, ValueFormatter $valueFormatter = new ValueFormatter() ][, TypeFormatter $typeFormatter = new TypeFormatter() ]) : string

Parameters

$schema : Schema
$valueFormatter : ValueFormatter = new ValueFormatter()
$typeFormatter : TypeFormatter = new TypeFormatter()

Return values

string

schema_to_ascii()


    
                    schema_to_ascii(Schema $schema[, SchemaFormatter|null $formatter = null ]) : string

Parameters

$schema : Schema
$formatter : SchemaFormatter|null = null

Return values

string

schema_validate()


    
                    schema_validate(Schema $expected, Schema $given[, SchemaValidator $validator = new StrictValidator() ]) : ValidationContext

Parameters

$expected : Schema
$given : Schema
$validator : SchemaValidator = new StrictValidator()

Return values

ValidationContext

schema_evolving_validator()


    
                    schema_evolving_validator() : EvolvingValidator

Return values

EvolvingValidator

schema_strict_validator()


    
                    schema_strict_validator() : StrictValidator

Return values

StrictValidator

schema_selective_validator()


    
                    schema_selective_validator() : SelectiveValidator

Return values

SelectiveValidator

schema_from_json()


    
                    schema_from_json(string $schema) : Schema

Parameters

$schema : string

Return values

Schema

schema_metadata()


    
                    schema_metadata([array<string, array<string|int, bool|float|int|string>|bool|float|int|string> $metadata = [] ]) : Metadata

Parameters

$metadata : array<string, array<string|int, bool|float|int|string>|bool|float|int|string> = []

Return values

Metadata

int_schema()

Alias for `integer_schema`.


    
                    int_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : IntegerDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

IntegerDefinition

integer_schema()


    
                    integer_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : IntegerDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

IntegerDefinition

str_schema()

Alias for `string_schema`.


    
                    str_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : StringDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

StringDefinition

string_schema()


    
                    string_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : StringDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

StringDefinition

bool_schema()


    
                    bool_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : BooleanDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

BooleanDefinition

float_schema()


    
                    float_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : FloatDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

FloatDefinition

map_schema()


    
                    map_schema(string $name, MapType|Type $type[, bool $nullable = false ][, Metadata|null $metadata = null ]) : MapDefinition<TKey, TValue>

Parameters

$name : string
$type : MapType|Type
$nullable : bool = false
$metadata : Metadata|null = null

Tags

Return values

MapDefinition<TKey, TValue>

list_schema()


    
                    list_schema(string $name, ListType<string|int, T>|Type<string|int, array<int, T>> $type[, bool $nullable = false ][, Metadata|null $metadata = null ]) : ListDefinition<string|int, T>

Parameters

$name : string
$type : ListType<string|int, T>|Type<string|int, array<int, T>>
$nullable : bool = false
$metadata : Metadata|null = null

Tags

Return values

ListDefinition<string|int, T>

enum_schema()


    
                    enum_schema(string $name, T> $type[, bool $nullable = false ][, Metadata|null $metadata = null ]) : EnumDefinition<string|int, T>

Parameters

$name : string
$type : T>
$nullable : bool = false
$metadata : Metadata|null = null

Tags

Return values

EnumDefinition<string|int, T>

null_schema()


    
                    null_schema(string $name[, Metadata|null $metadata = null ]) : NullDefinition

Parameters

$name : string
$metadata : Metadata|null = null

Return values

NullDefinition

datetime_schema()


    
                    datetime_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : DateTimeDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

DateTimeDefinition

time_schema()


    
                    time_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : TimeDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

TimeDefinition

date_schema()


    
                    date_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : DateDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

DateDefinition

json_schema()


    
                    json_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : JsonDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

JsonDefinition

html_schema()


    
                    html_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : HTMLDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

HTMLDefinition

html_element_schema()


    
                    html_element_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : HTMLElementDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

HTMLElementDefinition

xml_schema()


    
                    xml_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : XMLDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

XMLDefinition

xml_element_schema()


    
                    xml_element_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : XMLElementDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

XMLElementDefinition

structure_schema()


    
                    structure_schema(string $name, StructureType<string|int, T>|Type<string|int, array<string, T>> $type[, bool $nullable = false ][, Metadata|null $metadata = null ]) : StructureDefinition<string|int, T>

Parameters

$name : string
$type : StructureType<string|int, T>|Type<string|int, array<string, T>>
$nullable : bool = false
$metadata : Metadata|null = null

Tags

Return values

StructureDefinition<string|int, T>

union_schema()


    
                    union_schema(string $name, Type<string|int, mixed>|UnionType<mixed, mixed> $type[, bool $nullable = false ][, Metadata|null $metadata = null ]) : UnionDefinition

Parameters

$name : string
$type : Type<string|int, mixed>|UnionType<mixed, mixed>
$nullable : bool = false
$metadata : Metadata|null = null

Return values

UnionDefinition

uuid_schema()


    
                    uuid_schema(string $name[, bool $nullable = false ][, Metadata|null $metadata = null ]) : UuidDefinition

Parameters

$name : string
$nullable : bool = false
$metadata : Metadata|null = null

Return values

UuidDefinition

definition_from_array()

Create a Definition from an array representation.


    
                    definition_from_array(array<string|int, mixed> $definition) : Definition<string|int, mixed>

Parameters

$definition : array<string|int, mixed>

Return values

Definition<string|int, mixed>

definition_from_type()

Create a Definition from a Type.


    
                    definition_from_type(string|Reference $ref, Type<string|int, mixed> $type[, bool $nullable = false ][, Metadata|null $metadata = null ]) : Definition<string|int, mixed>

Parameters

$ref : string|Reference
$type : Type<string|int, mixed>
$nullable : bool = false
$metadata : Metadata|null = null

Return values

Definition<string|int, mixed>

execution_context()


    
                    execution_context([Config|null $config = null ]) : FlowContext

Parameters

$config : Config|null = null

Return values

FlowContext

flow_context()


    
                    flow_context([Config|null $config = null ]) : FlowContext

Parameters

$config : Config|null = null

Return values

FlowContext

config()


    
                    config() : Config

Return values

Config

config_builder()


    
                    config_builder() : ConfigBuilder

Return values

ConfigBuilder

memory_sort()


    
                    memory_sort() : MemorySortBuilder

Return values

MemorySortBuilder

external_sort()


    
                    external_sort() : ExternalSortBuilder

Return values

ExternalSortBuilder

hash_join()


    
                    hash_join() : HashJoinBuilder

Return values

HashJoinBuilder

hash_group_by()


    
                    hash_group_by() : HashGroupByBuilder

Return values

HashGroupByBuilder

overwrite()

Alias for save_mode_overwrite().


    
                    overwrite() : SaveMode

Return values

SaveMode

save_mode_overwrite()


    
                    save_mode_overwrite() : SaveMode

Return values

SaveMode

ignore()

Alias for save_mode_ignore().


    
                    ignore() : SaveMode

Return values

SaveMode

save_mode_ignore()


    
                    save_mode_ignore() : SaveMode

Return values

SaveMode

exception_if_exists()

Alias for save_mode_exception_if_exists().


    
                    exception_if_exists() : SaveMode

Return values

SaveMode

save_mode_exception_if_exists()


    
                    save_mode_exception_if_exists() : SaveMode

Return values

SaveMode

append()

Alias for save_mode_append().


    
                    append() : SaveMode

Return values

SaveMode

save_mode_append()


    
                    save_mode_append() : SaveMode

Return values

SaveMode

execution_strict()

In this mode, functions throws exceptions if the given entry is not found or passed parameters are invalid.


    
                    execution_strict() : ExecutionMode

Return values

ExecutionMode

execution_lenient()

In this mode, functions returns nulls instead of throwing exceptions.


    
                    execution_lenient() : ExecutionMode

Return values

ExecutionMode

print_rows()


    
                    print_rows(Rows $rows[, int|bool $truncate = false ][, Formatter|null $formatter = null ]) : string

Parameters

$rows : Rows
$truncate : int|bool = false
$formatter : Formatter|null = null

Return values

string

identical()


    
                    identical(Reference|string $left, Reference|string $right) : Identical

Parameters

$left : Reference|string
$right : Reference|string

Return values

Identical

equal()


    
                    equal(Reference|string $left, Reference|string $right) : Equal

Parameters

$left : Reference|string
$right : Reference|string

Return values

Equal

compare_all()


    
                    compare_all(Comparison $comparison, Comparison ...$comparisons) : All

Parameters

$comparison : Comparison
$comparisons : Comparison

Return values

All

compare_any()


    
                    compare_any(Comparison $comparison, Comparison ...$comparisons) : Any

Parameters

$comparison : Comparison
$comparisons : Comparison

Return values

Any

join_on()


    
                    join_on(array<string|int, Comparison|string>|Comparison $comparisons[, string $join_prefix = '' ]) : Expression

Parameters

$comparisons : array<string|int, Comparison|string>|Comparison
$join_prefix : string = ''

Return values

Expression

compare_entries_by_name()


    
                    compare_entries_by_name([Order $order = Order::ASC ]) : Comparator

Parameters

$order : Order = Order::ASC

Return values

Comparator

compare_entries_by_name_desc()


    
                    compare_entries_by_name_desc() : Comparator

Return values

Comparator

compare_entries_by_type()


    
                    compare_entries_by_type([array<string|int, mixed> $priorities = TypePriorities::PRIORITIES ][, Order $order = Order::ASC ]) : Comparator

Parameters

$priorities : array<string|int, mixed> = TypePriorities::PRIORITIES
$order : Order = Order::ASC

Return values

Comparator

compare_entries_by_type_desc()


    
                    compare_entries_by_type_desc([array<string|int, mixed> $priorities = TypePriorities::PRIORITIES ]) : Comparator

Parameters

$priorities : array<string|int, mixed> = TypePriorities::PRIORITIES

Return values

Comparator

compare_entries_by_type_and_name()


    
                    compare_entries_by_type_and_name([array<string|int, mixed> $priorities = TypePriorities::PRIORITIES ][, Order $order = Order::ASC ]) : Comparator

Parameters

$priorities : array<string|int, mixed> = TypePriorities::PRIORITIES
$order : Order = Order::ASC

Return values

Comparator

schema_sort_by_name()


    
                    schema_sort_by_name([SortOrder $order = SortOrder::ASC ]) : SortingStrategy

Parameters

$order : SortOrder = SortOrder::ASC

Return values

SortingStrategy

schema_sort_by_type()


    
                    schema_sort_by_type([array<string|int, mixed> $priorities = TypePriorities::PRIORITIES ][, SortOrder $order = SortOrder::ASC ]) : SortingStrategy

Parameters

$priorities : array<string|int, mixed> = TypePriorities::PRIORITIES
$order : SortOrder = SortOrder::ASC

Return values

SortingStrategy

schema_sort_by_type_and_name()


    
                    schema_sort_by_type_and_name([array<string|int, mixed> $priorities = TypePriorities::PRIORITIES ][, SortOrder $order = SortOrder::ASC ]) : SortingStrategy

Parameters

$priorities : array<string|int, mixed> = TypePriorities::PRIORITIES
$order : SortOrder = SortOrder::ASC

Return values

SortingStrategy

schema_sort_by_metadata()


    
                    schema_sort_by_metadata(string $key[, SortOrder $order = SortOrder::ASC ]) : SortingStrategy

Parameters

$key : string
$order : SortOrder = SortOrder::ASC

Return values

SortingStrategy

is_type()


    
                    is_type(array<string|int, string|Type<string|int, mixed>>|Type<string|int, mixed> $type, mixed $value) : bool

Parameters

$type : array<string|int, string|Type<string|int, mixed>>|Type<string|int, mixed>
$value : mixed

Return values

bool

generate_random_string()


    
                    generate_random_string([int $length = 32 ][, RandomValueGenerator $generator = new NativePHPRandomValueGenerator() ]) : string

Parameters

$length : int = 32
$generator : RandomValueGenerator = new NativePHPRandomValueGenerator()

Return values

string

generate_random_int()


    
                    generate_random_int([int $start = PHP_INT_MIN ][, int $end = PHP_INT_MAX ][, RandomValueGenerator $generator = new NativePHPRandomValueGenerator() ]) : int

Parameters

$start : int = PHP_INT_MIN
$end : int = PHP_INT_MAX
$generator : RandomValueGenerator = new NativePHPRandomValueGenerator()

Return values

int

random_string()


    
                    random_string(int|ScalarFunction $length[, RandomValueGenerator $generator = new NativePHPRandomValueGenerator() ]) : RandomString

Parameters

$length : int|ScalarFunction
$generator : RandomValueGenerator = new NativePHPRandomValueGenerator()

Return values

RandomString

date_interval_to_milliseconds()


    
                    date_interval_to_milliseconds(DateInterval $interval) : int

Parameters

$interval : DateInterval

Return values

int

date_interval_to_seconds()


    
                    date_interval_to_seconds(DateInterval $interval) : int

Parameters

$interval : DateInterval

Return values

int

date_interval_to_microseconds()


    
                    date_interval_to_microseconds(DateInterval $interval) : int

Parameters

$interval : DateInterval

Return values

int

with_entry()


    
                    with_entry(string $name, ScalarFunction $function) : WithEntry

Parameters

$name : string
$function : ScalarFunction

Return values

WithEntry

constraint_unique()


    
                    constraint_unique(string $reference, string ...$references) : UniqueConstraint

Parameters

$reference : string
$references : string

Return values

UniqueConstraint

constraint_sorted_by()


    
                    constraint_sorted_by(string|Reference $column, string|Reference ...$columns) : SortedByConstraint

Parameters

$column : string|Reference
$columns : string|Reference

Return values

SortedByConstraint

analyze()


    
                    analyze() : Analyze

Return values

Analyze

match_cases()


    
                    match_cases(array<string|int, MatchCondition> $cases[, mixed $default = null ]) : MatchCases

Parameters

$cases : array<string|int, MatchCondition>
$default : mixed = null

Return values

MatchCases

match_condition()


    
                    match_condition(mixed $condition, mixed $then) : MatchCondition

Parameters

$condition : mixed
$then : mixed

Return values

MatchCondition

retry_any_throwable()


    
                    retry_any_throwable(int $limit) : AnyThrowable

Parameters

$limit : int

Return values

AnyThrowable

retry_on_exception_types()


    
                    retry_on_exception_types(array<string|int, Throwable>> $exception_types, int $limit) : OnExceptionTypes

Parameters

$exception_types : array<string|int, Throwable>>
$limit : int

Return values

OnExceptionTypes

delay_linear()


    
                    delay_linear(Duration $delay, Duration $increment) : Linear

Parameters

$delay : Duration
$increment : Duration

Return values

Linear

delay_exponential()


    
                    delay_exponential(Duration $base[, int $multiplier = 2 ][, Duration|null $max_delay = null ]) : Exponential

Parameters

$base : Duration
$multiplier : int = 2
$max_delay : Duration|null = null

Return values

Exponential

delay_jitter()


    
                    delay_jitter(DelayFactory $delay, float $jitter_factor) : Jitter

Parameters

$delay : DelayFactory
$jitter_factor : float: a value between 0 and 1 representing the maximum percentage of jitter to apply

Return values

Jitter

delay_fixed()


    
                    delay_fixed(Duration $delay) : Fixed

Parameters

$delay : Duration

Return values

Fixed

duration_seconds()


    
                    duration_seconds(int $seconds) : Duration

Parameters

$seconds : int

Return values

Duration

duration_milliseconds()


    
                    duration_milliseconds(int $milliseconds) : Duration

Parameters

$milliseconds : int

Return values

Duration

duration_microseconds()


    
                    duration_microseconds(int $microseconds) : Duration

Parameters

$microseconds : int

Return values

Duration

duration_minutes()


    
                    duration_minutes(int $minutes) : Duration

Parameters

$minutes : int

Return values

Duration

write_with_retries()


    
                    write_with_retries(Loader $loader[, RetryStrategy $retry_strategy = new AnyThrowable(3) ][, DelayFactory $delay_factory = new FixedMilliseconds(200) ][, Sleep $sleep = new SystemSleep() ]) : RetryLoader

Parameters

$loader : Loader
$retry_strategy : RetryStrategy = new AnyThrowable(3)
$delay_factory : DelayFactory = new FixedMilliseconds(200)
$sleep : Sleep = new SystemSleep()

Return values

RetryLoader

clock()


    
                    clock([string $time_zone = 'UTC' ]) : ClockInterface

Parameters

$time_zone : string = 'UTC'

Return values

ClockInterface