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

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, mixed> $array[, null|Schema $schema = null ]) : ArrayExtractor

Parameters

$array : iterable<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 NativePHPSerializer() ]) : FilesystemCache

Parameters

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

Return values

FilesystemCache

chunks_from()


    
                    chunks_from(Extractor $extractor, int<1, max> $chunk_size) : ChunkExtractor

Parameters

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

Return values

ChunkExtractor

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>

Return values

ArrayLoader

to_output()


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

Parameters

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

Return values

StreamLoader

to_stderr()


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

Parameters

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

Return values

StreamLoader

to_stdout()


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

Parameters

$truncate : int|bool = 20
$output : Output = Output::rows
$formatter : Formatter = new FormatterAsciiTableFormatter()
$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 FormatterAsciiTableFormatter() ][, SchemaFormatter $schemaFormatter = new ASCIISchemaFormatter() ]) : StreamLoader

Parameters

$uri : string
$truncate : int|bool = 20
$output : Output = Output::rows
$mode : string = 'w'
$formatter : Formatter = new FormatterAsciiTableFormatter()
$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

bool_entry()


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

Parameters

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

Return values

BooleanEntry

boolean_entry()


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

Parameters

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

Return values

BooleanEntry

datetime_entry()


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

Parameters

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

Return values

DateTimeEntry

time_entry()


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

Parameters

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

Return values

TimeEntry

date_entry()


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

Parameters

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

Return values

DateEntry

int_entry()


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

Parameters

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

Return values

IntegerEntry

integer_entry()


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

Parameters

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

Return values

IntegerEntry

enum_entry()


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

Parameters

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

Return values

EnumEntry

float_entry()


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

Parameters

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

Return values

FloatEntry

json_entry()


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

Parameters

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

Return values

JsonEntry

json_object_entry()


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

Parameters

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

Return values

JsonEntry

str_entry()


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

Parameters

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

Return values

StringEntry

null_entry()

This functions is an alias for creating string entry from null.


    
                    null_entry(string $name[, Metadata|null $metadata = null ]) : StringEntry

The main difference between using this function an simply str_entry with second argument null is that this function will also keep a note in the metadata that type might not be final. For example when we need to guess column type from rows because schema was not provided, and given column in the first row is null, it might still change once we get to the second row. That metadata is used to determine if string_entry was created from null or not.

By design flow assumes when guessing column type that null would be a string (the most flexible type).

Parameters

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

Return values

StringEntry

string_entry()


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

Parameters

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

Return values

StringEntry

uuid_entry()


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

Parameters

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

Return values

UuidEntry

xml_entry()


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

Parameters

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

Return values

XMLEntry

xml_element_entry()


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

Parameters

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

Return values

XMLElementEntry

entries()


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

Parameters

$entries : Entry<mixed, mixed>

Return values

Entries

struct_entry()


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

Parameters

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

Return values

StructureEntry

structure_entry()


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

Parameters

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

Return values

StructureEntry

type_structure()


    
                    type_structure(array<string, Type<string|int, mixed>> $elements[, bool $nullable = false ]) : StructureType

Parameters

$elements : array<string, Type<string|int, mixed>>
$nullable : bool = false

Return values

StructureType

list_entry()


    
                    list_entry(string $name, array<int, mixed> $value, ListType $type) : ListEntry

Parameters

$name : string
$value : array<int, mixed>
$type : ListType

Return values

ListEntry

type_list()


    
                    type_list(Type<string|int, mixed> $element[, bool $nullable = false ]) : ListType

Parameters

$element : Type<string|int, mixed>
$nullable : bool = false

Return values

ListType

type_map()


    
                    type_map(StringType|IntegerType $key_type, Type<string|int, mixed> $value_type[, bool $nullable = false ]) : MapType

Parameters

$key_type : StringType|IntegerType
$value_type : Type<string|int, mixed>
$nullable : bool = false

Return values

MapType

map_entry()


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

Parameters

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

Return values

MapEntry

type_json()


    
                    type_json([bool $nullable = false ]) : JsonType

Parameters

$nullable : bool = false

Return values

JsonType

type_datetime()


    
                    type_datetime([bool $nullable = false ]) : DateTimeType

Parameters

$nullable : bool = false

Return values

DateTimeType

type_date()


    
                    type_date([bool $nullable = false ]) : DateType

Parameters

$nullable : bool = false

Return values

DateType

type_time()


    
                    type_time([bool $nullable = false ]) : TimeType

Parameters

$nullable : bool = false

Return values

TimeType

type_xml()


    
                    type_xml([bool $nullable = false ]) : XMLType

Parameters

$nullable : bool = false

Return values

XMLType

type_xml_element()


    
                    type_xml_element([bool $nullable = false ]) : XMLElementType

Parameters

$nullable : bool = false

Return values

XMLElementType

