Skip to content

Database

Methods

schema

The associated schema instance.

public schema(): \Qubus\Expressive\Schema

transactional

Run transactional queries.

public transactional(\Closure $callback, mixed $that = null, mixed $default = null): mixed

Parameters:

Parameter Type Description
$callback \Closure transaction callback
$that mixed
$default mixed

Throws:

Inherited methods

count

Return the aggregate count of column

public count(string|null $column = null): float|int

Parameters:

Parameter Type Description
$column string|null - the column name

max

Return the aggregate max count of column

public max(string $column): float|int

Parameters:

Parameter Type Description
$column string - the column name

min

Return the aggregate min count of column

public min(string $column): float|int

Parameters:

Parameter Type Description
$column string - the column name

sum

Return the aggregate sum count of column

public sum(string $column): float|int

Parameters:

Parameter Type Description
$column string - the column name

avg

Return the aggregate average count of column

public avg(string $column): float|int

Parameters:

Parameter Type Description
$column string - the column name

aggregate

public aggregate(string $fn): float|int

Parameters:

Parameter Type Description
$fn string - The function to use for the aggregation

join

Build a join

public join(string $tableName, string $constraint, string $tableAlias = '', string $joinOperator = \self::JOIN_LEFT): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$tableName string
$constraint string -> id = profile.user_id
$tableAlias string - The alias of the table name
$joinOperator string - LEFT | INNER | etc...

on

An alias to join by using a Database instance.

public on(\Qubus\Expressive\Database $query, string $joinOperator = \self::JOIN_LEFT): \Qubus\Expressive\Database

The Database instance may have select and where statement for the ON clause

Parameters:

Parameter Type Description
$query \Qubus\Expressive\Database
$joinOperator string

getJoinOnString

Create the JOIN ... ON string when there is a join. It will be called by on().

public getJoinOnString(): string

delete

Delete rows.

public delete(bool $deleteAll = false): \Qubus\Expressive\Database|int|false

Use the query builder to create the where clause.

Parameters:

Parameter Type Description
$deleteAll bool When there is no where condition, setting to true will delete all.

set

To set data for update or insert $key can be an array for mass set

public set(mixed $key, mixed|null $value = null): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$key mixed
$value mixed|null

save

Save, a shortcut to update() or insert().

public save(): \Qubus\Expressive\Database|int|bool

update

Update entries.

public update(array|null $data = null): \Qubus\Expressive\Database|int|false

Use the query builder to create the where clause.

Parameters:

Parameter Type Description
$data array|null the data to update

returning

Returning (Postgres etc.)

public returning(string $cols = '*'): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$cols string

upsert

Upsert (basic support)

public upsert(array $conflictCols, array $updateData): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$conflictCols array
$updateData array

lastInsertId

Retrieves the ID of the last record inserted.

public lastInsertId(string|null $pk = null): string|false

Parameters:

Parameter Type Description
$pk string|null

insert

Insert new rows $data can be 2-dimensional to add a bulk insert If a single row is inserted, it will return its row instance

public insert(array $data): \Qubus\Expressive\Database|int

Parameters:

Parameter Type Description
$data array - data to populate

where

Add where condition, more calls appends with AND.

public where(mixed $condition, mixed $parameters = null): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$condition mixed condition possibly containing ? or :name
$parameters mixed array accepted by PDOStatement::execute or a scalar value.

wherePK

Where Primary key

public wherePK(int|string $id): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$id int|string

whereNot

WHERE $columName != $value

public whereNot(string $columnName, mixed $value): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string
$value mixed

whereLike

WHERE $columName LIKE $value

public whereLike(string $columnName, mixed $value): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string
$value mixed

whereNotLike

WHERE $columName NOT LIKE $value

public whereNotLike(string $columnName, mixed $value): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string
$value mixed

whereGt

WHERE $columName > $value

public whereGt(string $columnName, mixed $value): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string
$value mixed

whereGte

WHERE $columName >= $value

public whereGte(string $columnName, mixed $value): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string
$value mixed

whereLt

WHERE $columName < $value

public whereLt(string $columnName, mixed $value): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string
$value mixed

whereLte

WHERE $columName <= $value

public whereLte(string $columnName, mixed $value): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string
$value mixed

