SQL

About 3 min

SQL

Properties

selectGroups

protected array $selectGroups

quoteSpecial

protected string $quoteSpecial = '"'

reservedWords

protected array $reservedWords

from

protected array $from

tables

protected array $tables

where

protected array $where

columns

public string $columns

group

protected array $group

having

protected array $having

window

protected array $window

joins

protected array $joins

combine

protected array $combine

order

protected array $order

fetch

protected array $fetch

distinct

public bool $distinct

limit

public int $limit

offset

public int $offset

schemaName

public string $schemaName

Methods

__construct

public __construct(?string $schemaName): void

Parameters

Parameter	Type	Description
`$schemaName`	`string`

setReservedWords

public setReservedWords(array $words): void

Parameters

Parameter	Type	Description
`$words`	`array`

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`

quote

public quote(string $string, bool $addSlashes = true): string

Parameters

Parameter	Type	Description
`$string`	`string`
`$addSlashes`	`bool`

quoteSpecial

public quoteSpecial(mixed $value): mixed

Parameters

Parameter	Type	Description
`$value`	`mixed`

reset

public reset(): self

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 $tableName, mixed $fields, array $criteria = [], array $from = [], mixed $returning, array $tables = []): string

Parameters

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

delete

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

Parameters

Parameter	Type	Description
`$tableName`	`string`
`$criteria`	`mixed`
`$from`	`array`

truncate

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

Parameters

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

count

public count(): string

exists

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

Parameters

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

select

public select(mixed $columns): self

Parameters

Parameter	Type	Description
`$columns`	`mixed`

distinct

Selects only distinct rows that match based on the specified expressions.

public distinct(string $columns): self

Parameters

Parameter	Type	Description
`$columns`	`string`

from

public from(string $table, ?string $alias): self

Parameters

Parameter	Type	Description
`$table`	`string`
`$alias`	`string`

where

Defines a WHERE selection criteria.

public where(mixed $criteria): self

Parameters

Parameter	Type	Description
`$criteria`	`mixed`

group

public group(string $columns): self

Parameters

Parameter	Type	Description
`$columns`	`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

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 $fieldDef, int $sortDirection = 'SORT_ASC'): self

Parameters

Parameter	Type	Description
`$fieldDef`	`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

Return the current selection as a valid SQL string.

public toString(bool $terminateWith_colon = false, bool $untable = false): string

Parameters

Parameter	Type	Description
`$terminateWith_colon`	`bool`
`$untable`	`bool`

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`

prepareCriteriaAction

private prepareCriteriaAction(string $action, mixed $value, string $tissue = '=', ?string $key, bool $setKey = true): string

Parameters

Parameter	Type	Description
`$action`	`string`
`$value`	`mixed`
`$tissue`	`string`
`$key`	`string`
`$setKey`	`bool`

tables

private tables(): void

prepareFrom

private prepareFrom(): string

prepareOrder

private prepareOrder(string $orderDefinition): string

Parameters

Parameter	Type	Description
`$orderDefinition`	`string`

Generated by Hazaar API Doc Generator