type_uuid()


    
                    type_uuid([bool $nullable = false ]) : UuidType

Parameters

$nullable : bool = false

Return values

UuidType

type_int()


    
                    type_int([bool $nullable = false ]) : IntegerType

Parameters

$nullable : bool = false

Return values

IntegerType

type_integer()


    
                    type_integer([bool $nullable = false ]) : IntegerType

Parameters

$nullable : bool = false

Return values

IntegerType

type_string()


    
                    type_string([bool $nullable = false ]) : StringType

Parameters

$nullable : bool = false

Return values

StringType

type_float()


    
                    type_float([bool $nullable = false ][, int $precision = 6 ]) : FloatType

Parameters

$nullable : bool = false
$precision : int = 6

Return values

FloatType

type_boolean()


    
                    type_boolean([bool $nullable = false ]) : BooleanType

Parameters

$nullable : bool = false

Return values

BooleanType

type_object()


    
                    type_object(class-string $class[, bool $nullable = false ]) : ObjectType

Parameters

$class : class-string
$nullable : bool = false

Return values

ObjectType

type_resource()


    
                    type_resource([bool $nullable = false ]) : ResourceType

Parameters

$nullable : bool = false

Return values

ResourceType

type_array()


    
                    type_array([bool $empty = false ][, bool $nullable = false ]) : ArrayType

Parameters

$empty : bool = false
$nullable : bool = false

Return values

ArrayType

type_callable()


    
                    type_callable([bool $nullable = false ]) : CallableType

Parameters

$nullable : bool = false

Return values

CallableType

type_null()


    
                    type_null() : NullType

Return values

NullType

type_enum()


    
                    type_enum(UnitEnum> $class[, bool $nullable = false ]) : EnumType

Parameters

$class : UnitEnum>
$nullable : bool = false

Return values

EnumType

row()


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

Parameters

$entry : Entry<mixed, mixed>

Return values

Row

rows()


    
                    rows(Row ...$row) : Rows

Parameters

$row : Row

Return values

Rows

rows_partitioned()


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

Parameters

$rows : array<string|int, mixed>
$partitions : array<string|int, mixed>|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

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, ScalarFunction|array<string|int, mixed> $keys) : ArrayGetCollection

Parameters

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

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(ScalarFunction|array<string|int, mixed> $ref, ScalarFunction|string $path) : ArrayPathExists

Parameters

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

Return values

ArrayPathExists

array_merge()


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

Parameters

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

Return values

ArrayMerge

array_merge_collection()


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

Parameters

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

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(ScalarFunction|array<string|int, mixed> $function[, ScalarFunction|bool $preserveKeys = false ]) : ArrayReverse

Parameters

$function : ScalarFunction|array<string|int, mixed>
$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(ScalarFunction|array<string|int, mixed> $keys, ScalarFunction|array<string|int, mixed> $values) : Combine

Parameters

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

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, string|Type<string|int, mixed> $type[, Options|null $options = null ]) : Cast

Parameters

$value : mixed
$type : string|Type<string|int, mixed>
$options : Options|null = null

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

array_unpack()

Unpacks each element of an array into a new entry, using the array key as the entry name.


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

Before: +--+-------------------+ |id| array| +--+-------------------+ | 1|{"a":1,"b":2,"c":3}| | 2|{"d":4,"e":5,"f":6}| +--+-------------------+

After: +--+-----+-----+-----+-----+-----+ |id|arr.b|arr.c|arr.d|arr.e|arr.f| +--+-----+-----+-----+-----+-----+ | 1| 2| 3| | | | | 2| | | 4| 5| 6| +--+-----+-----+-----+-----+-----+

Parameters

$array : ScalarFunction|array<string|int, mixed>
$skip_keys : ScalarFunction|array<string|int, mixed> = []
$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<mixed, mixed>

Parameters

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

Return values

Entry<mixed, mixed>

array_to_row()


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

Parameters

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

Return values

Row

array_to_rows()


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

Parameters

$data : array<string|int, array<string|int, mixed>>|array<string|int, mixed|string>
$entryFactory : EntryFactory = new EntryFactory()
$partitions : array<string|int, Partition>|Partitions = []
$schema : Schema|null = 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

sum()


    
                    sum(EntryReference|string $ref) : Sum

Parameters

$ref : EntryReference|string

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 ...$definitions) : Schema

Parameters

$definitions : Definition

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_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 `int_schema`.


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

Parameters

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

Return values

Definition

integer_schema()


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

Parameters

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

Return values

Definition

str_schema()

Alias for `string_schema`.


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

Parameters

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

Return values

Definition

string_schema()


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

Parameters

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

Return values

Definition

bool_schema()


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

Parameters

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

Return values

Definition

float_schema()


    
                    float_schema(string $name[, bool $nullable = false ][, int $precision = 6 ][, Metadata|null $metadata = null ]) : Definition