whereIn

WHERE $columName IN (?,?,?,...)

public whereIn(string $columnName, array $values): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string
$values array

whereNotIn

WHERE $columName NOT IN (?,?,?,...)

public whereNotIn(string $columnName, array $values): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string
$values array

whereNull

WHERE $columName IS NULL

public whereNull(string $columnName): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string

whereNotNull

WHERE $columName IS NOT NULL

public whereNotNull(string $columnName): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string

orderBy

ORDER BY $columnName (ASC | DESC)

public orderBy(string $columnName, string $ordering = 'ASC'): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string - The name of the colum or an expression
$ordering string (DESC | ASC)

limit

LIMIT $limit

public limit(int|null $limit = null): \Qubus\Expressive\Database|int|null

Parameters:

Parameter Type Description
$limit int|null

offset

OFFSET $offset

public offset(int|null $offset = null): \Qubus\Expressive\Database|int|null

Parameters:

Parameter Type Description
$offset int|null

pagination

public pagination(int $perPage, int $page): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$perPage int
$page int

and

Create an AND operator in the where clause

public and(): \Qubus\Expressive\Database

or

Create an OR operator in the where clause

public or(): \Qubus\Expressive\Database

wrap

To group multiple where clauses together.

public wrap(): \Qubus\Expressive\Database

query

To execute a raw query

public query(string $query, array $parameters = [], bool $returnAsPdoStmt = false): \Qubus\Expressive\Database|\PDOStatement

Parameters:

Parameter Type Description
$query string
$parameters array
$returnAsPdoStmt bool True, it will return the PDOStatement
false, it will return $this, which can be used for chaining
or access the properties of the results.

find

To find all rows and create their instances Use the query builder to build the where clause or $this->query with select If a callback function is provided, the 1st arg must accept the rows results

public find(callable|null $callback = null): callable|bool|int|\SplFixedArray|string|\ArrayIterator|\InternalIterator|array|\Iterator

$this->find(function($rows){ // do more stuff here... });

Parameters:

Parameter Type Description
$callback callable|null Run a function on the returned rows

findOne

Return one row

public findOne(int|string|null $id = null): \Qubus\Expressive\Database|false

Parameters:

Parameter Type Description
$id int|string|null Use to fetch by primary key.

select

Create the select clause.

public select(mixed $columns = '*', string|null $alias = null): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columns mixed The column(s) to select. Can be string or array of fields.
$alias string|null An alias to the column.

getSelectFields

Return the select fields as array.

public getSelectFields(): array

fromArray

Create an instance from the given row (an associative array of data fetched from the database).

public fromArray(array $data): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$data array

having

public having(mixed $statement, string $operator = \self::OPERATOR_AND): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$statement mixed
$operator string

groupBy

GROUP BY $columnName

public groupBy(string $columnName): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$columnName string

table

Define the working table and create a new instance

public table(string $tableName, ?string $alias = null): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$tableName string Table name.
$alias ?string The table alias name.

getTableName

Return the name of the table.

public getTableName(): string

setTableAlias

Set the table alias.

public setTableAlias(string $alias): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$alias string

getTableAlias

Get table Alias

public getTableAlias(): string

setStructure

public setStructure(string $primaryKeyName = 'id', string $foreignKeyName = '%s_id'): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$primaryKeyName string The primary key, ie: id
$foreignKeyName string The foreign key as a pattern: %s_id,
where %s will be substituted with the table name

setTablePrefix

public setTablePrefix(string|null $tablePrefix = ''): \Qubus\Expressive\Database

Parameters:

Parameter Type Description
$tablePrefix string|null

getTablePrefix

Return the table prefix.

public getTablePrefix(): ?string

getStructure

Return the table structure.

public getStructure(): array

getPrimaryKeyname

Get the primary key name.

public getPrimaryKeyname(): string

getForeignKeyname

Get foreign key name.

public getForeignKeyname(): string

fromInstance

public static fromInstance(\Qubus\Expressive\Connection $connection, string $primaryKeyName = 'id', string|null $tablePrefix = null): \Qubus\Expressive\Database
  • This method is static. Parameters:
Parameter Type Description
$connection \Qubus\Expressive\Connection
$primaryKeyName string
$tablePrefix string|null