functions.php
Functions
dbal_dataframe_factory()
dbal_dataframe_factory(array<string, mixed>|Connection $connection, string $query, QueryParameter ...$parameters) : DbalDataFrameFactory
Parameters
- $connection : array<string, mixed>|Connection
- $query : string
- $parameters : QueryParameter
Return values
DbalDataFrameFactoryfrom_dbal_limit_offset()
from_dbal_limit_offset(Connection $connection, string|Table $table, array<string|int, OrderBy>|OrderBy $order_by[, int $page_size = 1000 ][, null|int $maximum = null ]) : DbalLimitOffsetExtractor
Parameters
- $connection : Connection
- $table : string|Table
- $order_by : array<string|int, OrderBy>|OrderBy
- $page_size : int = 1000
- $maximum : null|int = null
Tags
Return values
DbalLimitOffsetExtractorfrom_dbal_limit_offset_qb()
from_dbal_limit_offset_qb(Connection $connection, QueryBuilder $queryBuilder[, int $page_size = 1000 ][, null|int $maximum = null ][, int $offset = 0 ]) : DbalLimitOffsetExtractor
Parameters
- $connection : Connection
- $queryBuilder : QueryBuilder
- $page_size : int = 1000
- $maximum : null|int = null
-
- maximum can also be taken from a query builder, $maximum however is used regardless of the query builder if it's set
- $offset : int = 0
-
- offset can also be taken from a query builder, $offset however is used regardless of the query builder if it's set to non 0 value
Return values
DbalLimitOffsetExtractorfrom_dbal_queries()
from_dbal_queries(Connection $connection, string $query[, null|ParametersSet $parameters_set = null ][, array<int|string, ArrayParameterType|ParameterType|Type|int|string> $types = [] ]) : DbalQueryExtractor
Parameters
- $connection : Connection
- $query : string
- $parameters_set : null|ParametersSet = null
-
- each one parameters array will be evaluated as new query
- $types : array<int|string, ArrayParameterType|ParameterType|Type|int|string> = []
Return values
DbalQueryExtractordbal_from_queries()
use from_dbal_queries() instead
dbal_from_queries(Connection $connection, string $query[, null|ParametersSet $parameters_set = null ][, array<int|string, ArrayParameterType|ParameterType|Type|int|string> $types = [] ]) : DbalQueryExtractor
Parameters
- $connection : Connection
- $query : string
- $parameters_set : null|ParametersSet = null
-
- each one parameters array will be evaluated as new query
- $types : array<int|string, ArrayParameterType|ParameterType|Type|int|string> = []
Return values
DbalQueryExtractorfrom_dbal_query()
from_dbal_query(Connection $connection, string $query[, array<string, mixed>|array<int, mixed> $parameters = [] ][, array<int|string, ArrayParameterType|ParameterType|Type|int|string> $types = [] ]) : DbalQueryExtractor
Parameters
- $connection : Connection
- $query : string
- $parameters : array<string, mixed>|array<int, mixed> = []
-
- @deprecated use DbalQueryExtractor::withParameters() instead
- $types : array<int|string, ArrayParameterType|ParameterType|Type|int|string> = []
-
- @deprecated use DbalQueryExtractor::withTypes() instead
Return values
DbalQueryExtractordbal_from_query()
use from_dbal_query() instead
dbal_from_query(Connection $connection, string $query[, array<string, mixed>|array<int, mixed> $parameters = [] ][, array<int|string, ArrayParameterType|ParameterType|Type|int|string> $types = [] ]) : DbalQueryExtractor
Parameters
- $connection : Connection
- $query : string
- $parameters : array<string, mixed>|array<int, mixed> = []
-
- @deprecated use DbalQueryExtractor::withParameters() instead
- $types : array<int|string, ArrayParameterType|ParameterType|Type|int|string> = []
-
- @deprecated use DbalQueryExtractor::withTypes() instead
Return values
DbalQueryExtractorto_dbal_table_insert()
Insert new rows into a database table.
to_dbal_table_insert(array<string, mixed>|Connection $connection, string $table[, InsertOptions|null $options = null ]) : DbalLoader
Insert can also be used as an upsert with the help of InsertOptions. InsertOptions are platform specific, so please choose the right one for your database.
- MySQLInsertOptions
- PostgreSQLInsertOptions
- SqliteInsertOptions
In order to control the size of the single insert, use DataFrame::chunkSize() method just before calling DataFrame::load().
Parameters
- $connection : array<string, mixed>|Connection
- $table : string
- $options : InsertOptions|null = null
Tags
Return values
DbalLoaderto_dbal_table_update()
Update existing rows in database.
to_dbal_table_update(array<string, mixed>|Connection $connection, string $table[, UpdateOptions|null $options = null ]) : DbalLoader
In order to control the size of the single request, use DataFrame::chunkSize() method just before calling DataFrame::load().
Parameters
- $connection : array<string, mixed>|Connection
- $table : string
- $options : UpdateOptions|null = null
Tags
Return values
DbalLoaderto_dbal_schema_table()
Converts a Flow\ETL\Row\Schema to a Doctrine\DBAL\Schema\Table.
to_dbal_schema_table(Schema $schema, string $table_name[, array<string|int, mixed> $table_options = [] ][, array<string|int, mixed> $types_map = [] ]) : Table
Parameters
- $schema : Schema
- $table_name : string
- $table_options : array<string|int, mixed> = []
- $types_map : array<string|int, mixed> = []
Return values
Tabletable_schema_to_flow_schema()
Converts a Doctrine\DBAL\Schema\Table to a Flow\ETL\Row\Schema.
table_schema_to_flow_schema(Table $table[, array<string|int, mixed> $types_map = [] ]) : Schema
Parameters
- $table : Table
- $types_map : array<string|int, mixed> = []
Return values
Schemapostgresql_insert_options()
postgresql_insert_options([bool|null $skip_conflicts = null ][, string|null $constraint = null ][, array<string|int, mixed> $conflict_columns = [] ][, array<string|int, mixed> $update_columns = [] ]) : PostgreSQLInsertOptions
Parameters
- $skip_conflicts : bool|null = null
- $constraint : string|null = null
- $conflict_columns : array<string|int, mixed> = []
- $update_columns : array<string|int, mixed> = []
Return values
PostgreSQLInsertOptionsmysql_insert_options()
mysql_insert_options([bool|null $skip_conflicts = null ][, bool|null $upsert = null ][, array<string|int, mixed> $update_columns = [] ]) : MySQLInsertOptions
Parameters
- $skip_conflicts : bool|null = null
- $upsert : bool|null = null
- $update_columns : array<string|int, mixed> = []
Return values
MySQLInsertOptionssqlite_insert_options()
sqlite_insert_options([bool|null $skip_conflicts = null ][, array<string|int, mixed> $conflict_columns = [] ][, array<string|int, mixed> $update_columns = [] ]) : SqliteInsertOptions
Parameters
- $skip_conflicts : bool|null = null
- $conflict_columns : array<string|int, mixed> = []
- $update_columns : array<string|int, mixed> = []
Return values
SqliteInsertOptionspostgresql_update_options()
postgresql_update_options([array<string|int, mixed> $primary_key_columns = [] ][, array<string|int, mixed> $update_columns = [] ]) : PostgreSQLUpdateOptions
Parameters
- $primary_key_columns : array<string|int, mixed> = []
- $update_columns : array<string|int, mixed> = []