Parameters

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

Return values

Definition

map_schema()


    
                    map_schema(string $name, MapType $type[, Metadata|null $metadata = null ]) : Definition

Parameters

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

Return values

Definition

list_schema()


    
                    list_schema(string $name, ListType $type[, Metadata|null $metadata = null ]) : Definition

Parameters

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

Return values

Definition

enum_schema()


    
                    enum_schema(string $name, UnitEnum> $type[, bool $nullable = false ][, Metadata|null $metadata = null ]) : Definition

Parameters

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

Return values

Definition

null_schema()


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

Parameters

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

Return values

Definition

datetime_schema()


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

Parameters

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

Return values

Definition

time_schema()


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

Parameters

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

Return values

Definition

date_schema()


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

Parameters

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

Return values

Definition

json_schema()


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

Parameters

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

Return values

Definition

xml_schema()


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

Parameters

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

Return values

Definition

xml_element_schema()


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

Parameters

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

Return values

Definition

struct_schema()


    
                    struct_schema(string $name, StructureType $type[, Metadata|null $metadata = null ]) : Definition

Parameters

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

Return values

Definition

structure_schema()


    
                    structure_schema(string $name, StructureType $type[, Metadata|null $metadata = null ]) : Definition

Parameters

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

Return values

Definition

uuid_schema()


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

Parameters

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

Return values

Definition

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

overwrite()


    
                    overwrite() : SaveMode

Return values

SaveMode

ignore()


    
                    ignore() : SaveMode

Return values

SaveMode

exception_if_exists()


    
                    exception_if_exists() : SaveMode

Return values

SaveMode

append()


    
                    append() : SaveMode

Return values

SaveMode

get_type()


    
                    get_type(mixed $value) : Type<string|int, mixed>

Parameters

$value : mixed

Return values

Type<string|int, mixed>

print_schema()


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

Parameters

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

Return values

string

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 ...$comparisons) : All

Parameters

$comparisons : Comparison

Return values

All

compare_any()


    
                    compare_any(Comparison ...$comparisons) : Any

Parameters

$comparisons : Comparison

Return values

Any

join_on()


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

Parameters

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

Return values

Expression

compare_entries_by_name()


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

Parameters

$order : Order = TransformerOrderEntriesOrder::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 = TransformerOrderEntriesTypePriorities::PRIORITIES ][, Order $order = TransformerOrderEntriesOrder::ASC ]) : Comparator

Parameters

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

Return values

Comparator

compare_entries_by_type_desc()


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

Parameters

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

Return values

Comparator

compare_entries_by_type_and_name()


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

Parameters

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

Return values

Comparator

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 ][, NativePHPRandomValueGenerator $generator = new NativePHPRandomValueGenerator() ]) : string

Parameters

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

Return values

string

generate_random_int()


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

Parameters

$start : int = PHP_INT_MIN
$end : int = PHP_INT_MAX
$generator : NativePHPRandomValueGenerator = 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

dom_element_to_string()


    
                    dom_element_to_string(DOMElement $element[, bool $format_output = false ][, bool $preserver_white_space = false ]) : string|false

Parameters

$element : DOMElement
$format_output : bool = false
$preserver_white_space : bool = false

Return values

string|false

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

caster_options()


    
                    caster_options() : Options

Return values

Options

caster()

Advanced type casting mechanism.


    
                    caster([Options|null $options = null ]) : Caster

Usage:

caster()->to(type_float(precision: 2))->value("1.1234") // 1.12

Options can be also passed to "to" function to override default options.

caster()->to(type_float(precision: 2), caster_options())->value("1.1234") // 1.12

Parameters

$options : Options|null = null

Return values

Caster

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

analyze()


    
                    analyze() : Analyze

Return values

Analyze

functions.php

Functions

df()

Parameters

Return values

data_frame()

Parameters

Return values

from_rows()

Parameters

Return values

from_path_partitions()

Parameters

Return values

from_array()

Parameters

Return values

from_cache()

Parameters

Return values

from_all()

Parameters

Return values

from_memory()

Parameters

Return values

files()

Parameters

Return values

filesystem_cache()

Parameters

Return values

chunks_from()

Parameters

Return values

from_pipeline()

Parameters

Return values

from_data_frame()

Parameters

Return values

from_sequence_date_period()

Parameters

Return values

from_sequence_date_period_recurrences()

Parameters

Return values

from_sequence_number()

Parameters

Return values

to_callable()

Parameters

Return values

to_memory()

Parameters

Return values

to_array()

Parameters

Tags

Return values

to_output()

Parameters

Return values

to_stderr()

Parameters

Return values

to_stdout()

Parameters

Return values

to_stream()

Parameters

Return values

to_transformation()

Parameters

Return values

to_branch()

Parameters

Return values

bool_entry()

Parameters