Trait SqliteDialectTrait
SQLite dialect trait
Property Summary
-
$_dateParts protected
array
Mapping of date parts.
-
$_endQuote protected
string
String used to end a database identifier quoting to make it safe
-
$_schemaDialect protected
Cake\Database\Schema\SqliteSchema
The schema dialect class for this driver
-
$_startQuote protected
string
String used to start a database identifier quoting to make it safe
Method Summary
-
_deleteQueryTranslator() protected
Apply translation steps to delete queries.
-
_expressionTranslators() protected
Returns a dictionary of expressions to be transformed when compiling a Query to SQL. Array keys are method names to be called in this class
-
_insertQueryTranslator() protected
Apply translation steps to insert queries.
-
_removeAliasesFromConditions() protected
Removes aliases from the
WHERE
clause of a query. -
_selectQueryTranslator() protected
Apply translation steps to select queries.
-
_transformDistinct() protected
Returns the passed query after rewriting the DISTINCT clause, so that drivers that do not support the "ON" part can provide the actual way it should be done
-
_transformFunctionExpression() protected
Receives a FunctionExpression and changes it so that it conforms to this SQL dialect.
-
_transformTupleComparison() protected
Receives a TupleExpression and changes it so that it conforms to this SQL dialect.
-
_updateQueryTranslator() protected
Apply translation steps to update queries.
-
disableForeignKeySQL() public
{@inheritDoc}
-
enableForeignKeySQL() public
{@inheritDoc}
-
newCompiler() public
{@inheritDoc}
-
queryTranslator() public
Returns a callable function that will be used to transform a passed Query object. This function, in turn, will return an instance of a Query object that has been transformed to accommodate any specificities of the SQL dialect in use.
-
quoteIdentifier() public
Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words
-
releaseSavePointSQL() public
Returns a SQL snippet for releasing a previously created save point
-
rollbackSavePointSQL() public
Returns a SQL snippet for rollbacking a previously created save point
-
savePointSQL() public
Returns a SQL snippet for creating a new transaction savepoint
-
schemaDialect() public
Get the schema dialect.
Method Detail
_deleteQueryTranslator() ¶ protected
_deleteQueryTranslator(Cake\Database\Query $query): Cake\Database\Query
Apply translation steps to delete queries.
Chops out aliases on delete query conditions as most database dialects do not support aliases in delete queries. This also removes aliases in table names as they frequently don't work either.
We are intentionally not supporting deletes with joins as they have even poorer support.
Parameters
-
Cake\Database\Query
$query The query to translate
Returns
Cake\Database\Query
_expressionTranslators() ¶ protected
_expressionTranslators(): array
Returns a dictionary of expressions to be transformed when compiling a Query to SQL. Array keys are method names to be called in this class
Returns
array
_insertQueryTranslator() ¶ protected
_insertQueryTranslator(Cake\Database\Query $query): Cake\Database\Query
Apply translation steps to insert queries.
Parameters
-
Cake\Database\Query
$query The query to translate
Returns
Cake\Database\Query
_removeAliasesFromConditions() ¶ protected
_removeAliasesFromConditions(Cake\Database\Query $query): Cake\Database\Query
Removes aliases from the WHERE
clause of a query.
Parameters
-
Cake\Database\Query
$query The query to process.
Returns
Cake\Database\Query
Throws
RuntimeException
In case the processed query contains any joins, as removing aliases from the conditions can break references to the joined tables.
_selectQueryTranslator() ¶ protected
_selectQueryTranslator(Cake\Database\Query $query): Cake\Database\Query
Apply translation steps to select queries.
Parameters
-
Cake\Database\Query
$query The query to translate
Returns
Cake\Database\Query
_transformDistinct() ¶ protected
_transformDistinct(Cake\Database\Query $query): Cake\Database\Query
Returns the passed query after rewriting the DISTINCT clause, so that drivers that do not support the "ON" part can provide the actual way it should be done
Parameters
-
Cake\Database\Query
$query The query to be transformed
Returns
Cake\Database\Query
_transformFunctionExpression() ¶ protected
_transformFunctionExpression(Cake\Database\Expression\FunctionExpression $expression): void
Receives a FunctionExpression and changes it so that it conforms to this SQL dialect.
Parameters
-
Cake\Database\Expression\FunctionExpression
$expression The function expression to translate for SQLite.
Returns
void
_transformTupleComparison() ¶ protected
_transformTupleComparison(Cake\Database\Expression\TupleComparison $expression, Cake\Database\Query $query): void
Receives a TupleExpression and changes it so that it conforms to this SQL dialect.
It transforms expressions looking like '(a, b) IN ((c, d), (e, f)' into an equivalent expression of the form '((a = c) AND (b = d)) OR ((a = e) AND (b = f))'.
It can also transform transform expressions where the right hand side is a query selecting the same amount of columns as the elements in the left hand side of the expression:
(a, b) IN (SELECT c, d FROM a_table) is transformed into
1 = (SELECT 1 FROM a_table WHERE (a = c) AND (b = d))
Parameters
-
Cake\Database\Expression\TupleComparison
$expression The expression to transform
-
Cake\Database\Query
$query The query to update.
Returns
void
_updateQueryTranslator() ¶ protected
_updateQueryTranslator(Cake\Database\Query $query): Cake\Database\Query
Apply translation steps to update queries.
Chops out aliases on update query conditions as not all database dialects do support aliases in update queries.
Just like for delete queries, joins are currently not supported for update queries.
Parameters
-
Cake\Database\Query
$query The query to translate
Returns
Cake\Database\Query
newCompiler() ¶ public
newCompiler(): Cake\Database\SqliteCompiler
{@inheritDoc}
Returns
Cake\Database\SqliteCompiler
queryTranslator() ¶ public
queryTranslator(string $type): callable
Returns a callable function that will be used to transform a passed Query object. This function, in turn, will return an instance of a Query object that has been transformed to accommodate any specificities of the SQL dialect in use.
Parameters
-
string
$type the type of query to be transformed (select, insert, update, delete)
Returns
callable
quoteIdentifier() ¶ public
quoteIdentifier(string $identifier): string
Quotes a database identifier (a column name, table name, etc..) to be used safely in queries without the risk of using reserved words
Parameters
-
string
$identifier The identifier to quote.
Returns
string
releaseSavePointSQL() ¶ public
releaseSavePointSQL(string $name): string
Returns a SQL snippet for releasing a previously created save point
Parameters
-
string
$name save point name
Returns
string
rollbackSavePointSQL() ¶ public
rollbackSavePointSQL(string $name): string
Returns a SQL snippet for rollbacking a previously created save point
Parameters
-
string
$name save point name
Returns
string
savePointSQL() ¶ public
savePointSQL(string $name): string
Returns a SQL snippet for creating a new transaction savepoint
Parameters
-
string
$name save point name
Returns
string
schemaDialect() ¶ public
schemaDialect(): Cake\Database\Schema\SqliteSchema
Get the schema dialect.
Used by Cake\Database\Schema package to reflect schema and generate schema.
Returns
Cake\Database\Schema\SqliteSchema