QueryBuilder

About 2 min

QueryBuilder

Methods

setReservedWords

public setReservedWords(array $words): void

Parameters

Parameter	Type	Description
`$words`	`array`

create

public create(string $name, string $type, bool $ifNotExists = false): string

Parameters

Parameter	Type	Description
`$name`	`string`
`$type`	`string`
`$ifNotExists`	`bool`

insert

public insert(string $tableName, mixed $fields, string $returning, string $conflictTarget, mixed $conflictUpdate, ?Table $table): string

Parameters

Parameter	Type	Description
`$tableName`	`string`
`$fields`	`mixed`
`$returning`	`string`
`$conflictTarget`	`string`
`$conflictUpdate`	`mixed`
`$table`	`Table`

update

public update(string $table, mixed $fields, array $criteria = [], array $from = [], mixed $returning, array $tables = []): string

Parameters

Parameter	Type	Description
`$table`	`string`
`$fields`	`mixed`
`$criteria`	`array`
`$from`	`array`
`$returning`	`mixed`
`$tables`	`array`

delete

public delete(string $table, array $criteria, array $from = []): string

Parameters

Parameter	Type	Description
`$table`	`string`
`$criteria`	`array`
`$from`	`array`

truncate

public truncate(string $table, bool $cascade = false): string

Parameters

Parameter	Type	Description
`$table`	`string`
`$cascade`	`bool`

count

public count(): string

exists

public exists(string $table, mixed $criteria): string

Parameters

Parameter	Type	Description
`$table`	`string`
`$criteria`	`mixed`

select

public select(mixed $columns): self

Parameters

Parameter	Type	Description
`$columns`	`mixed`

distinct

public distinct(string $columns): self

Parameters

Parameter	Type	Description
`$columns`	`string`

from

public from(string $table): self

Parameters

Parameter	Type	Description
`$table`	`string`

where

public where(mixed $criteria): self

Parameters

Parameter	Type	Description
`$criteria`	`mixed`

group

public group(string $column): self

Parameters

Parameter	Type	Description
`$column`	`string`

having

public having(string $columns): self

Parameters

Parameter	Type	Description
`$columns`	`string`

window

public window(string $name, string $partitionBy, string $orderBy): self

Parameters

Parameter	Type	Description
`$name`	`string`
`$partitionBy`	`string`
`$orderBy`	`string`

join

Join a table to the current query using the provided join criteria.

public join(string $references, string $on, ?string $alias, string $type = 'INNER'): self

Parameters

Parameter	Type	Description
`$references`	`string`
`$on`	`string`
`$alias`	`string`
`$type`	`string`

order

public order(string $columns, int $sortDirection = 'SORT_ASC'): self

Parameters

Parameter	Type	Description
`$columns`	`string`
`$sortDirection`	`int`

limit

public limit(int $limit): self

Parameters

Parameter	Type	Description
`$limit`	`int`

offset

public offset(int $offset): self

Parameters

Parameter	Type	Description
`$offset`	`int`

toString

public toString(): string

getSchemaName

public getSchemaName(): ?string

parseSchemaName

public parseSchemaName(string $tableName): void

Parameters

Parameter	Type	Description
`$tableName`	`string`

schemaName

public schemaName(string $tableName): string

Parameters

Parameter	Type	Description
`$tableName`	`string`

quoteSpecial

public quoteSpecial(mixed $value): mixed

Parameters

Parameter	Type	Description
`$value`	`mixed`

field

public field(string $string): string

Parameters

Parameter	Type	Description
`$string`	`string`

prepareFields

public prepareFields(mixed $fields, array $exclude = [], array $tables = []): string

Parameters

Parameter	Type	Description
`$fields`	`mixed`
`$exclude`	`array`
`$tables`	`array`

prepareValues

public prepareValues(mixed $values): string

Parameters

Parameter	Type	Description
`$values`	`mixed`

prepareValue

public prepareValue(mixed $value, ?string $key): mixed

Parameters

Parameter	Type	Description
`$value`	`mixed`
`$key`	`string`

prepareArrayAliases

public prepareArrayAliases(array $array): void

Parameters

Parameter	Type	Description
`$array`	`array`

prepareCriteria

public prepareCriteria(string $criteria, ?string $bindType, ?string $tissue, ?string $parentRef, string $optionalKey): string

Parameters

Parameter	Type	Description
`$criteria`	`string`
`$bindType`	`string`
`$tissue`	`string`
`$parentRef`	`string`
`$optionalKey`	`string`

reset

public reset(): self

Generated by Hazaar API Doc Generator