) VIRTUAL|STORED` clause for a
generated/computed column. Returns an empty string when the column is
not generated. When `forceStored` is `true` the clause is always emitted
as `STORED` regardless of the column's `isGenerationStored()` flag -
PostgreSQL uses this since it only supports stored generated columns.
getIndexColumnList()
```php
protected function getIndexColumnList(
IndexInterface $index,
bool $wrapExpressions = true
): string;
```
Builds the per-index parenthesized column list, honoring per-column
sort directions when the index declares any. Returns the bare
comma-separated `getColumnList()` output when no directions are set,
preserving the legacy rendering exactly. When directions are set,
each column is followed by ` ASC` or ` DESC`; trailing positions
absent from the directions array default to `ASC`.
getSqlExpressionAll()
```php
final protected function getSqlExpressionAll(
array $expression,
string|null $escapeChar = null
): string;
```
Resolve *
getSqlExpressionBinaryOperations()
```php
final protected function getSqlExpressionBinaryOperations(
array $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve binary operations expressions
getSqlExpressionCase()
```php
final protected function getSqlExpressionCase(
array $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve CASE expressions
getSqlExpressionCastValue()
```php
final protected function getSqlExpressionCastValue(
array $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve CAST of values
getSqlExpressionConvertValue()
```php
final protected function getSqlExpressionConvertValue(
array $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve CONVERT of values encodings
getSqlExpressionFrom()
```php
final protected function getSqlExpressionFrom(
mixed $expression,
string|null $escapeChar = null
): string;
```
Resolve a FROM clause
getSqlExpressionFunctionCall()
```php
final protected function getSqlExpressionFunctionCall(
array $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve function calls
getSqlExpressionGroupBy()
```php
final protected function getSqlExpressionGroupBy(
mixed $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve a GROUP BY clause
getSqlExpressionHaving()
```php
final protected function getSqlExpressionHaving(
array $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve a HAVING clause
getSqlExpressionJoins()
```php
final protected function getSqlExpressionJoins(
mixed $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve a JOINs clause
getSqlExpressionLimit()
```php
final protected function getSqlExpressionLimit(
mixed $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve a LIMIT clause
getSqlExpressionList()
```php
final protected function getSqlExpressionList(
array $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve Lists
getSqlExpressionObject()
```php
final protected function getSqlExpressionObject(
array $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve object expressions
getSqlExpressionOrderBy()
```php
final protected function getSqlExpressionOrderBy(
mixed $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve an ORDER BY clause
getSqlExpressionQualified()
```php
final protected function getSqlExpressionQualified(
array $expression,
string|null $escapeChar = null
): string;
```
Resolve qualified expressions
getSqlExpressionScalar()
```php
final protected function getSqlExpressionScalar(
array $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve Column expressions
getSqlExpressionUnaryOperations()
```php
final protected function getSqlExpressionUnaryOperations(
array $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve unary operations expressions
getSqlExpressionWhere()
```php
final protected function getSqlExpressionWhere(
mixed $expression,
string|null $escapeChar = null,
array $bindCounts = []
): string;
```
Resolve a WHERE clause
prepareColumnAlias()
```php
protected function prepareColumnAlias(
string $qualified,
string|null $alias = null,
string|null $escapeChar = null
): string;
```
Prepares column for this RDBMS
prepareQualified()
```php
protected function prepareQualified(
string $column,
string|null $domain = null,
string|null $escapeChar = null
): string;
```
Prepares qualified for this RDBMS
prepareTable()
```php
protected function prepareTable(
string $table,
string|null $schema = null,
string|null $alias = null,
string|null $escapeChar = null
): string;
```
Prepares table for this RDBMS
## Db\DialectInterface
Interface
Source on GitHub
Phalcon\Db\DialectInterface
- [`Phalcon\Contracts\Db\Dialect`](/5.19/api/phalcon_contracts/#contractsdbdialect)
- **`Phalcon\Db\DialectInterface`**
__Uses__ `Phalcon\Contracts\Db\Dialect`
## Db\Dialect\Mysql
Class
Source on GitHub
Generates database specific SQL for the MySQL RDBMS
- [`Phalcon\Db\Dialect`](#dbdialect)
- **`Phalcon\Db\Dialect\Mysql`**
__Uses__ `Phalcon\Db\CheckInterface` · `Phalcon\Db\Column` · `Phalcon\Db\ColumnInterface` · `Phalcon\Db\Dialect` · `Phalcon\Db\DialectInterface` · `Phalcon\Db\Exception` · `Phalcon\Db\Exceptions\MissingDefinitionKey` · `Phalcon\Db\Exceptions\MysqlOnConflictNotSupported` · `Phalcon\Db\Exceptions\UnrecognizedDataType` · `Phalcon\Db\IndexInterface` · `Phalcon\Db\RawValue` · `Phalcon\Db\ReferenceInterface`
### Method Summary
public
string
addCheck(string $tableName,string $schemaName,CheckInterface $check)
Generates SQL to add a CHECK constraint to an existing table.
public
string
addColumn(string $tableName,string $schemaName,ColumnInterface $column)
Generates SQL to add a column to a table
public
string
addForeignKey(string $tableName,string $schemaName,ReferenceInterface $reference)
Generates SQL to add an index to a table
public
string
addIndex(string $tableName,string $schemaName,IndexInterface $index)
Generates SQL to add an index to a table
public
string
addPrimaryKey(string $tableName,string $schemaName,IndexInterface $index)
Generates SQL to add the primary key to a table
public
string
createTable(string $tableName,string $schemaName,array $definition)
Generates SQL to create a table
public
string
createView(string $viewName,array $definition,string|null $schemaName = null)
Generates SQL to create a view
public
string
describeColumns(string $table,string|null $schema = null)
Generates SQL describing a table
public
string
describeIndexes(string $table,string|null $schema = null)
Generates SQL to query indexes on a table
public
string
describeReferences(string $table,string|null $schema = null)
Generates SQL to query foreign keys on a table
public
string
dropCheck(string $tableName,string $schemaName,string $checkName)
Generates SQL to delete a CHECK constraint from a table
public
string
dropColumn(string $tableName,string $schemaName,string $columnName)
Generates SQL to delete a column from a table
public
string
dropForeignKey(string $tableName,string $schemaName,string $referenceName)
Generates SQL to delete a foreign key from a table
public
string
dropIndex(string $tableName,string $schemaName,string $indexName)
Generates SQL to delete an index from a table
public
string
dropPrimaryKey(string $tableName,string $schemaName)
Generates SQL to delete primary key from a table
public
string
dropTable(string $tableName,string|null $schemaName = null,bool $ifExists = true)
Generates SQL to drop a table
public
string
dropView(string $viewName,string|null $schemaName = null,bool $ifExists = true)
Generates SQL to drop a view
public
string
getColumnDefinition( ColumnInterface $column )
Gets the column name in MySQL
public
string
getForeignKeyChecks()
Generates SQL to check DB parameter FOREIGN_KEY_CHECKS.
public
string
listTables( string|null $schemaName = null )
List all tables in database
public
string
listViews( string|null $schemaName = null )
Generates the SQL to list all views of a schema or user
public
string
modifyColumn(string $tableName,string $schemaName,ColumnInterface $column,ColumnInterface|null $currentColumn = null)
Generates SQL to modify a column in a table
public
string
onConflictUpdate(string $sqlQuery,array $conflictColumns,array $updateColumns)
MySQL does not support the SQL-standard ON CONFLICT DO UPDATE
public
string
sharedLock(string $sqlQuery,string $modifier = "")
Returns a SQL modified with a LOCK IN SHARE MODE clause. The modifier
public
bool
supportsOnConflictUpdate()
MySQL does not support the SQL-standard ON CONFLICT (...) DO UPDATE
public
string
tableExists(string $tableName,string|null $schemaName = null)
Generates SQL checking for the existence of a schema.table
public
string
tableOptions(string $table,string|null $schema = null)
Generates the SQL to describe the table creation options
public
string
truncateTable(string $tableName,string $schemaName)
Generates SQL to truncate a table
public
string
viewExists(string $viewName,string|null $schemaName = null)
Generates SQL checking for the existence of a schema.view
protected
string
getTableOptions( array $definition )
Generates SQL to add the table creation options
### Properties
protected
string
$escapeChar = "`"
protected
array
$supportedOperators = [...]
### Methods
Public · 29
addCheck()
```php
public function addCheck(
string $tableName,
string $schemaName,
CheckInterface $check
): string;
```
Generates SQL to add a CHECK constraint to an existing table.
Enforced by MySQL 8.0.16+.
addColumn()
```php
public function addColumn(
string $tableName,
string $schemaName,
ColumnInterface $column
): string;
```
Generates SQL to add a column to a table
addForeignKey()
```php
public function addForeignKey(
string $tableName,
string $schemaName,
ReferenceInterface $reference
): string;
```
Generates SQL to add an index to a table
addIndex()
```php
public function addIndex(
string $tableName,
string $schemaName,
IndexInterface $index
): string;
```
Generates SQL to add an index to a table
addPrimaryKey()
```php
public function addPrimaryKey(
string $tableName,
string $schemaName,
IndexInterface $index
): string;
```
Generates SQL to add the primary key to a table
createTable()
```php
public function createTable(
string $tableName,
string $schemaName,
array $definition
): string;
```
Generates SQL to create a table
createView()
```php
public function createView(
string $viewName,
array $definition,
string|null $schemaName = null
): string;
```
Generates SQL to create a view
describeColumns()
```php
public function describeColumns(
string $table,
string|null $schema = null
): string;
```
Generates SQL describing a table
```php
print_r(
$dialect->describeColumns("posts")
);
```
describeIndexes()
```php
public function describeIndexes(
string $table,
string|null $schema = null
): string;
```
Generates SQL to query indexes on a table
describeReferences()
```php
public function describeReferences(
string $table,
string|null $schema = null
): string;
```
Generates SQL to query foreign keys on a table
dropCheck()
```php
public function dropCheck(
string $tableName,
string $schemaName,
string $checkName
): string;
```
Generates SQL to delete a CHECK constraint from a table
dropColumn()
```php
public function dropColumn(
string $tableName,
string $schemaName,
string $columnName
): string;
```
Generates SQL to delete a column from a table
dropForeignKey()
```php
public function dropForeignKey(
string $tableName,
string $schemaName,
string $referenceName
): string;
```
Generates SQL to delete a foreign key from a table
dropIndex()
```php
public function dropIndex(
string $tableName,
string $schemaName,
string $indexName
): string;
```
Generates SQL to delete an index from a table
dropPrimaryKey()
```php
public function dropPrimaryKey(
string $tableName,
string $schemaName
): string;
```
Generates SQL to delete primary key from a table
dropTable()
```php
public function dropTable(
string $tableName,
string|null $schemaName = null,
bool $ifExists = true
): string;
```
Generates SQL to drop a table
dropView()
```php
public function dropView(
string $viewName,
string|null $schemaName = null,
bool $ifExists = true
): string;
```
Generates SQL to drop a view
getColumnDefinition()
```php
public function getColumnDefinition( ColumnInterface $column ): string;
```
Gets the column name in MySQL
getForeignKeyChecks()
```php
public function getForeignKeyChecks(): string;
```
Generates SQL to check DB parameter FOREIGN_KEY_CHECKS.
listTables()
```php
public function listTables( string|null $schemaName = null ): string;
```
List all tables in database
```php
print_r(
$dialect->listTables("blog")
);
```
listViews()
```php
public function listViews( string|null $schemaName = null ): string;
```
Generates the SQL to list all views of a schema or user
modifyColumn()
```php
public function modifyColumn(
string $tableName,
string $schemaName,
ColumnInterface $column,
ColumnInterface|null $currentColumn = null
): string;
```
Generates SQL to modify a column in a table
onConflictUpdate()
```php
public function onConflictUpdate(
string $sqlQuery,
array $conflictColumns,
array $updateColumns
): string;
```
MySQL does not support the SQL-standard `ON CONFLICT DO UPDATE`
upsert syntax - it has its own `INSERT ... ON DUPLICATE KEY UPDATE`
which requires PHQL grammar work (deferred). The base helper is
overridden here to throw, preventing accidental emission of invalid
SQL on MySQL connections.
sharedLock()
```php
public function sharedLock(
string $sqlQuery,
string $modifier = ""
): string;
```
Returns a SQL modified with a LOCK IN SHARE MODE clause. The `modifier`
argument is accepted for signature parity with the contract but is
silently ignored on MySQL - its legacy `LOCK IN SHARE MODE` syntax has
no `NOWAIT` / `SKIP LOCKED` variant. Callers needing those modifiers
should target PostgreSQL or stay on `forUpdate()`.
```php
$sql = $dialect->sharedLock("SELECT * FROM co_invoices");
echo $sql; // SELECT * FROM co_invoices LOCK IN SHARE MODE
```
supportsOnConflictUpdate()
```php
public function supportsOnConflictUpdate(): bool;
```
MySQL does not support the SQL-standard `ON CONFLICT (...) DO UPDATE`
upsert clause; `onConflictUpdate()` throws.
tableExists()
```php
public function tableExists(
string $tableName,
string|null $schemaName = null
): string;
```
Generates SQL checking for the existence of a schema.table
```php
echo $dialect->tableExists("posts", "blog");
echo $dialect->tableExists("posts");
```
tableOptions()
```php
public function tableOptions(
string $table,
string|null $schema = null
): string;
```
Generates the SQL to describe the table creation options
truncateTable()
```php
public function truncateTable(
string $tableName,
string $schemaName
): string;
```
Generates SQL to truncate a table
viewExists()
```php
public function viewExists(
string $viewName,
string|null $schemaName = null
): string;
```
Generates SQL checking for the existence of a schema.view
Protected · 1
getTableOptions()
```php
protected function getTableOptions( array $definition ): string;
```
Generates SQL to add the table creation options
## Db\Dialect\Postgresql
Class
Source on GitHub
Generates database specific SQL for the PostgreSQL RDBMS
- [`Phalcon\Db\Dialect`](#dbdialect)
- **`Phalcon\Db\Dialect\Postgresql`**
__Uses__ `Phalcon\Db\CheckInterface` · `Phalcon\Db\Column` · `Phalcon\Db\ColumnInterface` · `Phalcon\Db\Dialect` · `Phalcon\Db\DialectInterface` · `Phalcon\Db\Exception` · `Phalcon\Db\Exceptions\MissingDefinitionKey` · `Phalcon\Db\Exceptions\ReturningRequiresColumn` · `Phalcon\Db\Exceptions\UnrecognizedDataType` · `Phalcon\Db\IndexInterface` · `Phalcon\Db\RawValue` · `Phalcon\Db\ReferenceInterface`
### Method Summary
public
string
addCheck(string $tableName,string $schemaName,CheckInterface $check)
Generates SQL to add a CHECK constraint to an existing table.
public
string
addColumn(string $tableName,string $schemaName,ColumnInterface $column)
Generates SQL to add a column to a table
public
string
addForeignKey(string $tableName,string $schemaName,ReferenceInterface $reference)
Generates SQL to add an index to a table
public
string
addIndex(string $tableName,string $schemaName,IndexInterface $index)
Generates SQL to add an index to a table
public
string
addPrimaryKey(string $tableName,string $schemaName,IndexInterface $index)
Generates SQL to add the primary key to a table
public
string
createMaterializedView(string $viewName,array $definition,string|null $schemaName = null)
Generates SQL to create a materialized view.
public
string
createTable(string $tableName,string $schemaName,array $definition)
Generates SQL to create a table
public
string
createView(string $viewName,array $definition,string|null $schemaName = null)
Generates SQL to create a view
public
string
describeColumns(string $table,string|null $schema = null)
Generates SQL describing a table
public
string
describeIndexes(string $table,string|null $schema = null)
Generates SQL to query indexes on a table
public
string
describeReferences(string $table,string|null $schema = null)
Generates SQL to query foreign keys on a table
public
string
dropCheck(string $tableName,string $schemaName,string $checkName)
Generates SQL to delete a CHECK constraint from a table
public
string
dropColumn(string $tableName,string $schemaName,string $columnName)
Generates SQL to delete a column from a table
public
string
dropForeignKey(string $tableName,string $schemaName,string $referenceName)
Generates SQL to delete a foreign key from a table
public
string
dropIndex(string $tableName,string $schemaName,string $indexName)
Generates SQL to delete an index from a table
public
string
dropMaterializedView(string $viewName,string|null $schemaName = null,bool $ifExists = true)
Generates SQL to drop a materialized view.
public
string
dropPrimaryKey(string $tableName,string $schemaName)
Generates SQL to delete primary key from a table
public
string
dropTable(string $tableName,string|null $schemaName = null,bool $ifExists = true)
Generates SQL to drop a table
public
string
dropView(string $viewName,string|null $schemaName = null,bool $ifExists = true)
Generates SQL to drop a view
public
string
getColumnDefinition( ColumnInterface $column )
Gets the column name in PostgreSQL
public
string
listTables( string|null $schemaName = null )
List all tables in database
public
string
listViews( string|null $schemaName = null )
Generates the SQL to list all views of a schema or user
public
string
modifyColumn(string $tableName,string $schemaName,ColumnInterface $column,ColumnInterface|null $currentColumn = null)
Generates SQL to modify a column in a table
public
string
refreshMaterializedView(string $viewName,string|null $schemaName = null,bool $concurrent = false)
Generates SQL to refresh a materialized view. When concurrent is
public
string
returning(string $sqlQuery,array $columns)
Appends a RETURNING clause to the supplied INSERT/UPDATE/DELETE
public
string
sharedLock(string $sqlQuery,string $modifier = "")
Returns a SQL modified with a FOR SHARE clause - PostgreSQL's
public
bool
supportsMaterializedViews()
PostgreSQL supports materialized views (CREATE MATERIALIZED VIEW).
public
bool
supportsReturning()
PostgreSQL supports the RETURNING clause.
public
string
tableExists(string $tableName,string|null $schemaName = null)
Generates SQL checking for the existence of a schema.table
public
string
tableOptions(string $table,string|null $schema = null)
Generates the SQL to describe the table creation options
public
string
truncateTable(string $tableName,string $schemaName)
Generates SQL to truncate a table
public
string
viewExists(string $viewName,string|null $schemaName = null)
Generates SQL checking for the existence of a schema.view
protected
string
castDefault( ColumnInterface $column )
protected
string
getTableOptions( array $definition )
### Properties
protected
string
$escapeChar = "\""
protected
array
$supportedOperators = [...]
### Methods
Public · 32
addCheck()
```php
public function addCheck(
string $tableName,
string $schemaName,
CheckInterface $check
): string;
```
Generates SQL to add a CHECK constraint to an existing table.
addColumn()
```php
public function addColumn(
string $tableName,
string $schemaName,
ColumnInterface $column
): string;
```
Generates SQL to add a column to a table
addForeignKey()
```php
public function addForeignKey(
string $tableName,
string $schemaName,
ReferenceInterface $reference
): string;
```
Generates SQL to add an index to a table
addIndex()
```php
public function addIndex(
string $tableName,
string $schemaName,
IndexInterface $index
): string;
```
Generates SQL to add an index to a table
addPrimaryKey()
```php
public function addPrimaryKey(
string $tableName,
string $schemaName,
IndexInterface $index
): string;
```
Generates SQL to add the primary key to a table
createMaterializedView()
```php
public function createMaterializedView(
string $viewName,
array $definition,
string|null $schemaName = null
): string;
```
Generates SQL to create a materialized view.
createTable()
```php
public function createTable(
string $tableName,
string $schemaName,
array $definition
): string;
```
Generates SQL to create a table
createView()
```php
public function createView(
string $viewName,
array $definition,
string|null $schemaName = null
): string;
```
Generates SQL to create a view
describeColumns()
```php
public function describeColumns(
string $table,
string|null $schema = null
): string;
```
Generates SQL describing a table
```php
print_r(
$dialect->describeColumns("posts")
);
```
describeIndexes()
```php
public function describeIndexes(
string $table,
string|null $schema = null
): string;
```
Generates SQL to query indexes on a table
describeReferences()
```php
public function describeReferences(
string $table,
string|null $schema = null
): string;
```
Generates SQL to query foreign keys on a table
dropCheck()
```php
public function dropCheck(
string $tableName,
string $schemaName,
string $checkName
): string;
```
Generates SQL to delete a CHECK constraint from a table
dropColumn()
```php
public function dropColumn(
string $tableName,
string $schemaName,
string $columnName
): string;
```
Generates SQL to delete a column from a table
dropForeignKey()
```php
public function dropForeignKey(
string $tableName,
string $schemaName,
string $referenceName
): string;
```
Generates SQL to delete a foreign key from a table
dropIndex()
```php
public function dropIndex(
string $tableName,
string $schemaName,
string $indexName
): string;
```
Generates SQL to delete an index from a table
dropMaterializedView()
```php
public function dropMaterializedView(
string $viewName,
string|null $schemaName = null,
bool $ifExists = true
): string;
```
Generates SQL to drop a materialized view.
dropPrimaryKey()
```php
public function dropPrimaryKey(
string $tableName,
string $schemaName
): string;
```
Generates SQL to delete primary key from a table
dropTable()
```php
public function dropTable(
string $tableName,
string|null $schemaName = null,
bool $ifExists = true
): string;
```
Generates SQL to drop a table
dropView()
```php
public function dropView(
string $viewName,
string|null $schemaName = null,
bool $ifExists = true
): string;
```
Generates SQL to drop a view
getColumnDefinition()
```php
public function getColumnDefinition( ColumnInterface $column ): string;
```
Gets the column name in PostgreSQL
listTables()
```php
public function listTables( string|null $schemaName = null ): string;
```
List all tables in database
```php
print_r(
$dialect->listTables("blog")
);
```
listViews()
```php
public function listViews( string|null $schemaName = null ): string;
```
Generates the SQL to list all views of a schema or user
modifyColumn()
```php
public function modifyColumn(
string $tableName,
string $schemaName,
ColumnInterface $column,
ColumnInterface|null $currentColumn = null
): string;
```
Generates SQL to modify a column in a table
refreshMaterializedView()
```php
public function refreshMaterializedView(
string $viewName,
string|null $schemaName = null,
bool $concurrent = false
): string;
```
Generates SQL to refresh a materialized view. When `concurrent` is
true, emits `REFRESH MATERIALIZED VIEW CONCURRENTLY ...` (avoids
blocking concurrent SELECTs; requires a unique index on the view).
returning()
```php
public function returning(
string $sqlQuery,
array $columns
): string;
```
Appends a `RETURNING` clause to the supplied INSERT/UPDATE/DELETE
statement. Pass `["*"]` for `RETURNING *`, or a list of column names.
sharedLock()
```php
public function sharedLock(
string $sqlQuery,
string $modifier = ""
): string;
```
Returns a SQL modified with a `FOR SHARE` clause - PostgreSQL's
equivalent of MySQL's `LOCK IN SHARE MODE`. The optional `modifier`
appends a row-lock disposition keyword (pass `Dialect::LOCK_NOWAIT`
or `Dialect::LOCK_SKIP_LOCKED`).
```php
echo $dialect->sharedLock("SELECT * FROM co_invoices");
// SELECT * FROM co_invoices FOR SHARE
echo $dialect->sharedLock(
"SELECT * FROM co_invoices",
Dialect::LOCK_NOWAIT
);
// SELECT * FROM co_invoices FOR SHARE NOWAIT
```
supportsMaterializedViews()
```php
public function supportsMaterializedViews(): bool;
```
PostgreSQL supports materialized views (`CREATE MATERIALIZED VIEW`).
supportsReturning()
```php
public function supportsReturning(): bool;
```
PostgreSQL supports the `RETURNING` clause.
tableExists()
```php
public function tableExists(
string $tableName,
string|null $schemaName = null
): string;
```
Generates SQL checking for the existence of a schema.table
```php
echo $dialect->tableExists("posts", "blog");
echo $dialect->tableExists("posts");
```
tableOptions()
```php
public function tableOptions(
string $table,
string|null $schema = null
): string;
```
Generates the SQL to describe the table creation options
truncateTable()
```php
public function truncateTable(
string $tableName,
string $schemaName
): string;
```
Generates SQL to truncate a table
viewExists()
```php
public function viewExists(
string $viewName,
string|null $schemaName = null
): string;
```
Generates SQL checking for the existence of a schema.view
Protected · 2
castDefault()
```php
protected function castDefault( ColumnInterface $column ): string;
```
getTableOptions()
```php
protected function getTableOptions( array $definition ): string;
```
## Db\Dialect\Sqlite
Class
Source on GitHub
Generates database specific SQL for the SQLite RDBMS
- [`Phalcon\Db\Dialect`](#dbdialect)
- **`Phalcon\Db\Dialect\Sqlite`**
__Uses__ `Phalcon\Db\CheckInterface` · `Phalcon\Db\Column` · `Phalcon\Db\ColumnInterface` · `Phalcon\Db\Dialect` · `Phalcon\Db\DialectInterface` · `Phalcon\Db\Exception` · `Phalcon\Db\Exceptions\MissingDefinitionKey` · `Phalcon\Db\Exceptions\ReturningRequiresColumn` · `Phalcon\Db\Exceptions\SqliteAlterCheckNotSupported` · `Phalcon\Db\Exceptions\SqliteAlterColumnNotSupported` · `Phalcon\Db\Exceptions\SqliteAlterForeignKeyNotSupported` · `Phalcon\Db\Exceptions\SqliteAlterPrimaryKeyNotSupported` · `Phalcon\Db\Exceptions\SqliteDropCheckNotSupported` · `Phalcon\Db\Exceptions\SqliteDropForeignKeyNotSupported` · `Phalcon\Db\Exceptions\SqliteDropPrimaryKeyNotSupported` · `Phalcon\Db\Exceptions\UnrecognizedDataType` · `Phalcon\Db\IndexInterface` · `Phalcon\Db\RawValue` · `Phalcon\Db\ReferenceInterface`
### Method Summary
public
string
addCheck(string $tableName,string $schemaName,CheckInterface $check)
SQLite cannot ALTER an existing table to add a CHECK constraint;
public
string
addColumn(string $tableName,string $schemaName,ColumnInterface $column)
Generates SQL to add a column to a table
public
string
addForeignKey(string $tableName,string $schemaName,ReferenceInterface $reference)
Generates SQL to add an index to a table
public
string
addIndex(string $tableName,string $schemaName,IndexInterface $index)
Generates SQL to add an index to a table
public
string
addPrimaryKey(string $tableName,string $schemaName,IndexInterface $index)
Generates SQL to add the primary key to a table
public
string
createTable(string $tableName,string $schemaName,array $definition)
Generates SQL to create a table
public
string
createView(string $viewName,array $definition,string|null $schemaName = null)
Generates SQL to create a view
public
string
describeColumns(string $table,string|null $schema = null)
Generates SQL describing a table
public
string
describeIndex( string $index )
Generates SQL to query indexes detail on a table
public
string
describeIndexes(string $table,string|null $schema = null)
Generates SQL to query indexes on a table
public
string
describeReferences(string $table,string|null $schema = null)
Generates SQL to query foreign keys on a table
public
string
dropCheck(string $tableName,string $schemaName,string $checkName)
SQLite cannot DROP a CHECK constraint from an existing table.
public
string
dropColumn(string $tableName,string $schemaName,string $columnName)
Generates SQL to delete a column from a table.
public
string
dropForeignKey(string $tableName,string $schemaName,string $referenceName)
Generates SQL to delete a foreign key from a table
public
string
dropIndex(string $tableName,string $schemaName,string $indexName)
Generates SQL to delete an index from a table
public
string
dropPrimaryKey(string $tableName,string $schemaName)
Generates SQL to delete primary key from a table
public
string
dropTable(string $tableName,string|null $schemaName = null,bool $ifExists = true)
Generates SQL to drop a table
public
string
dropView(string $viewName,string|null $schemaName = null,bool $ifExists = true)
Generates SQL to drop a view
public
string
forUpdate(string $sqlQuery,string $modifier = "")
Returns a SQL modified with a FOR UPDATE clause. SQLite has no
public
string
getColumnDefinition( ColumnInterface $column )
Gets the column name in SQLite
public
string
listIndexesSql(string $table,string|null $schema = null,string|null $keyName = null)
Generates the SQL to get query list of indexes
public
string
listTables( string|null $schemaName = null )
List all tables in database
public
string
listViews( string|null $schemaName = null )
Generates the SQL to list all views of a schema or user
public
string
modifyColumn(string $tableName,string $schemaName,ColumnInterface $column,ColumnInterface|null $currentColumn = null)
Generates SQL to modify a column in a table
public
string
returning(string $sqlQuery,array $columns)
Appends a RETURNING clause to the supplied INSERT/UPDATE/DELETE
public
string
sharedLock(string $sqlQuery,string $modifier = "")
SQLite has no row-level shared-lock construct, so the original query
public
bool
supportsAlterTable()
SQLite cannot modify existing columns or add/drop foreign keys, primary
public
bool
supportsReturning()
SQLite (3.35+) supports the RETURNING clause.
public
string
tableExists(string $tableName,string|null $schemaName = null)
Generates SQL checking for the existence of a schema.table
public
string
tableOptions(string $table,string|null $schema = null)
Generates the SQL to describe the table creation options
public
string
truncateTable(string $tableName,string $schemaName)
Generates SQL to truncate a table
public
string
viewExists(string $viewName,string|null $schemaName = null)
Generates SQL checking for the existence of a schema.view
### Properties
protected
string
$escapeChar = "\""
protected
array
$supportedOperators = [...]
### Methods
Public · 32
addCheck()
```php
public function addCheck(
string $tableName,
string $schemaName,
CheckInterface $check
): string;
```
SQLite cannot ALTER an existing table to add a CHECK constraint;
the constraint must be declared at CREATE TABLE time.
addColumn()
```php
public function addColumn(
string $tableName,
string $schemaName,
ColumnInterface $column
): string;
```
Generates SQL to add a column to a table
addForeignKey()
```php
public function addForeignKey(
string $tableName,
string $schemaName,
ReferenceInterface $reference
): string;
```
Generates SQL to add an index to a table
addIndex()
```php
public function addIndex(
string $tableName,
string $schemaName,
IndexInterface $index
): string;
```
Generates SQL to add an index to a table
addPrimaryKey()
```php
public function addPrimaryKey(
string $tableName,
string $schemaName,
IndexInterface $index
): string;
```
Generates SQL to add the primary key to a table
createTable()
```php
public function createTable(
string $tableName,
string $schemaName,
array $definition
): string;
```
Generates SQL to create a table
createView()
```php
public function createView(
string $viewName,
array $definition,
string|null $schemaName = null
): string;
```
Generates SQL to create a view
describeColumns()
```php
public function describeColumns(
string $table,
string|null $schema = null
): string;
```
Generates SQL describing a table
```php
print_r(
$dialect->describeColumns("posts")
);
```
describeIndex()
```php
public function describeIndex( string $index ): string;
```
Generates SQL to query indexes detail on a table
describeIndexes()
```php
public function describeIndexes(
string $table,
string|null $schema = null
): string;
```
Generates SQL to query indexes on a table
describeReferences()
```php
public function describeReferences(
string $table,
string|null $schema = null
): string;
```
Generates SQL to query foreign keys on a table
dropCheck()
```php
public function dropCheck(
string $tableName,
string $schemaName,
string $checkName
): string;
```
SQLite cannot DROP a CHECK constraint from an existing table.
dropColumn()
```php
public function dropColumn(
string $tableName,
string $schemaName,
string $columnName
): string;
```
Generates SQL to delete a column from a table.
SQLite 3.35+ supports `ALTER TABLE ... DROP COLUMN ...` directly. On
older versions the server rejects the statement at execution time;
cphalcon no longer pre-empts that rejection at the dialect level so
callers on 3.35+ can use the feature.
dropForeignKey()
```php
public function dropForeignKey(
string $tableName,
string $schemaName,
string $referenceName
): string;
```
Generates SQL to delete a foreign key from a table
dropIndex()
```php
public function dropIndex(
string $tableName,
string $schemaName,
string $indexName
): string;
```
Generates SQL to delete an index from a table
dropPrimaryKey()
```php
public function dropPrimaryKey(
string $tableName,
string $schemaName
): string;
```
Generates SQL to delete primary key from a table
dropTable()
```php
public function dropTable(
string $tableName,
string|null $schemaName = null,
bool $ifExists = true
): string;
```
Generates SQL to drop a table
dropView()
```php
public function dropView(
string $viewName,
string|null $schemaName = null,
bool $ifExists = true
): string;
```
Generates SQL to drop a view
forUpdate()
```php
public function forUpdate(
string $sqlQuery,
string $modifier = ""
): string;
```
Returns a SQL modified with a FOR UPDATE clause. SQLite has no
row-level locking, so the original query is returned unchanged
regardless of the `modifier` argument (`NOWAIT` / `SKIP LOCKED` are
silently ignored).
getColumnDefinition()
```php
public function getColumnDefinition( ColumnInterface $column ): string;
```
Gets the column name in SQLite
listIndexesSql()
```php
public function listIndexesSql(
string $table,
string|null $schema = null,
string|null $keyName = null
): string;
```
Generates the SQL to get query list of indexes
```php
print_r(
$dialect->listIndexesSql("blog")
);
```
listTables()
```php
public function listTables( string|null $schemaName = null ): string;
```
List all tables in database
```php
print_r(
$dialect->listTables("blog")
);
```
listViews()
```php
public function listViews( string|null $schemaName = null ): string;
```
Generates the SQL to list all views of a schema or user
modifyColumn()
```php
public function modifyColumn(
string $tableName,
string $schemaName,
ColumnInterface $column,
ColumnInterface|null $currentColumn = null
): string;
```
Generates SQL to modify a column in a table
returning()
```php
public function returning(
string $sqlQuery,
array $columns
): string;
```
Appends a `RETURNING` clause to the supplied INSERT/UPDATE/DELETE
statement. Supported by SQLite 3.35+. Pass `["*"]` for `RETURNING *`,
or a list of column names.
sharedLock()
```php
public function sharedLock(
string $sqlQuery,
string $modifier = ""
): string;
```
SQLite has no row-level shared-lock construct, so the original query
is returned unchanged regardless of the `modifier` argument.
supportsAlterTable()
```php
public function supportsAlterTable(): bool;
```
SQLite cannot modify existing columns or add/drop foreign keys, primary
keys, or check constraints through `ALTER TABLE`; those operations throw
a dedicated `Sqlite*NotSupported` exception.
supportsReturning()
```php
public function supportsReturning(): bool;
```
SQLite (3.35+) supports the `RETURNING` clause.
tableExists()
```php
public function tableExists(
string $tableName,
string|null $schemaName = null
): string;
```
Generates SQL checking for the existence of a schema.table
```php
echo $dialect->tableExists("posts", "blog");
echo $dialect->tableExists("posts");
```
tableOptions()
```php
public function tableOptions(
string $table,
string|null $schema = null
): string;
```
Generates the SQL to describe the table creation options
truncateTable()
```php
public function truncateTable(
string $tableName,
string $schemaName
): string;
```
Generates SQL to truncate a table
viewExists()
```php
public function viewExists(
string $viewName,
string|null $schemaName = null
): string;
```
Generates SQL checking for the existence of a schema.view
## Db\Enum
Class
Source on GitHub
Constants for Phalcon\Db
- **`Phalcon\Db\Enum`**
### Constants
int
FETCH_ASSOC = \PDO::FETCH_ASSOC
int
FETCH_BOTH = \PDO::FETCH_BOTH
int
FETCH_BOUND = \PDO::FETCH_BOUND
int
FETCH_CLASS = \PDO::FETCH_CLASS
int
FETCH_CLASSTYPE = \PDO::FETCH_CLASSTYPE
int
FETCH_COLUMN = \PDO::FETCH_COLUMN
int
FETCH_DEFAULT = \PDO::FETCH_DEFAULT
int
FETCH_FUNC = \PDO::FETCH_FUNC
int
FETCH_GROUP = \PDO::FETCH_GROUP
int
FETCH_INTO = \PDO::FETCH_INTO
int
FETCH_KEY_PAIR = \PDO::FETCH_KEY_PAIR
int
FETCH_LAZY = \PDO::FETCH_LAZY
int
FETCH_NAMED = \PDO::FETCH_NAMED
int
FETCH_NUM = \PDO::FETCH_NUM
int
FETCH_OBJ = \PDO::FETCH_OBJ
int
FETCH_ORI_NEXT = \PDO::FETCH_ORI_NEXT
int
FETCH_PROPS_LATE = \PDO::FETCH_PROPS_LATE
int
FETCH_SERIALIZE = \PDO::FETCH_SERIALIZE
int
FETCH_UNIQUE = \PDO::FETCH_UNIQUE
## Db\Exception
Class
Source on GitHub
Exceptions thrown in Phalcon\Db will use this class
- `\Exception`
- **`Phalcon\Db\Exception`**
- [`Phalcon\Db\Exceptions\CannotInsertWithoutData`](#dbexceptionscannotinsertwithoutdata)
- [`Phalcon\Db\Exceptions\CannotPrepareStatement`](#dbexceptionscannotpreparestatement)
- [`Phalcon\Db\Exceptions\CheckExpressionRequired`](#dbexceptionscheckexpressionrequired)
- [`Phalcon\Db\Exceptions\ColumnTypeRejectsAutoIncrement`](#dbexceptionscolumntyperejectsautoincrement)
- [`Phalcon\Db\Exceptions\ColumnTypeRejectsScale`](#dbexceptionscolumntyperejectsscale)
- [`Phalcon\Db\Exceptions\ColumnTypeRequired`](#dbexceptionscolumntyperequired)
- [`Phalcon\Db\Exceptions\ConflictTargetColumnRequired`](#dbexceptionsconflicttargetcolumnrequired)
- [`Phalcon\Db\Exceptions\ConflictUpdateColumnRequired`](#dbexceptionsconflictupdatecolumnrequired)
- [`Phalcon\Db\Exceptions\ForeignKeyColumnsRequired`](#dbexceptionsforeignkeycolumnsrequired)
- [`Phalcon\Db\Exceptions\GeneratedAutoIncrementConflict`](#dbexceptionsgeneratedautoincrementconflict)
- [`Phalcon\Db\Exceptions\GeneratedDefaultConflict`](#dbexceptionsgenerateddefaultconflict)
- [`Phalcon\Db\Exceptions\IncompleteBindTypes`](#dbexceptionsincompletebindtypes)
- [`Phalcon\Db\Exceptions\InvalidBindParameter`](#dbexceptionsinvalidbindparameter)
- [`Phalcon\Db\Exceptions\InvalidCheckExpression`](#dbexceptionsinvalidcheckexpression)
- [`Phalcon\Db\Exceptions\InvalidDialectClass`](#dbexceptionsinvaliddialectclass)
- [`Phalcon\Db\Exceptions\InvalidGenerationExpression`](#dbexceptionsinvalidgenerationexpression)
- [`Phalcon\Db\Exceptions\InvalidGroupByExpression`](#dbexceptionsinvalidgroupbyexpression)
- [`Phalcon\Db\Exceptions\InvalidIndexColumns`](#dbexceptionsinvalidindexcolumns)
- [`Phalcon\Db\Exceptions\InvalidIndexDirections`](#dbexceptionsinvalidindexdirections)
- [`Phalcon\Db\Exceptions\InvalidIndexWhere`](#dbexceptionsinvalidindexwhere)
- [`Phalcon\Db\Exceptions\InvalidListExpression`](#dbexceptionsinvalidlistexpression)
- [`Phalcon\Db\Exceptions\InvalidOrderByExpression`](#dbexceptionsinvalidorderbyexpression)
- [`Phalcon\Db\Exceptions\InvalidSqlExpression`](#dbexceptionsinvalidsqlexpression)
- [`Phalcon\Db\Exceptions\InvalidSqlExpressionType`](#dbexceptionsinvalidsqlexpressiontype)
- [`Phalcon\Db\Exceptions\InvalidUnaryExpression`](#dbexceptionsinvalidunaryexpression)
- [`Phalcon\Db\Exceptions\InvalidWhereConditions`](#dbexceptionsinvalidwhereconditions)
- [`Phalcon\Db\Exceptions\InvalidWkb`](#dbexceptionsinvalidwkb)
- [`Phalcon\Db\Exceptions\MatchedParameterNotFound`](#dbexceptionsmatchedparameternotfound)
- [`Phalcon\Db\Exceptions\MaterializedViewsNotSupported`](#dbexceptionsmaterializedviewsnotsupported)
- [`Phalcon\Db\Exceptions\MissingDefinitionKey`](#dbexceptionsmissingdefinitionkey)
- [`Phalcon\Db\Exceptions\MissingForeignKeyChecks`](#dbexceptionsmissingforeignkeychecks)
- [`Phalcon\Db\Exceptions\MissingSqliteDatabase`](#dbexceptionsmissingsqlitedatabase)
- [`Phalcon\Db\Exceptions\MysqlOnConflictNotSupported`](#dbexceptionsmysqlonconflictnotsupported)
- [`Phalcon\Db\Exceptions\NestedTransactionChangeBlocked`](#dbexceptionsnestedtransactionchangeblocked)
- [`Phalcon\Db\Exceptions\NoActiveTransaction`](#dbexceptionsnoactivetransaction)
- [`Phalcon\Db\Exceptions\ReferencedColumnCountMismatch`](#dbexceptionsreferencedcolumncountmismatch)
- [`Phalcon\Db\Exceptions\ReferencedColumnsRequired`](#dbexceptionsreferencedcolumnsrequired)
- [`Phalcon\Db\Exceptions\ReferencedTableRequired`](#dbexceptionsreferencedtablerequired)
- [`Phalcon\Db\Exceptions\ReturningNotSupported`](#dbexceptionsreturningnotsupported)
- [`Phalcon\Db\Exceptions\ReturningRequiresColumn`](#dbexceptionsreturningrequirescolumn)
- [`Phalcon\Db\Exceptions\SavepointsNotSupported`](#dbexceptionssavepointsnotsupported)
- [`Phalcon\Db\Exceptions\SqliteAlterCheckNotSupported`](#dbexceptionssqlitealterchecknotsupported)
- [`Phalcon\Db\Exceptions\SqliteAlterColumnNotSupported`](#dbexceptionssqlitealtercolumnnotsupported)
- [`Phalcon\Db\Exceptions\SqliteAlterForeignKeyNotSupported`](#dbexceptionssqlitealterforeignkeynotsupported)
- [`Phalcon\Db\Exceptions\SqliteAlterPrimaryKeyNotSupported`](#dbexceptionssqlitealterprimarykeynotsupported)
- [`Phalcon\Db\Exceptions\SqliteDropCheckNotSupported`](#dbexceptionssqlitedropchecknotsupported)
- [`Phalcon\Db\Exceptions\SqliteDropForeignKeyNotSupported`](#dbexceptionssqlitedropforeignkeynotsupported)
- [`Phalcon\Db\Exceptions\SqliteDropPrimaryKeyNotSupported`](#dbexceptionssqlitedropprimarykeynotsupported)
- [`Phalcon\Db\Exceptions\TableMustHaveColumn`](#dbexceptionstablemusthavecolumn)
- [`Phalcon\Db\Exceptions\UnrecognizedDataType`](#dbexceptionsunrecognizeddatatype)
- [`Phalcon\Db\Exceptions\UnsupportedOperator`](#dbexceptionsunsupportedoperator)
- [`Phalcon\Db\Exceptions\UpdateFieldCountMismatch`](#dbexceptionsupdatefieldcountmismatch)
## Db\Exceptions\CannotInsertWithoutData
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\CannotInsertWithoutData`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $table );
```
## Db\Exceptions\CannotPrepareStatement
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\CannotPrepareStatement`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\CheckExpressionRequired
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\CheckExpressionRequired`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\ColumnTypeRejectsAutoIncrement
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\ColumnTypeRejectsAutoIncrement`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\ColumnTypeRejectsScale
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\ColumnTypeRejectsScale`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\ColumnTypeRequired
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\ColumnTypeRequired`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\ConflictTargetColumnRequired
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\ConflictTargetColumnRequired`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\ConflictUpdateColumnRequired
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\ConflictUpdateColumnRequired`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\ForeignKeyColumnsRequired
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\ForeignKeyColumnsRequired`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\GeneratedAutoIncrementConflict
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\GeneratedAutoIncrementConflict`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\GeneratedDefaultConflict
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\GeneratedDefaultConflict`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\IncompleteBindTypes
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\IncompleteBindTypes`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidBindParameter
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidBindParameter`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidCheckExpression
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidCheckExpression`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidDialectClass
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidDialectClass`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $className );
```
## Db\Exceptions\InvalidGenerationExpression
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidGenerationExpression`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidGroupByExpression
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidGroupByExpression`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidIndexColumns
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidIndexColumns`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidIndexDirections
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidIndexDirections`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidIndexWhere
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidIndexWhere`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidListExpression
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidListExpression`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidOrderByExpression
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidOrderByExpression`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidSqlExpression
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidSqlExpression`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidSqlExpressionType
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidSqlExpressionType`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $type );
```
## Db\Exceptions\InvalidUnaryExpression
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidUnaryExpression`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidWhereConditions
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidWhereConditions`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\InvalidWkb
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\InvalidWkb`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $reason );
```
## Db\Exceptions\MatchedParameterNotFound
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\MatchedParameterNotFound`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\MaterializedViewsNotSupported
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\MaterializedViewsNotSupported`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\MissingDefinitionKey
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\MissingDefinitionKey`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $key );
```
## Db\Exceptions\MissingForeignKeyChecks
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\MissingForeignKeyChecks`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\MissingSqliteDatabase
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\MissingSqliteDatabase`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\MysqlOnConflictNotSupported
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\MysqlOnConflictNotSupported`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\NestedTransactionChangeBlocked
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\NestedTransactionChangeBlocked`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\NoActiveTransaction
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\NoActiveTransaction`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\ReferencedColumnCountMismatch
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\ReferencedColumnCountMismatch`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\ReferencedColumnsRequired
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\ReferencedColumnsRequired`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\ReferencedTableRequired
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\ReferencedTableRequired`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\ReturningNotSupported
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\ReturningNotSupported`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\ReturningRequiresColumn
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\ReturningRequiresColumn`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\SavepointsNotSupported
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\SavepointsNotSupported`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\SqliteAlterCheckNotSupported
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\SqliteAlterCheckNotSupported`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\SqliteAlterColumnNotSupported
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\SqliteAlterColumnNotSupported`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\SqliteAlterForeignKeyNotSupported
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\SqliteAlterForeignKeyNotSupported`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\SqliteAlterPrimaryKeyNotSupported
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\SqliteAlterPrimaryKeyNotSupported`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\SqliteDropCheckNotSupported
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\SqliteDropCheckNotSupported`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\SqliteDropForeignKeyNotSupported
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\SqliteDropForeignKeyNotSupported`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\SqliteDropPrimaryKeyNotSupported
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\SqliteDropPrimaryKeyNotSupported`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\TableMustHaveColumn
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\TableMustHaveColumn`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Exceptions\UnrecognizedDataType
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\UnrecognizedDataType`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct(
string $dialect,
string $column
);
```
## Db\Exceptions\UnsupportedOperator
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\UnsupportedOperator`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct( string $operator );
```
## Db\Exceptions\UpdateFieldCountMismatch
Class
Source on GitHub
- `\Exception`
- [`Phalcon\Db\Exception`](#dbexception)
- **`Phalcon\Db\Exceptions\UpdateFieldCountMismatch`**
__Uses__ `Phalcon\Db\Exception`
### Method Summary
### Methods
Public · 1
__construct()
```php
public function __construct();
```
## Db\Geometry\AbstractGeometry
Abstract
Source on GitHub
- **`Phalcon\Db\Geometry\AbstractGeometry`** - implements [`Phalcon\Db\Geometry\GeometryInterface`](#dbgeometrygeometryinterface)
- [`Phalcon\Db\Geometry\GeometryCollection`](#dbgeometrygeometrycollection)
- [`Phalcon\Db\Geometry\LineString`](#dbgeometrylinestring)
- [`Phalcon\Db\Geometry\MultiLineString`](#dbgeometrymultilinestring)
- [`Phalcon\Db\Geometry\MultiPoint`](#dbgeometrymultipoint)
- [`Phalcon\Db\Geometry\MultiPolygon`](#dbgeometrymultipolygon)
- [`Phalcon\Db\Geometry\Point`](#dbgeometrypoint)
- [`Phalcon\Db\Geometry\Polygon`](#dbgeometrypolygon)
### Method Summary
### Properties
### Methods
Public · 4
__toString()
```php
public function __toString(): string;
```
getSrid()
```php
public function getSrid(): int;
```
getType()
```php
abstract public function getType(): int;
```
toWkt()
```php
abstract public function toWkt(): string;
```
## Db\Geometry\GeometryCollection
Class
Source on GitHub
- [`Phalcon\Db\Geometry\AbstractGeometry`](#dbgeometryabstractgeometry)
- **`Phalcon\Db\Geometry\GeometryCollection`**
__Uses__ `Phalcon\Db\Column`
### Method Summary
### Properties
protected
array
$geometries
### Methods
Public · 4
__construct()
```php
public function __construct(
array $geometries,
int $srid = 0
);
```
getGeometries()
```php
public function getGeometries(): array;
```
getType()
```php
public function getType(): int;
```
toWkt()
```php
public function toWkt(): string;
```
## Db\Geometry\GeometryInterface
Interface
Source on GitHub
Phalcon\Db\Geometry\GeometryInterface
- [`Phalcon\Contracts\Db\Geometry\Geometry`](/5.19/api/phalcon_contracts/#contractsdbgeometrygeometry)
- **`Phalcon\Db\Geometry\GeometryInterface`**
__Uses__ `Phalcon\Contracts\Db\Geometry\Geometry`
## Db\Geometry\LineString
Class
Source on GitHub
- [`Phalcon\Db\Geometry\AbstractGeometry`](#dbgeometryabstractgeometry)
- **`Phalcon\Db\Geometry\LineString`**
__Uses__ `Phalcon\Db\Column`
### Method Summary
### Properties
### Methods
Public · 5
__construct()
```php
public function __construct(
array $points,
int $srid = 0
);
```
getPoints()
```php
public function getPoints(): array;
```
getType()
```php
public function getType(): int;
```
pointsWkt()
```php
public function pointsWkt(): string;
```
toWkt()
```php
public function toWkt(): string;
```
## Db\Geometry\MultiLineString
Class
Source on GitHub
- [`Phalcon\Db\Geometry\AbstractGeometry`](#dbgeometryabstractgeometry)
- **`Phalcon\Db\Geometry\MultiLineString`**
__Uses__ `Phalcon\Db\Column`
### Method Summary
### Properties
protected
array
$lineStrings
### Methods
Public · 4
__construct()
```php
public function __construct(
array $lineStrings,
int $srid = 0
);
```
getLineStrings()
```php
public function getLineStrings(): array;
```
getType()
```php
public function getType(): int;
```
toWkt()
```php
public function toWkt(): string;
```
## Db\Geometry\MultiPoint
Class
Source on GitHub
- [`Phalcon\Db\Geometry\AbstractGeometry`](#dbgeometryabstractgeometry)
- **`Phalcon\Db\Geometry\MultiPoint`**
__Uses__ `Phalcon\Db\Column`
### Method Summary
### Properties
### Methods
Public · 4
__construct()
```php
public function __construct(
array $points,
int $srid = 0
);
```
getPoints()
```php
public function getPoints(): array;
```
getType()
```php
public function getType(): int;
```
toWkt()
```php
public function toWkt(): string;
```
## Db\Geometry\MultiPolygon
Class
Source on GitHub
- [`Phalcon\Db\Geometry\AbstractGeometry`](#dbgeometryabstractgeometry)
- **`Phalcon\Db\Geometry\MultiPolygon`**
__Uses__ `Phalcon\Db\Column`
### Method Summary
### Properties
protected
array
$polygons
### Methods
Public · 4
__construct()
```php
public function __construct(
array $polygons,
int $srid = 0
);
```
getPolygons()
```php
public function getPolygons(): array;
```
getType()
```php
public function getType(): int;
```
toWkt()
```php
public function toWkt(): string;
```
## Db\Geometry\Point
Class
Source on GitHub
- [`Phalcon\Db\Geometry\AbstractGeometry`](#dbgeometryabstractgeometry)
- **`Phalcon\Db\Geometry\Point`**
__Uses__ `Phalcon\Db\Column`
### Method Summary
### Properties
protected
float
$x
protected
float
$y
### Methods
Public · 6
__construct()
```php
public function __construct(
float $x,
float $y,
int $srid = 0
);
```
coordsWkt()
```php
public function coordsWkt(): string;
```
getType()
```php
public function getType(): int;
```
getX()
```php
public function getX(): float;
```
getY()
```php
public function getY(): float;
```
toWkt()
```php
public function toWkt(): string;
```
## Db\Geometry\Polygon
Class
Source on GitHub
- [`Phalcon\Db\Geometry\AbstractGeometry`](#dbgeometryabstractgeometry)
- **`Phalcon\Db\Geometry\Polygon`**
__Uses__ `Phalcon\Db\Column`
### Method Summary
### Properties
### Methods
Public · 5
__construct()
```php
public function __construct(
array $rings,
int $srid = 0
);
```
getRings()
```php
public function getRings(): array;
```
getType()
```php
public function getType(): int;
```
ringsWkt()
```php
public function ringsWkt(): string;
```
toWkt()
```php
public function toWkt(): string;
```
## Db\Geometry\WkbParser
Class
Source on GitHub
Decodes a spatial column value into a geometry value object.
Handles MySQL's internal format (4-byte little-endian SRID prefix followed
by standard OGC WKB) and PostGIS EWKB returned as a hex string. 2D only:
any Z/M ordinates are read past and discarded.
- **`Phalcon\Db\Geometry\WkbParser`**
__Uses__ `Phalcon\Db\Exceptions\InvalidWkb`
### Method Summary
### Properties
protected
string
$buffer = ""
protected
int
$length = 0
protected
int
$position = 0
### Methods
Public · 1
parse()
```php
public function parse( string $raw ): GeometryInterface;
```
Protected · 8
readByte()
```php
protected function readByte(): int;
```
readDouble()
```php
protected function readDouble( bool $little ): float;
```
readGeometry()
```php
protected function readGeometry( int $outerSrid ): GeometryInterface;
```
readPoint()
```php
protected function readPoint(
bool $little,
bool $hasZ,
bool $hasM,
int $srid
): Point;
```
readPointList()
```php
protected function readPointList(
bool $little,
bool $hasZ,
bool $hasM
): array;
```
readRingList()
```php
protected function readRingList(
bool $little,
bool $hasZ,
bool $hasM
): array;
```
readUint32()
```php
protected function readUint32( bool $little ): int;
```
```php
protected function skipExtraOrdinates(
bool $little,
bool $hasZ,
bool $hasM
): void;
```
## Db\Index
Class
Source on GitHub
Allows to define indexes to be used on tables. Indexes are a common way
to enhance database performance. An index allows the database server to find
and retrieve specific rows much faster than it could do without an index.
The constructor accepts either the legacy positional form (a plain array
of column names) or a definition-array form (an associative array with a
`columns` key); the latter is the path used by features such as
`invisible` (MySQL 8.0+) and is the form that future per-index modifiers
will extend.
```php
// Legacy positional form
$unique = new \Phalcon\Db\Index(
'column_UNIQUE',
[
'column',
],
'UNIQUE'
);
$primary = new \Phalcon\Db\Index(
'PRIMARY',
[
'column',
]
);
// Definition-array form (MySQL 8.0+ invisible index)
$hidden = new \Phalcon\Db\Index(
'idx_hidden',
[
'columns' => ['col1'],
'type' => '',
'invisible' => true,
]
);
$connection->addIndex("co_invoices", null, $unique);
$connection->addIndex("co_invoices", null, $primary);
$connection->addIndex("co_invoices", null, $hidden);
```
- **`Phalcon\Db\Index`** - implements [`Phalcon\Db\IndexInterface`](#dbindexinterface)
__Uses__ `Phalcon\Db\Exceptions\InvalidIndexColumns` · `Phalcon\Db\Exceptions\InvalidIndexDirections` · `Phalcon\Db\Exceptions\InvalidIndexWhere`
### Method Summary
### Properties
protected
array
$columns
Index columns
protected
bool
$concurrent = false
Whether to build the index without taking a strong lock that blocks writes - emits CONCURRENTLY between INDEX and the index name on PostgreSQL (CREATE INDEX CONCURRENTLY name ON ...). MySQL and SQLite have no equivalent and ignore the flag.
protected
array
$directions = []
Per-column sort directions (ASC / DESC). Empty array means "emit no per-column direction" - preserves the legacy plain (col1, col2) rendering. When populated, entries shorter than the columns list default to ASC for the missing positions.
protected
bool
$invisible = false
Whether the index is declared INVISIBLE (MySQL 8.0+). Invisible indexes are ignored by the optimizer - useful for testing what happens when an index is removed before actually dropping it. PostgreSQL and SQLite have no equivalent and ignore the flag.
protected
string
$name
Index name
protected
string
$type = ""
Index type
protected
string
$where = ""
Optional partial-index WHERE predicate. Supported by PostgreSQL and SQLite (CREATE INDEX ... WHERE <expr>); MySQL has no partial-index concept and its dialect ignores this value. Empty string means no predicate.
### Methods
Public · 8
__construct()
```php
public function __construct(
string $name,
array $columnsOrDefinition,
string $type = ""
);
```
Phalcon\Db\Index constructor.
Accepts either the legacy positional form `(name, columns, type)` or a
definition-array form `(name, ["columns" => [...], "type" => "...",
"invisible" => true, ...])`. Detection is based on the presence of a
`columns` key in the second argument; when present, the third
positional `type` argument is ignored in favor of the definition.
getColumns()
```php
public function getColumns(): array;
```
Index columns
getDirections()
```php
public function getDirections(): array;
```
Returns the per-column sort directions array (`ASC` / `DESC`).
Empty array means the index was declared without explicit per-column
directions and dialects emit the columns plainly. When populated,
entries are aligned with `getColumns()`; missing trailing positions
default to `ASC` at emission time.
getName()
```php
public function getName(): string;
```
Index name
getType()
```php
public function getType(): string;
```
Index type
getWhere()
```php
public function getWhere(): string;
```
Returns the partial-index `WHERE` predicate, or an empty string when
the index has none. Supported by PostgreSQL and SQLite; ignored by
the MySQL dialect (MySQL has no partial-index feature).
isConcurrent()
```php
public function isConcurrent(): bool;
```
Whether the index is built `CONCURRENTLY` (PostgreSQL only). MySQL
and SQLite have no equivalent and ignore the flag.
isInvisible()
```php
public function isInvisible(): bool;
```
Whether the index is declared `INVISIBLE` (MySQL 8.0+). Invisible
indexes are ignored by the optimizer but still maintained, so they
can be flipped back to visible without a rebuild.
## Db\IndexInterface
Interface
Source on GitHub
Phalcon\Db\IndexInterface
- [`Phalcon\Contracts\Db\Index`](/5.19/api/phalcon_contracts/#contractsdbindex)
- **`Phalcon\Db\IndexInterface`**
__Uses__ `Phalcon\Contracts\Db\Index`
## Db\Profiler
Class
Source on GitHub
Instances of Phalcon\Db can generate execution profiles
on SQL statements sent to the relational database. Profiled
information includes execution time in milliseconds.
This helps you to identify bottlenecks in your applications.
```php
use Phalcon\Db\Profiler;
use Phalcon\Events\Event;
use Phalcon\Events\Manager;
$profiler = new Profiler();
$eventsManager = new Manager();
$eventsManager->attach(
"db",
function (Event $event, $connection) use ($profiler) {
if ($event->getType() === "beforeQuery") {
$sql = $connection->getSQLStatement();
// Start a profile with the active connection
$profiler->startProfile($sql);
}
if ($event->getType() === "afterQuery") {
// Stop the active profile
$profiler->stopProfile();
}
}
);
// Set the event manager on the connection
$connection->setEventsManager($eventsManager);
$sql = "SELECT buyer_name, quantity, product_name
FROM buyers LEFT JOIN products ON
buyers.pid=products.id";
// Execute a SQL statement
$connection->query($sql);
// Get the last profile in the profiler
$profile = $profiler->getLastProfile();
echo "SQL Statement: ", $profile->getSQLStatement(), "\n";
echo "Start Time: ", $profile->getInitialTime(), "\n";
echo "Final Time: ", $profile->getFinalTime(), "\n";
echo "Total Elapsed Time: ", $profile->getTotalElapsedSeconds(), "\n";
```
- **`Phalcon\Db\Profiler`**
__Uses__ `Phalcon\Db\Profiler\Item` · `Phalcon\Db\Traits\ElapsedTimeTrait`
### Method Summary
### Properties
protected
Item
$activeProfile
Active Item
protected
Item[]
$allProfiles
All the Items in the active profile
protected
int
$maxProfiles = 0
Maximum number of profiles to retain. 0 (default) keeps the original unbounded behavior; a positive value drops the oldest profile FIFO before a new one is appended.
protected
float
$totalNanoseconds = 0
Total time spent by all profiles to complete in nanoseconds
### Methods
Public · 9
getLastProfile()
```php
public function getLastProfile(): Item;
```
Returns the last profile executed in the profiler
getMaxProfiles()
```php
public function getMaxProfiles(): int;
```
Returns the configured maximum number of retained profiles
(0 = unlimited)
getNumberTotalStatements()
```php
public function getNumberTotalStatements(): int;
```
Returns the total number of SQL statements processed
getProfiles()
```php
public function getProfiles(): Item[];
```
Returns all the processed profiles
getTotalElapsedNanoseconds()
```php
public function getTotalElapsedNanoseconds(): float;
```
Returns the total time in nanoseconds spent by the profiles
reset()
```php
public function reset(): static;
```
Resets the profiler, cleaning up all the profiles
setMaxProfiles()
```php
public function setMaxProfiles( int $maxProfiles ): static;
```
Sets the maximum number of retained profiles. 0 disables the cap
(the default; preserves the original unbounded behavior).
startProfile()
```php
public function startProfile(
string $sqlStatement,
array $sqlVariables = [],
array $sqlBindTypes = []
): static;
```
Starts the profile of a SQL sentence
stopProfile()
```php
public function stopProfile(): static;
```
Stops the active profile
## Db\Profiler\Item
Class
Source on GitHub
This class identifies each profile in a Phalcon\Db\Profiler
- **`Phalcon\Db\Profiler\Item`**
__Uses__ `Phalcon\Db\Traits\ElapsedTimeTrait`
### Method Summary
### Properties
protected
double
$finalTime
Timestamp when the profile ended
protected
double
$initialTime
Timestamp when the profile started
protected
array
$sqlBindTypes
SQL bind types related to the profile
protected
string
$sqlStatement
SQL statement related to the profile
protected
array
$sqlVariables
SQL variables related to the profile
### Methods
Public · 11
getFinalTime()
```php
public function getFinalTime(): float;
```
Return the timestamp when the profile ended
getInitialTime()
```php
public function getInitialTime(): float;
```
Return the timestamp when the profile started
getSqlBindTypes()
```php
public function getSqlBindTypes(): array;
```
Return the SQL bind types related to the profile
getSqlStatement()
```php
public function getSqlStatement(): string;
```
Return the SQL statement related to the profile
getSqlVariables()
```php
public function getSqlVariables(): array;
```
Return the SQL variables related to the profile
getTotalElapsedNanoseconds()
```php
public function getTotalElapsedNanoseconds(): float;
```
Returns the total time in nanoseconds spent by the profile
setFinalTime()
```php
public function setFinalTime( float $finalTime ): static;
```
Return the timestamp when the profile ended
setInitialTime()
```php
public function setInitialTime( float $initialTime ): static;
```
Return the timestamp when the profile started
setSqlBindTypes()
```php
public function setSqlBindTypes( array $sqlBindTypes ): static;
```
Return the SQL bind types related to the profile
setSqlStatement()
```php
public function setSqlStatement( string $sqlStatement ): static;
```
Return the SQL statement related to the profile
setSqlVariables()
```php
public function setSqlVariables( array $sqlVariables ): static;
```
Return the SQL variables related to the profile
## Db\RawValue
Class
Source on GitHub
This class allows to insert/update raw data without quoting or formatting.
The next example shows how to use the MySQL now() function as a field value.
```php
$subscriber = new Subscribers();
$subscriber->email = "andres@phalcon.io";
$subscriber->createdAt = new \Phalcon\Db\RawValue("now()");
$subscriber->save();
```
- **`Phalcon\Db\RawValue`**
### Method Summary
### Properties
protected
string
$value
Raw value without quoting or formatting
### Methods
Public · 3
__construct()
```php
public function __construct( mixed $value );
```
Phalcon\Db\RawValue constructor
__toString()
```php
public function __toString(): string;
```
getValue()
```php
public function getValue(): string;
```
## Db\Reference
Class
Source on GitHub
Allows to define reference constraints on tables
```php
$reference = new \Phalcon\Db\Reference(
"field_fk",
[
"referencedSchema" => "invoicing",
"referencedTable" => "products",
"columns" => [
"producttype",
"product_code",
],
"referencedColumns" => [
"type",
"code",
],
]
);
```
- **`Phalcon\Db\Reference`** - implements [`Phalcon\Db\ReferenceInterface`](#dbreferenceinterface)
__Uses__ `Phalcon\Db\Exceptions\ForeignKeyColumnsRequired` · `Phalcon\Db\Exceptions\ReferencedColumnCountMismatch` · `Phalcon\Db\Exceptions\ReferencedColumnsRequired` · `Phalcon\Db\Exceptions\ReferencedTableRequired`
### Method Summary
### Properties
protected
array
$columns
Local reference columns
protected
string
$name
Constraint name
protected
string
$onDelete
ON DELETE
protected
string
$onUpdate
ON UPDATE
protected
array
$referencedColumns
Referenced Columns
protected
string
$referencedSchema
Referenced Schema
protected
string
$referencedTable
Referenced Table
protected
string
$schemaName
Schema name
### Methods
Public · 9
__construct()
```php
public function __construct(
string $name,
array $definition
);
```
Phalcon\Db\Reference constructor
getColumns()
```php
public function getColumns(): array;
```
Local reference columns
getName()
```php
public function getName(): string;
```
Constraint name
getOnDelete()
```php
public function getOnDelete(): string|null;
```
ON DELETE
getOnUpdate()
```php
public function getOnUpdate(): string|null;
```
ON UPDATE
getReferencedColumns()
```php
public function getReferencedColumns(): array;
```
Referenced Columns
getReferencedSchema()
```php
public function getReferencedSchema(): string|null;
```
Referenced Schema
getReferencedTable()
```php
public function getReferencedTable(): string;
```
Referenced Table
getSchemaName()
```php
public function getSchemaName(): string|null;
```
Schema name
## Db\ReferenceInterface
Interface
Source on GitHub
Phalcon\Db\ReferenceInterface
- [`Phalcon\Contracts\Db\Reference`](/5.19/api/phalcon_contracts/#contractsdbreference)
- **`Phalcon\Db\ReferenceInterface`**
__Uses__ `Phalcon\Contracts\Db\Reference`
## Db\ResultInterface
Interface
Source on GitHub
Phalcon\Db\ResultInterface
- [`Phalcon\Contracts\Db\Result`](/5.19/api/phalcon_contracts/#contractsdbresult)
- **`Phalcon\Db\ResultInterface`**
__Uses__ `Phalcon\Contracts\Db\Result`
## Db\Result\PdoResult
Class
Source on GitHub
Encapsulates the resultset internals
```php
$result = $connection->query("SELECT * FROM co_invoices ORDER BY inv_title");
$result->setFetchMode(
\Phalcon\Db\Enum::FETCH_NUM
);
while ($invoice = $result->fetchArray()) {
print_r($invoice);
}
```
- **`Phalcon\Db\Result\PdoResult`** - implements [`Phalcon\Db\ResultInterface`](#dbresultinterface)
__Uses__ `Phalcon\Db\Adapter\AdapterInterface` · `Phalcon\Db\Enum` · `Phalcon\Db\ResultInterface`
### Method Summary
public
__construct(AdapterInterface $connection,\PDOStatement $result,mixed $sqlStatement = null,mixed $bindParams = null,mixed $bindTypes = null)
Phalcon\Db\Result\Pdo constructor
public
void
dataSeek( int $number )
Moves internal resultset cursor to another position letting us to fetch a
public
bool
execute()
Allows to execute the statement again. Some database systems don't
public
fetch(int|null $fetchStyle = null,int $cursorOrientation = Enum::FETCH_ORI_NEXT,int $cursorOffset = 0)
Fetches an array/object of strings that corresponds to the fetched row,
public
array
fetchAll(int $mode = Enum::FETCH_DEFAULT,mixed $fetchArgument = Enum::FETCH_ORI_NEXT,mixed $constructorArgs = null)
Returns an array of arrays containing all the records in the result
public
fetchArray()
Returns an array of strings that corresponds to the fetched row, or FALSE
public
\PDOStatement
getInternalResult()
Gets the internal PDO result object
public
int
numRows()
Gets number of rows returned by a resultset
public
bool
setFetchMode(int $fetchMode,mixed $colNoOrClassNameOrObject = null,mixed $ctorargs = null)
Changes the fetching mode affecting Phalcon\Db\Result\Pdo::fetch()
### Properties
protected
array
$bindParams = []
protected
array
$bindTypes = []
protected
AdapterInterface
$connection
protected
int
$fetchMode = Enum::FETCH_DEFAULT
Active fetch mode
protected
\PDOStatement
$pdoStatement
Internal resultset
protected
mixed
$result
protected
int|null
$rowCount = null
protected
string|null
$sqlStatement = null
### Methods
Public · 9
__construct()
```php
public function __construct(
AdapterInterface $connection,
\PDOStatement $result,
mixed $sqlStatement = null,
mixed $bindParams = null,
mixed $bindTypes = null
);
```
Phalcon\Db\Result\Pdo constructor
dataSeek()
```php
public function dataSeek( int $number ): void;
```
Moves internal resultset cursor to another position letting us to fetch a
certain row
```php
$result = $connection->query(
"SELECT * FROM co_invoices ORDER BY inv_title"
);
// Move to third row on result
$result->dataSeek(2);
// Fetch third row
$row = $result->fetch();
```
execute()
```php
public function execute(): bool;
```
Allows to execute the statement again. Some database systems don't
support scrollable cursors. So, as cursors are forward only, we need to
execute the cursor again to fetch rows from the beginning
fetch()
```php
public function fetch(
int|null $fetchStyle = null,
int $cursorOrientation = Enum::FETCH_ORI_NEXT,
int $cursorOffset = 0
);
```
Fetches an array/object of strings that corresponds to the fetched row,
or FALSE if there are no more rows. This method is affected by the active
fetch flag set using `Phalcon\Db\Result\Pdo::setFetchMode()`
```php
$result = $connection->query("SELECT * FROM co_invoices ORDER BY inv_title");
$result->setFetchMode(
\Phalcon\Enum::FETCH_OBJ
);
while ($invoice = $result->fetch()) {
echo $invoice->inv_title;
}
```
fetchAll()
```php
public function fetchAll(
int $mode = Enum::FETCH_DEFAULT,
mixed $fetchArgument = Enum::FETCH_ORI_NEXT,
mixed $constructorArgs = null
): array;
```
Returns an array of arrays containing all the records in the result
This method is affected by the active fetch flag set using
`Phalcon\Db\Result\Pdo::setFetchMode()`
```php
$result = $connection->query(
"SELECT * FROM co_invoices ORDER BY inv_title"
);
$invoices = $result->fetchAll();
```
fetchArray()
```php
public function fetchArray();
```
Returns an array of strings that corresponds to the fetched row, or FALSE
if there are no more rows. This method is affected by the active fetch
flag set using `Phalcon\Db\Result\Pdo::setFetchMode()`
```php
$result = $connection->query("SELECT * FROM co_invoices ORDER BY inv_title");
$result->setFetchMode(
\Phalcon\Enum::FETCH_NUM
);
while ($invoice = result->fetchArray()) {
print_r($invoice);
}
```
getInternalResult()
```php
public function getInternalResult(): \PDOStatement;
```
Gets the internal PDO result object
numRows()
```php
public function numRows(): int;
```
Gets number of rows returned by a resultset
```php
$result = $connection->query(
"SELECT * FROM co_invoices ORDER BY inv_title"
);
echo "There are ", $result->numRows(), " rows in the resultset";
```
setFetchMode()
```php
public function setFetchMode(
int $fetchMode,
mixed $colNoOrClassNameOrObject = null,
mixed $ctorargs = null
): bool;
```
Changes the fetching mode affecting Phalcon\Db\Result\Pdo::fetch()
```php
// Return array with integer indexes
$result->setFetchMode(
\Phalcon\Enum::FETCH_NUM
);
// Return associative array without integer indexes
$result->setFetchMode(
\Phalcon\Enum::FETCH_ASSOC
);
// Return associative array together with integer indexes
$result->setFetchMode(
\Phalcon\Enum::FETCH_BOTH
);
// Return an object
$result->setFetchMode(
\Phalcon\Enum::FETCH_OBJ
);
```
## Db\Traits\ElapsedTimeTrait
Trait
Source on GitHub
Derives elapsed milliseconds and seconds from the nanosecond total that the
using class exposes through getTotalElapsedNanoseconds().
- **`Phalcon\Db\Traits\ElapsedTimeTrait`**
__Used by__ [`Phalcon\Db\Profiler`](#dbprofiler) · [`Phalcon\Db\Profiler\Item`](#dbprofileritem)
### Method Summary
### Methods
Public · 3
getTotalElapsedMilliseconds()
```php
public function getTotalElapsedMilliseconds(): float;
```
Returns the total time in milliseconds spent by the profiles
getTotalElapsedNanoseconds()
```php
abstract public function getTotalElapsedNanoseconds(): float;
```
Returns the total time in nanoseconds spent by the profiles. Implemented
by the using class.
getTotalElapsedSeconds()
```php
public function getTotalElapsedSeconds(): float;
```
Returns the total time in seconds spent by the profiles
Source: https://docs.phalcon.io/5.19/api/phalcon_db/index.mdx