Phalcon db

NOTE

All classes are prefixed with Phalcon

Db\AbstractDb¶

Phalcon\Db and its related classes provide a simple SQL database interface for Phalcon Framework. The Phalcon\Db is the basic class you use to connect your PHP application to an RDBMS. There is a different adapter class for each brand of RDBMS.

This component is intended to lower level database operations. If you want to interact with databases using higher level of abstraction use Phalcon\Mvc\Model.

Phalcon\Db\AbstractDb is an abstract class. You only can use it with a database adapter like Phalcon\Db\Adapter\Pdo

use Phalcon\Db;
use Phalcon\Db\Exception;
use Phalcon\Db\Adapter\Pdo\Mysql as MysqlConnection;

try {
    $connection = new MysqlConnection(
        [
            "host"     => "192.168.0.11",
            "username" => "sigma",
            "password" => "secret",
            "dbname"   => "blog",
            "port"     => "3306",
        ]
    );

    $result = $connection->query(
        "SELECT * FROM co_invoices LIMIT 5"
    );

    $result->setFetchMode(Enum::FETCH_NUM);

    while ($invoice = $result->fetch()) {
        print_r($invoice);
    }
} catch (Exception $e) {
    echo $e->getMessage(), PHP_EOL;
}

Phalcon\Db\AbstractDb

Uses Phalcon\Support\Settings

Method Summary¶

public void setup( array $options ) Enables/disables options in the Database component

Methods¶

Public · 1

`setup()`¶

public static function setup( array $options ): void;

Enables/disables options in the Database component

Db\Adapter\AbstractAdapter¶

Abstract Source on GitHub

Base class for Phalcon\Db\Adapter adapters

Phalcon\Db\Adapter\AbstractAdapter - implements Phalcon\Db\Adapter\AdapterInterface, Phalcon\Events\EventsAwareInterface
- Phalcon\Db\Adapter\Pdo\AbstractPdo

Uses Phalcon\Db\CheckInterface · Phalcon\Db\ColumnInterface · Phalcon\Db\DialectInterface · Phalcon\Db\Enum · Phalcon\Db\Exception · Phalcon\Db\Exceptions\CannotInsertWithoutData · Phalcon\Db\Exceptions\IncompleteBindTypes · Phalcon\Db\Exceptions\InvalidDialectClass · Phalcon\Db\Exceptions\NestedTransactionChangeBlocked · Phalcon\Db\Exceptions\SavepointsNotSupported · Phalcon\Db\Exceptions\TableMustHaveColumn · Phalcon\Db\Exceptions\UpdateFieldCountMismatch · Phalcon\Db\Index · Phalcon\Db\IndexInterface · Phalcon\Db\RawValue · Phalcon\Db\Reference · Phalcon\Db\ReferenceInterface · Phalcon\Events\EventsAwareInterface · Phalcon\Events\Traits\EventsAwareTrait

Method Summary¶

Properties¶

protected int $connectionConsecutive = 0 Connection ID

protected int $connectionId Active connection ID

protected array $descriptor = [] Descriptor used to connect to a database

protected DialectInterface $dialect Dialect instance

protected string $dialectType Name of the dialect used

protected string $realSqlStatement = "" The real SQL statement - what was executed

protected array $sqlBindTypes = [] Active SQL Bind Types

protected string $sqlStatement Active SQL Statement

protected array $sqlVariables = [] Active SQL bound parameter variables

protected int $transactionLevel = 0 Current transaction level

protected bool $transactionsWithSavepoints = false Whether the database supports transactions with save points

protected string $type Type of database system the adapter is used for

Methods¶

Public · 64

`__construct()`¶

public function __construct( array $descriptor );

Phalcon\Db\Adapter constructor

Note: the options key is forwarded to the static setup() method, which writes process-global settings affecting every connection in the process. See setup().

`addCheck()`¶

public function addCheck(
    string $tableName,
    string $schemaName,
    CheckInterface $check
): bool;

Adds a CHECK constraint to a table.

`addColumn()`¶

public function addColumn(
    string $tableName,
    string $schemaName,
    ColumnInterface $column
): bool;

Adds a column to a table

`addForeignKey()`¶

public function addForeignKey(
    string $tableName,
    string $schemaName,
    ReferenceInterface $reference
): bool;

Adds a foreign key to a table

`addIndex()`¶

public function addIndex(
    string $tableName,
    string $schemaName,
    IndexInterface $index
): bool;

Adds an index to a table

`addPrimaryKey()`¶

public function addPrimaryKey(
    string $tableName,
    string $schemaName,
    IndexInterface $index
): bool;

Adds a primary key to a table

`createMaterializedView()`¶

public function createMaterializedView(
    string $viewName,
    array $definition,
    string|null $schemaName = null
): bool;

Creates a materialized view (PostgreSQL only).

`createSavepoint()`¶

public function createSavepoint( string $name ): bool;

Creates a new savepoint

`createTable()`¶

public function createTable(
    string $tableName,
    string $schemaName,
    array $definition
): bool;

Creates a table

`createView()`¶

public function createView(
    string $viewName,
    array $definition,
    string|null $schemaName = null
): bool;

Creates a view

`delete()`¶

public function delete(
    array|string $tableName,
    string|null $whereCondition = null,
    array $placeholders = [],
    array $dataTypes = []
): bool;

Deletes data from a table using custom RBDM SQL syntax

// Deleting existing invoice
$success = $connection->delete(
    "co_invoices",
    "inv_id = 101"
);

// Next SQL sentence is generated
DELETE FROM `co_invoices` WHERE `inv_id` = 101

Warning! If $whereCondition is string it not escaped.

`describeIndexes()`¶

public function describeIndexes(
    string $tableName,
    string|null $schemaName = null
): array;

Lists table indexes

print_r(
    $connection->describeIndexes("co_orders_x_products")
);

This base implementation consumes the dialect's describeIndexes() SQL as FETCH_NUM rows by position: column index 2 is the index key name and column index 4 is the indexed column name. A custom dialect's describeIndexes() SQL must emit columns in that order, or a custom adapter must override this method. All bundled adapters except PostgreSQL override it.

`describeReferences()`¶

public function describeReferences(
    string $tableName,
    string|null $schemaName = null
): array;

Lists table references

print_r(
    $connection->describeReferences("co_orders_x_products")
);

This base implementation consumes the dialect's describeReferences() SQL as FETCH_NUM rows by position: index 1 is the local column, index 2 the constraint name, index 3 the referenced schema, index 4 the referenced table, and index 5 the referenced column. A custom dialect's describeReferences() SQL must emit columns in that order, or a custom adapter must override this method. Every bundled adapter (MySQL, PostgreSQL, SQLite) overrides it, so this base implementation has no in-tree caller and effectively assumes the PostgreSQL row shape.

`dropCheck()`¶

public function dropCheck(
    string $tableName,
    string $schemaName,
    string $checkName
): bool;

Drops a CHECK constraint from a table.

`dropColumn()`¶

public function dropColumn(
    string $tableName,
    string $schemaName,
    string $columnName
): bool;

Drops a column from a table

`dropForeignKey()`¶

public function dropForeignKey(
    string $tableName,
    string $schemaName,
    string $referenceName
): bool;

Drops a foreign key from a table

`dropIndex()`¶

public function dropIndex(
    string $tableName,
    string $schemaName,
    string $indexName
): bool;

Drop an index from a table

`dropMaterializedView()`¶

public function dropMaterializedView(
    string $viewName,
    string|null $schemaName = null,
    bool $ifExists = true
): bool;

Drops a materialized view (PostgreSQL only).

`dropPrimaryKey()`¶

public function dropPrimaryKey(
    string $tableName,
    string $schemaName
): bool;

Drops a table's primary key

`dropTable()`¶

public function dropTable(
    string $tableName,
    string|null $schemaName = null,
    bool $ifExists = true
): bool;

Drops a table from a schema/database

`dropView()`¶

public function dropView(
    string $viewName,
    string|null $schemaName = null,
    bool $ifExists = true
): bool;

Drops a view

`escapeIdentifier()`¶

public function escapeIdentifier( array|float|int|string $identifier ): string;

Escapes a column/table/schema name

$escapedTable = $connection->escapeIdentifier(
    "co_invoices"
);

$escapedTable = $connection->escapeIdentifier(
    [
        "store",
        "co_invoices",
    ]
);

`fetchAll()`¶

public function fetchAll(
    string $sqlQuery,
    int $fetchMode = Enum::FETCH_ASSOC,
    array $bindParams = [],
    array $bindTypes = []
): array;

Dumps the complete result of a query into an array

// Getting all invoices with associative indexes only
$invoices = $connection->fetchAll(
    "SELECT * FROM co_invoices",
    \Phalcon\Db\Enum::FETCH_ASSOC
);

foreach ($invoices as $invoice) {
    print_r($invoice);
}

 // Getting all invoices whose title contains the word "Test"
$invoices = $connection->fetchAll(
    "SELECT * FROM co_invoices WHERE inv_title LIKE :inv_title",
    \Phalcon\Db\Enum::FETCH_ASSOC,
    [
        "inv_title" => "%Test%",
    ]
);
foreach($invoices as $invoice) {
    print_r($invoice);
}

`fetchColumn()`¶

public function fetchColumn(
    string $sqlQuery,
    array $placeholders = [],
    int|string $column = 0
): mixed;

Returns the n'th field of first row in a SQL query result

// Getting count of invoices
$invoicesCount = $connection->fetchColumn("SELECT count(*) FROM co_invoices");
print_r($invoicesCount);

// Getting the title of the last created invoice
$invoice = $connection->fetchColumn(
    "SELECT inv_id, inv_title FROM co_invoices ORDER BY inv_created_at DESC",
    1
);
print_r($invoice);

`fetchOne()`¶

public function fetchOne(
    string $sqlQuery,
    int $fetchMode = Enum::FETCH_ASSOC,
    array $bindParams = [],
    array $bindTypes = []
): array|bool;

Returns the first row in a SQL query result

// Getting first invoice
$invoice = $connection->fetchOne("SELECT * FROM co_invoices");
print_r($invoice);

// Getting first invoice with associative indexes only
$invoice = $connection->fetchOne(
    "SELECT * FROM co_invoices",
    \Phalcon\Db\Enum::FETCH_ASSOC
);
print_r($invoice);

`forUpdate()`¶

public function forUpdate(
    string $sqlQuery,
    string $modifier = ""
): string;

Returns a SQL modified with a FOR UPDATE clause

`getColumnDefinition()`¶

public function getColumnDefinition( ColumnInterface $column ): string;

Returns the SQL column definition from a column

`getColumnList()`¶

public function getColumnList( array $columnList ): string;

Gets a list of columns

`getConnectionId()`¶

public function getConnectionId(): int;

Gets the active connection unique identifier

`getDefaultIdValue()`¶

public function getDefaultIdValue(): RawValue;

Returns the default identity value to be inserted in an identity column

// Inserting a new invoice with a valid default value for the column 'inv_id'
$success = $connection->insert(
    "co_invoices",
    [
        $connection->getDefaultIdValue(),
        "Test Invoice",
        100,
    ],
    [
        "inv_id",
        "inv_title",
        "inv_total",
    ]
);

`getDefaultValue()`¶

public function getDefaultValue(): RawValue;

Returns the default value to make the RBDM use the default value declared in the table definition

// Inserting a new invoice with a valid default value for the column 'inv_total'
$success = $connection->insert(
    "co_invoices",
    [
        "Test Invoice",
        $connection->getDefaultValue()
    ],
    [
        "inv_title",
        "inv_total",
    ]
);

`getDescriptor()`¶

public function getDescriptor(): array;

Return descriptor used to connect to the active database

`getDialect()`¶

public function getDialect(): DialectInterface;

Returns internal dialect instance

`getDialectType()`¶

public function getDialectType(): string;

Name of the dialect used

`getNestedTransactionSavepointName()`¶

public function getNestedTransactionSavepointName(): string;

Returns the savepoint name to use for nested transactions

`getRealSQLStatement()`¶

public function getRealSQLStatement(): string;

Active SQL statement in the object without replace bound parameters

`getSQLBindTypes()`¶

public function getSQLBindTypes(): array;

Active SQL statement in the object

`getSQLStatement()`¶

public function getSQLStatement(): string;

Active SQL statement in the object

`getSQLVariables()`¶

public function getSQLVariables(): array;

Active SQL variables in the object

`getType()`¶

public function getType(): string;

Type of database system the adapter is used for

`insert()`¶

public function insert(
    string $tableName,
    array $values,
    array|null $fields = null,
    array $dataTypes = []
): bool;

Inserts data into a table using custom RDBMS SQL syntax

// Inserting a new invoice
$success = $connection->insert(
    "co_invoices",
    ["Test Invoice", 100],
    ["inv_title", "inv_total"]
);

// Next SQL sentence is sent to the database system
INSERT INTO `co_invoices` (`inv_title`, `inv_total`) VALUES ("Test Invoice", 100);

`insertAsDict()`¶

public function insertAsDict(
    string $tableName,
    array $data,
    array $dataTypes = []
): bool;

Inserts data into a table using custom RBDM SQL syntax

// Inserting a new invoice
$success = $connection->insertAsDict(
    "co_invoices",
    [
        "inv_title" => "Test Invoice",
        "inv_total" => 100,
    ]
);

// Next SQL sentence is sent to the database system
INSERT INTO `co_invoices` (`inv_title`, `inv_total`) VALUES ("Test Invoice", 100);

`isNestedTransactionsWithSavepoints()`¶

public function isNestedTransactionsWithSavepoints(): bool;

Returns if nested transactions should use savepoints

`limit()`¶

public function limit(
    string $sqlQuery,
    array|int $number
): string;

Appends a LIMIT clause to $sqlQuery argument

echo $connection->limit("SELECT * FROM co_invoices", 5);

`listTables()`¶

public function listTables( string|null $schemaName = null ): array;

List all tables on a database

print_r(
    $connection->listTables("blog")
);

`listViews()`¶

public function listViews( string|null $schemaName = null ): array;

List all views on a database

print_r(
    $connection->listViews("blog")
);

`modifyColumn()`¶

public function modifyColumn(
    string $tableName,
    string $schemaName,
    ColumnInterface $column,
    ColumnInterface|null $currentColumn = null
): bool;

Modifies a table column based on a definition

`onConflictUpdate()`¶

public function onConflictUpdate(
    string $sqlQuery,
    array $conflictColumns,
    array $updateColumns
): string;

Appends an ON CONFLICT (...) DO UPDATE SET col = excluded.col upsert clause to the supplied INSERT statement.

`refreshMaterializedView()`¶

public function refreshMaterializedView(
    string $viewName,
    string|null $schemaName = null,
    bool $concurrent = false
): bool;

Refreshes a materialized view (PostgreSQL only).

`releaseSavepoint()`¶

public function releaseSavepoint( string $name ): bool;

Releases given savepoint

`returning()`¶

public function returning(
    string $sqlQuery,
    array $columns
): string;

Appends a RETURNING clause to an INSERT/UPDATE/DELETE statement.

`rollbackSavepoint()`¶

public function rollbackSavepoint( string $name ): bool;

Rollbacks given savepoint

`setDialect()`¶

public function setDialect( DialectInterface $dialect ): void;

Sets the dialect used to produce the SQL

`setNestedTransactionsWithSavepoints()`¶

public function setNestedTransactionsWithSavepoints( bool $flag ): AdapterInterface;

Set if nested transactions should use savepoints

`setup()`¶

public static function setup( array $options ): void;

Enables/disables options in the Database component.

The flags are stored as process-global Phalcon\Support\Settings (db.escape_identifiers, db.force_casting) and therefore affect every connection in the process at once, last-writer-wins. Call this once at bootstrap; it is not per-connection configuration. Because the constructor calls setup() whenever a descriptor carries an options key, constructing one adapter with options can change the SQL another, already-configured connection generates.

`sharedLock()`¶

public function sharedLock(
    string $sqlQuery,
    string $modifier = ""
): string;

Returns a SQL modified with a LOCK IN SHARE MODE clause

`supportSequences()`¶

public function supportSequences(): bool;

Check whether the database system requires a sequence to produce auto-numeric values

`supportsDefaultValue()`¶

public function supportsDefaultValue(): bool;

Check whether the database system support the DEFAULT keyword (SQLite does not support it)

`tableExists()`¶

public function tableExists(
    string $tableName,
    string|null $schemaName = null
): bool;

Generates SQL checking for the existence of a schema.table

var_dump(
    $connection->tableExists("blog", "posts")
);

`tableOptions()`¶

public function tableOptions(
    string $tableName,
    string|null $schemaName = null
): array;

Gets creation options from a table

print_r(
    $connection->tableOptions("co_invoices")
);

`update()`¶

public function update(
    string $tableName,
    array $fields,
    array $values,
    array|string $whereCondition = [],
    array $dataTypes = []
): bool;

Updates data on a table using custom RBDM SQL syntax

// Updating existing invoice
$success = $connection->update(
    "co_invoices",
    ["inv_title"],
    ["New Test Invoice"],
    "inv_id = 101"
);

// Next SQL sentence is sent to the database system
UPDATE `co_invoices` SET `inv_title` = "New Test Invoice" WHERE inv_id = 101

// Updating existing invoice with array condition and $dataTypes
$success = $connection->update(
    "co_invoices",
    ["inv_title"],
    ["New Test Invoice"],
    [
        "conditions" => "inv_id = ?",
        "bind"       => [$some_unsafe_id],
        "bindTypes"  => [PDO::PARAM_INT], // use only if you use
        $dataTypes param
    ],
    [
        PDO::PARAM_STR
    ]
);

Warning! If $whereCondition is string, it is not escaped.

`updateAsDict()`¶

public function updateAsDict(
    string $tableName,
    array $data,
    array|string $whereCondition = [],
    array $dataTypes = []
): bool;

Updates data on a table using custom RBDM SQL syntax Another, more convenient syntax

// Updating existing invoice
$success = $connection->updateAsDict(
    "co_invoices",
    [
        "inv_title" => "New Test Invoice",
    ],
    "inv_id = 101"
);

// Next SQL sentence is sent to the database system
UPDATE `co_invoices` SET `inv_title` = "New Test Invoice" WHERE inv_id = 101

`useExplicitIdValue()`¶

public function useExplicitIdValue(): bool;

Check whether the database system requires an explicit value for identity columns

`viewExists()`¶

public function viewExists(
    string $viewName,
    string|null $schemaName = null
): bool;

Generates SQL checking for the existence of a schema.view

var_dump(
    $connection->viewExists("active_users", "posts")
);

Protected · 1

`checkSavepoints()`¶

protected function checkSavepoints(): void;

Check if savepoints are supported

Db\Adapter\AdapterInterface¶

Interface Source on GitHub

Phalcon\Db\Adapter\AdapterInterface

Phalcon\Contracts\Db\Adapter\Adapter
- Phalcon\Db\Adapter\AdapterInterface

Uses Phalcon\Contracts\Db\Adapter\Adapter

Db\Adapter\PdoFactory¶

Class Source on GitHub

Phalcon\Db\Adapter\PdoFactory

Uses Exception · Phalcon\Config\ConfigInterface · Phalcon\Db\Adapter\Pdo\Mysql · Phalcon\Db\Adapter\Pdo\Postgresql · Phalcon\Db\Adapter\Pdo\Sqlite · Phalcon\Support\Exception · Phalcon\Support\Traits\ConfigTrait · Phalcon\Traits\Factory\FactoryTrait

Method Summary¶

public __construct( array $services = [] ) Constructor. public AdapterInterface load( array|ConfigInterface $config ) Factory to create an instance from a Config object public AdapterInterface newInstance(string $name,array $options = []) Create a new instance of the adapter protected string getExceptionClass() protected array getServices() Returns the available adapters

Methods¶

Public · 3

`__construct()`¶

public function __construct( array $services = [] );

Constructor.

`load()`¶

public function load( array|ConfigInterface $config ): AdapterInterface;

Factory to create an instance from a Config object

`newInstance()`¶

public function newInstance(
    string $name,
    array $options = []
): AdapterInterface;

Create a new instance of the adapter

Protected · 2

`getExceptionClass()`¶

protected function getExceptionClass(): string;

`getServices()`¶

protected function getServices(): array;

Returns the available adapters

Db\Adapter\Pdo\AbstractPdo¶

Abstract Source on GitHub

Phalcon\Db\Adapter\Pdo is the Phalcon\Db that internally uses PDO to connect to a database

use Phalcon\Db\Adapter\Pdo\Mysql;

$config = [
    "host"     => "localhost",
    "dbname"   => "blog",
    "port"     => 3306,
    "username" => "sigma",
    "password" => "secret",
];

$connection = new Mysql($config);

Phalcon\Db\Adapter\AbstractAdapter
- Phalcon\Db\Adapter\Pdo\AbstractPdo

Uses PDO · PDOException · PDOStatement · Phalcon\Db\Adapter\AbstractAdapter · Phalcon\Db\Column · Phalcon\Db\Exception · Phalcon\Db\Exceptions\CannotPrepareStatement · Phalcon\Db\Exceptions\InvalidBindParameter · Phalcon\Db\Exceptions\MatchedParameterNotFound · Phalcon\Db\Exceptions\NoActiveTransaction · Phalcon\Db\ResultInterface · Phalcon\Db\Result\PdoResult · Phalcon\Events\Exception · Phalcon\Support\Settings · Throwable

Method Summary¶

public __construct( array $descriptor ) Constructor for Phalcon\Db\Adapter\Pdo public int affectedRows() Returns the number of affected rows by the latest INSERT/UPDATE/DELETE public bool begin( bool $nesting = true ) Starts a transaction in the connection public void close() Closes the active connection returning success. Phalcon automatically public bool commit( bool $nesting = true ) Commits the active transaction in the connection public void connect( array $descriptor = [] ) This method is automatically called in \Phalcon\Db\Adapter\Pdo public array convertBoundParams(string $sql,array $parameters = []) Converts bound parameters such as :name: or ?1 into PDO bind params ? public void ensureConnection() Ensures the connection is alive, reconnecting in place if it is not. public string escapeString( string $input ) Escapes a value to avoid SQL injections according to the active charset public bool execute(string $sqlStatement,array $bindParams = [],array $bindTypes = []) Sends SQL statements to the database server returning the success state. public PDOStatement executePrepared(PDOStatement $statement,array $placeholders,array $dataTypes = []) Executes a prepared statement binding. This function uses integer indexes public bool getAutoReconnect() Returns whether transparent auto-reconnect is enabled. public array getErrorInfo() Return the error info, if any public PDO|null getInternalHandler() Return internal PDO handler public int getTransactionLevel() Returns the current transaction nesting level public bool isUnderTransaction() Checks whether the connection is under a transaction public bool|string lastInsertId( string|null $name = null ) Returns the insert id for the auto_increment/serial column inserted in public bool ping() Checks whether the underlying connection is still alive by issuing a public PDOStatement prepare( string $sqlStatement ) Returns a PDO prepared statement to be executed with 'executePrepared' public bool|ResultInterface query(string $sqlStatement,array $bindParams = [],array $bindTypes = []) Sends SQL statements to the database server returning the success state. public bool rollback( bool $nesting = true ) Rollbacks the active transaction in the connection public static setAutoReconnect( bool $autoReconnect ) Enables or disables transparent auto-reconnect on a lost connection. protected array getDsnDefaults() Returns PDO adapter DSN defaults as a key-value map. protected bool isConnectionError( Throwable $exception ) Recognizes whether an exception represents a lost ("gone away") protected void prepareRealSql(string $statement,array $parameters) Constructs the SQL statement (with parameters)

Properties¶

protected int $affectedRows = 0 Last affected rows

protected bool $autoReconnect = false Whether to transparently reconnect and retry once when a query fails because the connection was lost. Opt-in; off by default.

protected PDO|null $pdo = null PDO Handler

Methods¶

Public · 22

`__construct()`¶

public function __construct( array $descriptor );

Constructor for Phalcon\Db\Adapter\Pdo

`affectedRows()`¶

public function affectedRows(): int;

Returns the number of affected rows by the latest INSERT/UPDATE/DELETE executed in the database system

$connection->execute(
    "DELETE FROM co_invoices"
);

echo $connection->affectedRows(), " were deleted";

`begin()`¶

public function begin( bool $nesting = true ): bool;

Starts a transaction in the connection

`close()`¶

public function close(): void;

Closes the active connection returning success. Phalcon automatically closes and destroys active connections when the request ends

`commit()`¶

public function commit( bool $nesting = true ): bool;

Commits the active transaction in the connection

`connect()`¶

public function connect( array $descriptor = [] ): void;

This method is automatically called in \Phalcon\Db\Adapter\Pdo constructor.

Call it when you need to restore a database connection.

use Phalcon\Db\Adapter\Pdo\Mysql;

// Make a connection
$connection = new Mysql(
    [
        "host"     => "localhost",
        "username" => "sigma",
        "password" => "secret",
        "dbname"   => "blog",
        "port"     => 3306,
    ]
);

// Reconnect
$connection->connect();

`convertBoundParams()`¶

public function convertBoundParams(
    string $sql,
    array $parameters = []
): array;

Converts bound parameters such as :name: or ?1 into PDO bind params ?

print_r(
    $connection->convertBoundParams(
        "SELECT * FROM co_invoices WHERE inv_title = :inv_title:",
        [
            "Test Invoice",
        ]
    )
);

`ensureConnection()`¶

public function ensureConnection(): void;

Ensures the connection is alive, reconnecting in place if it is not.

`escapeString()`¶

public function escapeString( string $input ): string;

Escapes a value to avoid SQL injections according to the active charset in the connection

$escapedStr = $connection->escapeString("some dangerous value");

`execute()`¶

public function execute(
    string $sqlStatement,
    array $bindParams = [],
    array $bindTypes = []
): bool;

Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server does not return any rows

// Inserting data
$success = $connection->execute(
    "INSERT INTO co_invoices VALUES (1, 'Test Invoice')"
);

$success = $connection->execute(
    "INSERT INTO co_invoices VALUES (?, ?)",
    [
        1,
        "Test Invoice",
    ]
);

`executePrepared()`¶

public function executePrepared(
    PDOStatement $statement,
    array $placeholders,
    array $dataTypes = []
): PDOStatement;

Executes a prepared statement binding. This function uses integer indexes starting from zero

use Phalcon\Db\Column;

$statement = $db->prepare(
    "SELECT * FROM co_invoices WHERE inv_title = :inv_title"
);

$result = $connection->executePrepared(
    $statement,
    [
        "inv_title" => "Test Invoice",
    ],
    [
        "inv_title" => Column::BIND_PARAM_STR,
    ]
);

`getAutoReconnect()`¶

public function getAutoReconnect(): bool;

Returns whether transparent auto-reconnect is enabled.

`getErrorInfo()`¶

public function getErrorInfo(): array;

Return the error info, if any

`getInternalHandler()`¶

public function getInternalHandler(): PDO|null;

Return internal PDO handler

`getTransactionLevel()`¶

public function getTransactionLevel(): int;

Returns the current transaction nesting level

`isUnderTransaction()`¶

public function isUnderTransaction(): bool;

Checks whether the connection is under a transaction

$connection->begin();

// true
var_dump(
    $connection->isUnderTransaction()
);

`lastInsertId()`¶

public function lastInsertId( string|null $name = null ): bool|string;

Returns the insert id for the auto_increment/serial column inserted in the latest executed SQL statement

// Inserting a new invoice
$success = $connection->insert(
    "co_invoices",
    [
        "Test Invoice",
        100,
    ],
    [
        "inv_title",
        "inv_total",
    ]
);

// Getting the generated id
$id = $connection->lastInsertId();

`ping()`¶

public function ping(): bool;

Checks whether the underlying connection is still alive by issuing a trivial query. Returns false if there is no handle or the probe fails.

`prepare()`¶

public function prepare( string $sqlStatement ): PDOStatement;

Returns a PDO prepared statement to be executed with 'executePrepared'

use Phalcon\Db\Column;

$statement = $db->prepare(
    "SELECT * FROM co_invoices WHERE inv_title = :inv_title"
);

$result = $connection->executePrepared(
    $statement,
    [
        "inv_title" => "Test Invoice",
    ],
    [
        "inv_title" => Column::BIND_PARAM_INT,
    ]
);

`query()`¶

public function query(
    string $sqlStatement,
    array $bindParams = [],
    array $bindTypes = []
): bool|ResultInterface;

Sends SQL statements to the database server returning the success state. Use this method only when the SQL statement sent to the server is returning rows

// Querying data
$resultset = $connection->query(
    "SELECT * FROM co_invoices WHERE inv_status_flag = 1"
);

$resultset = $connection->query(
    "SELECT * FROM co_invoices WHERE inv_status_flag = ?",
    [
        1,
    ]
);

`rollback()`¶

public function rollback( bool $nesting = true ): bool;

Rollbacks the active transaction in the connection

`setAutoReconnect()`¶

public function setAutoReconnect( bool $autoReconnect ): static;

Enables or disables transparent auto-reconnect on a lost connection.

Protected · 3

`getDsnDefaults()`¶

abstract protected function getDsnDefaults(): array;

Returns PDO adapter DSN defaults as a key-value map.

`isConnectionError()`¶

protected function isConnectionError( Throwable $exception ): bool;

Recognizes whether an exception represents a lost ("gone away") connection. The base adapter cannot know driver specifics, so it returns false; concrete adapters override this.

`prepareRealSql()`¶

protected function prepareRealSql(
    string $statement,
    array $parameters
): void;

Constructs the SQL statement (with parameters)

@see https://stackoverflow.com/a/8403150

Db\Adapter\Pdo\Mysql¶

Class Source on GitHub

Specific functions for the MySQL database system

use Phalcon\Db\Adapter\Pdo\Mysql;

$config = [
    "host"     => "localhost",
    "dbname"   => "blog",
    "port"     => 3306,
    "username" => "sigma",
    "password" => "secret",
];

$connection = new Mysql($config);

Phalcon\Db\Adapter\AbstractAdapter
- Phalcon\Db\Adapter\Pdo\AbstractPdo
  - Phalcon\Db\Adapter\Pdo\Mysql

Uses PDO · PDOException · Phalcon\Db\Adapter\Pdo\AbstractPdo · Phalcon\Db\Column · Phalcon\Db\ColumnInterface · Phalcon\Db\Enum · Phalcon\Db\Exception · Phalcon\Db\Exceptions\MissingForeignKeyChecks · Phalcon\Db\Index · Phalcon\Db\IndexInterface · Phalcon\Db\Reference · Phalcon\Db\ReferenceInterface · Throwable

Method Summary¶

public bool addForeignKey(string $tableName,string $schemaName,ReferenceInterface $reference) Adds a foreign key to a table public void connect( array $descriptor = [] ) public array describeColumns(string $tableName,string|null $schemaName = null) Returns an array of Phalcon\Db\Column objects describing a table public array describeIndexes(string $tableName,string|null $schemaName = null) Lists table indexes public array describeReferences(string $tableName,string|null $schemaName = null) Lists table references protected array getDsnDefaults() Returns PDO adapter DSN defaults as a key-value map. protected bool isConnectionError( Throwable $exception ) Recognizes a MySQL "server has gone away" / "Lost connection" failure

Properties¶

protected string $dialectType = "mysql"

protected string $type = "mysql"

Methods¶

Public · 5

`addForeignKey()`¶

public function addForeignKey(
    string $tableName,
    string $schemaName,
    ReferenceInterface $reference
): bool;

Adds a foreign key to a table

`connect()`¶

public function connect( array $descriptor = [] ): void;

`describeColumns()`¶

public function describeColumns(
    string $tableName,
    string|null $schemaName = null
): array;

Returns an array of Phalcon\Db\Column objects describing a table

print_r(
    $connection->describeColumns("posts")
);

`describeIndexes()`¶

public function describeIndexes(
    string $tableName,
    string|null $schemaName = null
): array;

Lists table indexes

print_r(
    $connection->describeIndexes("co_orders_x_products")
);

`describeReferences()`¶

public function describeReferences(
    string $tableName,
    string|null $schemaName = null
): array;

Lists table references

print_r(
    $connection->describeReferences("co_orders_x_products")
);

Protected · 2

`getDsnDefaults()`¶

protected function getDsnDefaults(): array;

Returns PDO adapter DSN defaults as a key-value map.

`isConnectionError()`¶

protected function isConnectionError( Throwable $exception ): bool;

Recognizes a MySQL "server has gone away" / "Lost connection" failure by the driver error code (2006 / 2013) with a message fallback.

Db\Adapter\Pdo\Postgresql¶

Class Source on GitHub

Specific functions for the PostgreSQL database system

use Phalcon\Db\Adapter\Pdo\Postgresql;

$config = [
    "host"     => "localhost",
    "dbname"   => "blog",
    "port"     => 5432,
    "username" => "postgres",
    "password" => "secret",
];

$connection = new Postgresql($config);

Phalcon\Db\Adapter\AbstractAdapter
- Phalcon\Db\Adapter\Pdo\AbstractPdo
  - Phalcon\Db\Adapter\Pdo\Postgresql

Uses Phalcon\Db\Adapter\Pdo\AbstractPdo · Phalcon\Db\Column · Phalcon\Db\ColumnInterface · Phalcon\Db\Enum · Phalcon\Db\Exception · Phalcon\Db\Exceptions\TableMustHaveColumn · Phalcon\Db\RawValue · Phalcon\Db\Reference · Phalcon\Db\ReferenceInterface · Throwable

Method Summary¶

public __construct( array $descriptor ) Constructor for Phalcon\Db\Adapter\Pdo\Postgresql public void connect( array $descriptor = [] ) This method is automatically called in Phalcon\Db\Adapter\Pdo public bool createTable(string $tableName,string $schemaName,array $definition) Creates a table public array describeColumns(string $tableName,string|null $schemaName = null) Returns an array of Phalcon\Db\Column objects describing a table public array describeReferences(string $tableName,string|null $schemaName = null) Lists table references public RawValue getDefaultIdValue() Returns the default identity value to be inserted in an identity column public bool modifyColumn(string $tableName,string $schemaName,ColumnInterface $column,ColumnInterface|null $currentColumn = null) Modifies a table column based on a $definition public bool supportSequences() Check whether the database system requires a sequence to produce public bool useExplicitIdValue() Check whether the database system requires an explicit value for identity protected array getDsnDefaults() Returns PDO adapter DSN defaults as a key-value map. protected bool isConnectionError( Throwable $exception ) Recognizes a PostgreSQL connection-loss failure by SQLSTATE

Properties¶

protected string $dialectType = "postgresql"

protected string $type = "pgsql"

Methods¶

Public · 9

`__construct()`¶

public function __construct( array $descriptor );

Constructor for Phalcon\Db\Adapter\Pdo\Postgresql

`connect()`¶

public function connect( array $descriptor = [] ): void;

This method is automatically called in Phalcon\Db\Adapter\Pdo constructor. Call it when you need to restore a database connection.

`createTable()`¶

public function createTable(
    string $tableName,
    string $schemaName,
    array $definition
): bool;

Creates a table

`describeColumns()`¶

public function describeColumns(
    string $tableName,
    string|null $schemaName = null
): array;

Returns an array of Phalcon\Db\Column objects describing a table

print_r(
    $connection->describeColumns("posts")
);

`describeReferences()`¶

public function describeReferences(
    string $tableName,
    string|null $schemaName = null
): array;

Lists table references

print_r(
    $connection->describeReferences("co_orders_x_products")
);

`getDefaultIdValue()`¶

public function getDefaultIdValue(): RawValue;

Returns the default identity value to be inserted in an identity column

// Inserting a new invoice with a valid default value for the column 'inv_id'
$success = $connection->insert(
    "co_invoices",
    [
        $connection->getDefaultIdValue(),
        "Test Invoice",
        100,
    ],
    [
        "inv_id",
        "inv_title",
        "inv_total",
    ]
);

`modifyColumn()`¶

public function modifyColumn(
    string $tableName,
    string $schemaName,
    ColumnInterface $column,
    ColumnInterface|null $currentColumn = null
): bool;

Modifies a table column based on a $definition

`supportSequences()`¶

public function supportSequences(): bool;

Check whether the database system requires a sequence to produce auto-numeric values

`useExplicitIdValue()`¶

public function useExplicitIdValue(): bool;

Check whether the database system requires an explicit value for identity columns

Protected · 2

`getDsnDefaults()`¶

protected function getDsnDefaults(): array;

Returns PDO adapter DSN defaults as a key-value map.

`isConnectionError()`¶

protected function isConnectionError( Throwable $exception ): bool;

Recognizes a PostgreSQL connection-loss failure by SQLSTATE (connection exception class 08, or admin/crash shutdown 57P0x) with a message fallback.

Db\Adapter\Pdo\Sqlite¶

Class Source on GitHub

Specific functions for the SQLite database system

use Phalcon\Db\Adapter\Pdo\Sqlite;

$connection = new Sqlite(
    [
        "dbname" => "/tmp/test.sqlite",
    ]
);

Phalcon\Db\Adapter\AbstractAdapter
- Phalcon\Db\Adapter\Pdo\AbstractPdo
  - Phalcon\Db\Adapter\Pdo\Sqlite

Uses Phalcon\Db\Adapter\Pdo\AbstractPdo · Phalcon\Db\Column · Phalcon\Db\ColumnInterface · Phalcon\Db\Enum · Phalcon\Db\Exception · Phalcon\Db\Exceptions\MissingSqliteDatabase · Phalcon\Db\Index · Phalcon\Db\IndexInterface · Phalcon\Db\RawValue · Phalcon\Db\Reference · Phalcon\Db\ReferenceInterface

Method Summary¶

public __construct( array $descriptor ) Constructor for Phalcon\Db\Adapter\Pdo\Sqlite public void connect( array $descriptor = [] ) This method is automatically called in Phalcon\Db\Adapter\Pdo public array describeColumns(string $tableName,string|null $schemaName = null) Returns an array of Phalcon\Db\Column objects describing a table public array describeIndexes(string $tableName,string|null $schemaName = null) Lists table indexes public array describeReferences(string $tableName,string|null $schemaName = null) Lists table references public RawValue getDefaultValue() Returns the default value to make the RBDM use the default value declared public bool supportsDefaultValue() SQLite does not support the DEFAULT keyword public bool useExplicitIdValue() Check whether the database system requires an explicit value for identity protected array getDsnDefaults() Returns PDO adapter DSN defaults as a key-value map.

Properties¶

protected string $dialectType = "sqlite"

protected string $type = "sqlite"

Methods¶

Public · 8

`__construct()`¶

public function __construct( array $descriptor );

Constructor for Phalcon\Db\Adapter\Pdo\Sqlite

`connect()`¶

public function connect( array $descriptor = [] ): void;

This method is automatically called in Phalcon\Db\Adapter\Pdo constructor. Call it when you need to restore a database connection.

`describeColumns()`¶

public function describeColumns(
    string $tableName,
    string|null $schemaName = null
): array;

Returns an array of Phalcon\Db\Column objects describing a table

print_r(
    $connection->describeColumns("posts")
);

`describeIndexes()`¶

public function describeIndexes(
    string $tableName,
    string|null $schemaName = null
): array;

Lists table indexes

print_r(
    $connection->describeIndexes("co_orders_x_products")
);

`describeReferences()`¶

public function describeReferences(
    string $tableName,
    string|null $schemaName = null
): array;

Lists table references

`getDefaultValue()`¶

public function getDefaultValue(): RawValue;

Returns the default value to make the RBDM use the default value declared in the table definition

// Inserting a new invoice with a valid default value for the column 'inv_total'
$success = $connection->insert(
    "co_invoices",
    [
        "Test Invoice",
        $connection->getDefaultValue(),
    ],
    [
        "inv_title",
        "inv_total",
    ]
);

`supportsDefaultValue()`¶

public function supportsDefaultValue(): bool;

SQLite does not support the DEFAULT keyword

`useExplicitIdValue()`¶

public function useExplicitIdValue(): bool;

Check whether the database system requires an explicit value for identity columns

Protected · 1

`getDsnDefaults()`¶

protected function getDsnDefaults(): array;

Returns PDO adapter DSN defaults as a key-value map.

Db\Check¶

Class Source on GitHub

Allows to define CHECK constraints on tables. CHECK constraints enforce a boolean SQL predicate on each row of the table; rows that fail the predicate are rejected at INSERT/UPDATE time.

use Phalcon\Db\Check;

$positivePrice = new Check(
    "chk_price_positive",
    [
        "expression" => "price > 0",
    ]
);

// Used inside a createTable() definition
$connection->createTable(
    "products",
    null,
    [
        "columns" => [ ... ],
        "checks"  => [$positivePrice],
    ]
);

Phalcon\Db\Check - implements Phalcon\Db\CheckInterface

Uses Phalcon\Db\Exceptions\CheckExpressionRequired · Phalcon\Db\Exceptions\InvalidCheckExpression

Method Summary¶

public __construct(string $name,array $definition) Phalcon\Db\Check constructor. public string getExpression() Returns the CHECK expression public string getName() Returns the constraint name (may be an empty string for unnamed)

Properties¶

protected string $expression The boolean SQL predicate this constraint enforces.

protected string $name The CHECK constraint name. An empty string indicates an unnamed constraint - the dialect will emit the clause without a CONSTRAINT prefix in that case.

Methods¶

Public · 3

`__construct()`¶

public function __construct(
    string $name,
    array $definition
);

Phalcon\Db\Check constructor.

`getExpression()`¶

public function getExpression(): string;

Returns the CHECK expression

`getName()`¶

public function getName(): string;

Returns the constraint name (may be an empty string for unnamed)

Db\CheckInterface¶

Interface Source on GitHub

Phalcon\Db\CheckInterface

Phalcon\Contracts\Db\Check
- Phalcon\Db\CheckInterface

Uses Phalcon\Contracts\Db\Check

Db\Column¶

Class Source on GitHub

Allows to define columns to be used on create or alter table operations

use Phalcon\Db\Column as Column;

// Column definition
$column = new Column(
    "id",
    [
        "type"          => Column::TYPE_INTEGER,
        "size"          => 10,
        "unsigned"      => true,
        "notNull"       => true,
        "autoIncrement" => true,
        "first"         => true,
        "comment"       => "",
    ]
);

// Add column to existing table
$connection->addColumn("co_invoices", null, $column);

Phalcon\Db\Column - implements Phalcon\Db\ColumnInterface

Uses Phalcon\Db\Exceptions\ColumnTypeRejectsAutoIncrement · Phalcon\Db\Exceptions\ColumnTypeRejectsScale · Phalcon\Db\Exceptions\ColumnTypeRequired · Phalcon\Db\Exceptions\GeneratedAutoIncrementConflict · Phalcon\Db\Exceptions\GeneratedDefaultConflict · Phalcon\Db\Exceptions\InvalidGenerationExpression

Method Summary¶

public __construct(string $name,array $definition) Phalcon\Db\Column constructor public string|null getAfterPosition() Check whether field absolute to position in table public int getBindType() Returns the type of bind handling public string|null getComment() Column's comment public mixed getDefault() Default column value public string|null getGenerationExpression() Returns the generation expression for a generated/computed column. public string getName() Column's name public int getScale() Integer column number scale public int|string getSize() Integer column size public int|string getType() Column data type public int getTypeReference() Column data type reference public array|int|string getTypeValues() Column data type values public bool hasDefault() Check whether column has default value public bool isArray() Whether the column is an array of its base type. Recognized by the public bool isAutoIncrement() Auto-Increment public bool isFirst() Check whether column has the first position in the table public bool isGenerated() Whether the column is a generated/computed column. public bool isGenerationStored() Whether a generated column is STORED. false means VIRTUAL. public bool isInvisible() Whether the column is declared INVISIBLE (MySQL 8.0.23+). public bool isNotNull() Not null public bool isNumeric() Check whether column have a numeric type public bool isPrimary() Column is part of the primary key? public bool isUnsigned() Returns true if number column is unsigned

Constants¶

int BIND_PARAM_BLOB = 3 Bind Type Blob

int BIND_PARAM_BOOL = 5 Bind Type Bool

int BIND_PARAM_DECIMAL = 32 Bind Type Decimal

int BIND_PARAM_INT = 1 Bind Type Integer

int BIND_PARAM_NULL = 0 Bind Type Null

int BIND_PARAM_STR = 2 Bind Type String

int BIND_SKIP = 1024 Skip binding by type

int TYPE_BIGINTEGER = 14 Big integer abstract data type

int TYPE_BINARY = 27 Binary abstract data type

int TYPE_BIT = 19 Bit abstract data type

int TYPE_BLOB = 11 Blob abstract data type

int TYPE_BOOLEAN = 8 Bool abstract data type

int TYPE_BYTEA = 30 PostgreSQL BYTEA binary type

int TYPE_CHAR = 5 Char abstract data type

int TYPE_CIDR = 32 PostgreSQL CIDR network-address type

int TYPE_DATE = 1 Date abstract data type

int TYPE_DATERANGE = 39 PostgreSQL DATERANGE range-of-date type

int TYPE_DATETIME = 4 Datetime abstract data type

int TYPE_DECIMAL = 3 Decimal abstract data type

int TYPE_DOUBLE = 9 Double abstract data type

int TYPE_ENUM = 18 Enum abstract data type

int TYPE_FLOAT = 7 Float abstract data type

int TYPE_GEOMETRY = 40 Spatial GEOMETRY base type (MySQL 5.7+; PostgreSQL + PostGIS)

int TYPE_GEOMETRYCOLLECTION = 47 Spatial GEOMETRYCOLLECTION type

int TYPE_INET = 31 PostgreSQL INET IPv4/IPv6 address type

int TYPE_INT4RANGE = 34 PostgreSQL INT4RANGE range-of-integer type

int TYPE_INT8RANGE = 35 PostgreSQL INT8RANGE range-of-bigint type

int TYPE_INTEGER = 0 Int abstract data type

int TYPE_JSON = 15 Json abstract data type

int TYPE_JSONB = 16 Jsonb abstract data type

int TYPE_LINESTRING = 42 Spatial LINESTRING type

int TYPE_LONGBLOB = 13 Longblob abstract data type

int TYPE_LONGTEXT = 24 Longtext abstract data type

int TYPE_MACADDR = 33 PostgreSQL MACADDR MAC-address type

int TYPE_MEDIUMBLOB = 12 Mediumblob abstract data type

int TYPE_MEDIUMINTEGER = 21 Mediumintegerr abstract data type

int TYPE_MEDIUMTEXT = 23 Mediumtext abstract data type

int TYPE_MULTILINESTRING = 45 Spatial MULTILINESTRING type

int TYPE_MULTIPOINT = 44 Spatial MULTIPOINT type

int TYPE_MULTIPOLYGON = 46 Spatial MULTIPOLYGON type

int TYPE_NUMRANGE = 36 PostgreSQL NUMRANGE range-of-numeric type

int TYPE_POINT = 41 Spatial POINT type

int TYPE_POLYGON = 43 Spatial POLYGON type

int TYPE_SMALLINTEGER = 22 Smallint abstract data type

int TYPE_TEXT = 6 Text abstract data type

int TYPE_TIME = 20 Time abstract data type

int TYPE_TIMESTAMP = 17 Timestamp abstract data type

int TYPE_TINYBLOB = 10 Tinyblob abstract data type

int TYPE_TINYINTEGER = 26 Tinyint abstract data type

int TYPE_TINYTEXT = 25 Tinytext abstract data type

int TYPE_TSRANGE = 37 PostgreSQL TSRANGE range-of-timestamp (without time zone) type

int TYPE_TSTZRANGE = 38 PostgreSQL TSTZRANGE range-of-timestamp (with time zone) type

int TYPE_UUID = 29 UUID abstract data type

int TYPE_VARBINARY = 28 Varbinary abstract data type

int TYPE_VARCHAR = 2 Varchar abstract data type

Properties¶

protected string|null $after = null Column Position

protected int $bindType = 2 Bind Type

protected string|null $comment = null Column's comment

protected mixed|null $defaultValue = null Default column value

protected string|null $generated = null Generation expression for GENERATED ALWAYS AS (...). Null when the column is not generated.

protected bool $generationStored = false Whether a generated column is STORED (true) or VIRTUAL (false). PostgreSQL only supports STORED and emits it regardless of this flag.

protected bool $isArray = false Whether the column is an array of its base type (PostgreSQL).

protected bool $isAutoIncrement = false Column is autoIncrement?

protected bool $isFirst = false Position is first

protected bool $isInvisible = false Whether the column is declared INVISIBLE (MySQL 8.0.23+).

protected bool $isNotNull = true Column not nullable? Default SQL definition is NOT NULL.

protected bool $isNumeric = false The column have some numeric type?

protected bool $isPrimary = false Column is part of the primary key?

protected bool $isUnsigned = false Integer column unsigned?

protected string $name

protected int $scale = 0 Integer column number scale

protected int|string $size = 0 Integer column size

protected int|string $type Column data type

protected int $typeReference = -1 Column data type reference

protected array|int|string $typeValues = [] Column data type values

Methods¶

Public · 23

`__construct()`¶

public function __construct(
    string $name,
    array $definition
);

Phalcon\Db\Column constructor

`getAfterPosition()`¶

public function getAfterPosition(): string|null;

Check whether field absolute to position in table

`getBindType()`¶

public function getBindType(): int;

Returns the type of bind handling

`getComment()`¶

public function getComment(): string|null;

Column's comment

`getDefault()`¶

public function getDefault(): mixed;

Default column value

`getGenerationExpression()`¶

public function getGenerationExpression(): string|null;

Returns the generation expression for a generated/computed column. Returns null when the column is not generated.

`getName()`¶

public function getName(): string;

Column's name

`getScale()`¶

public function getScale(): int;

Integer column number scale

`getSize()`¶

public function getSize(): int|string;

Integer column size

`getType()`¶

public function getType(): int|string;

Column data type

`getTypeReference()`¶

public function getTypeReference(): int;

Column data type reference

`getTypeValues()`¶

public function getTypeValues(): array|int|string;

Column data type values

`hasDefault()`¶

public function hasDefault(): bool;

Check whether column has default value

`isArray()`¶

public function isArray(): bool;

Whether the column is an array of its base type. Recognized by the PostgreSQL dialect (e.g. INTEGER[], TEXT[]); MySQL and SQLite ignore the flag.

`isAutoIncrement()`¶

public function isAutoIncrement(): bool;

Auto-Increment

`isFirst()`¶

public function isFirst(): bool;

Check whether column has the first position in the table

`isGenerated()`¶

public function isGenerated(): bool;

Whether the column is a generated/computed column.

`isGenerationStored()`¶

public function isGenerationStored(): bool;

Whether a generated column is STORED. false means VIRTUAL.

`isInvisible()`¶

public function isInvisible(): bool;

Whether the column is declared INVISIBLE (MySQL 8.0.23+).

`isNotNull()`¶

public function isNotNull(): bool;

Not null

`isNumeric()`¶

public function isNumeric(): bool;

Check whether column have a numeric type

`isPrimary()`¶

public function isPrimary(): bool;

Column is part of the primary key?

`isUnsigned()`¶

public function isUnsigned(): bool;

Returns true if number column is unsigned

Db\ColumnInterface¶

Interface Source on GitHub

Phalcon\Db\ColumnInterface

Phalcon\Contracts\Db\Column
- Phalcon\Db\ColumnInterface

Uses Phalcon\Contracts\Db\Column

Db\Dialect¶

Abstract Source on GitHub

This is the base class to each database dialect. This implements common methods to transform intermediate code into its RDBMS related syntax

Phalcon\Db\Dialect - implements Phalcon\Db\DialectInterface

Uses Phalcon\Db\Exceptions\ConflictTargetColumnRequired · Phalcon\Db\Exceptions\ConflictUpdateColumnRequired · Phalcon\Db\Exceptions\InvalidGroupByExpression · Phalcon\Db\Exceptions\InvalidListExpression · Phalcon\Db\Exceptions\InvalidOrderByExpression · Phalcon\Db\Exceptions\InvalidSqlExpression · Phalcon\Db\Exceptions\InvalidSqlExpressionType · Phalcon\Db\Exceptions\InvalidUnaryExpression · Phalcon\Db\Exceptions\MaterializedViewsNotSupported · Phalcon\Db\Exceptions\MissingDefinitionKey · Phalcon\Db\Exceptions\ReturningNotSupported · Phalcon\Db\Exceptions\UnsupportedOperator · Phalcon\Support\Settings

Method Summary¶

Properties¶

protected array $customFunctions = []

protected string $escapeChar

protected array $guardedOperators = [...] Dialect-specific operators that a concrete dialect must opt into via $supportedOperators; using one elsewhere throws.

protected array $supportedOperators = [] Subset of $guardedOperators that this dialect emits. Overridden per dialect.

Methods¶

Public · 25

`createMaterializedView()`¶

public function createMaterializedView(
    string $viewName,
    array $definition,
    string|null $schemaName = null
): string;

Generates SQL to create a materialized view. Supported by PostgreSQL; MySQL and SQLite inherit this throw.

`createSavepoint()`¶

public function createSavepoint( string $name ): string;

Generate SQL to create a new savepoint

`dropMaterializedView()`¶

public function dropMaterializedView(
    string $viewName,
    string|null $schemaName = null,
    bool $ifExists = true
): string;

Generates SQL to drop a materialized view (PostgreSQL only).

`escape()`¶

final public function escape(
    string $input,
    string $escapeChar = ""
): string;

Escape identifiers

`escapeSchema()`¶

final public function escapeSchema(
    string $input,
    string $escapeChar = ""
): string;

Escape Schema

`forUpdate()`¶

public function forUpdate(
    string $sqlQuery,
    string $modifier = ""
): string;

Returns a SQL modified with a FOR UPDATE clause. The optional modifier appends a row-lock disposition keyword.

$sql = $dialect->forUpdate("SELECT * FROM co_invoices");
echo $sql; // SELECT * FROM co_invoices FOR UPDATE

$sql = $dialect->forUpdate(
    "SELECT * FROM co_invoices",
    Dialect::LOCK_NOWAIT
);
echo $sql; // SELECT * FROM co_invoices FOR UPDATE NOWAIT

`getColumnList()`¶

final public function getColumnList(
    array $columnList,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Gets a list of columns with escaped identifiers

echo $dialect->getColumnList(
    [
        "column1",
        "column",
    ]
);

`getCustomFunctions()`¶

public function getCustomFunctions(): array;

Returns registered functions

`getSqlColumn()`¶

final public function getSqlColumn(
    array|string $column,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve Column expressions

`getSqlExpression()`¶

public function getSqlExpression(
    array $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Transforms an intermediate representation for an expression into a database system valid expression

`getSqlTable()`¶

final public function getSqlTable(
    array|string $tableName,
    string $escapeChar = ""
): string;

Transform an intermediate representation of a schema/table into a database system valid expression

`limit()`¶

public function limit(
    string $sqlQuery,
    array|int $number
): string;

Generates the SQL for LIMIT clause

// SELECT * FROM co_invoices LIMIT 10
echo $dialect->limit(
    "SELECT * FROM co_invoices",
    10
);

// SELECT * FROM co_invoices LIMIT 10 OFFSET 50
echo $dialect->limit(
    "SELECT * FROM co_invoices",
    [10, 50]
);

`onConflictUpdate()`¶

public function onConflictUpdate(
    string $sqlQuery,
    array $conflictColumns,
    array $updateColumns
): string;

Appends an ON CONFLICT (col, ...) DO UPDATE SET col = excluded.col upsert clause to the supplied INSERT statement. Supported by PostgreSQL 9.5+ and SQLite 3.24+. MySQL overrides this method to throw.

`refreshMaterializedView()`¶

public function refreshMaterializedView(
    string $viewName,
    string|null $schemaName = null,
    bool $concurrent = false
): string;

Generates SQL to refresh a materialized view (PostgreSQL only).

`registerCustomFunction()`¶

public function registerCustomFunction(
    string $name,
    callable $customFunction
): static;

Registers custom SQL functions

`releaseSavepoint()`¶

public function releaseSavepoint( string $name ): string;

Generate SQL to release a savepoint

`returning()`¶

public function returning(
    string $sqlQuery,
    array $columns
): string;

Returns a SQL statement extended with a RETURNING clause. Supported by PostgreSQL and SQLite 3.35+; MySQL inherits the throw.

`rollbackSavepoint()`¶

public function rollbackSavepoint( string $name ): string;

Generate SQL to rollback a savepoint

`select()`¶

public function select( array $definition ): string;

Builds a SELECT statement

`supportsAlterTable()`¶

public function supportsAlterTable(): bool;

Checks whether the platform supports the full ALTER TABLE matrix: modifying existing columns and adding or dropping foreign keys, primary keys, and check constraints. SQLite returns false - those operations throw a dedicated Sqlite*NotSupported exception there (basic ADD COLUMN remains available).

`supportsMaterializedViews()`¶

public function supportsMaterializedViews(): bool;

Checks whether the platform supports materialized views. Only PostgreSQL returns true; createMaterializedView() throws on the other dialects.

`supportsOnConflictUpdate()`¶

public function supportsOnConflictUpdate(): bool;

Checks whether the platform supports the ON CONFLICT (...) DO UPDATE upsert clause. MySQL returns false; onConflictUpdate() throws there.

`supportsReleaseSavepoints()`¶

public function supportsReleaseSavepoints(): bool;

Checks whether the platform supports releasing savepoints.

`supportsReturning()`¶

public function supportsReturning(): bool;

Checks whether the platform supports the RETURNING clause. MySQL returns false; returning() throws there.

`supportsSavepoints()`¶

public function supportsSavepoints(): bool;

Checks whether the platform supports savepoints

Protected · 28

`checkColumnType()`¶

protected function checkColumnType( ColumnInterface $column ): int;

Checks the column type and if not string it returns the type reference

`checkColumnTypeSql()`¶

protected function checkColumnTypeSql( ColumnInterface $column ): string;

Checks the column type and returns the updated SQL statement

`getCheckClause()`¶

protected function getCheckClause(
    CheckInterface $check,
    string $escapeChar = "`"
): string;

Builds a CHECK constraint clause from a CheckInterface, using the provided escape character for the constraint name.

`getColumnSize()`¶

protected function getColumnSize( ColumnInterface $column ): string;

Returns the size of the column enclosed in parentheses

`getColumnSizeAndScale()`¶

protected function getColumnSizeAndScale( ColumnInterface $column ): string;

Returns the column size and scale enclosed in parentheses

`getGeneratedClause()`¶

protected function getGeneratedClause(
    ColumnInterface $column,
    bool $forceStored = false
): string;

Builds the GENERATED ALWAYS AS (<expr>) 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 (PostgreSQL uses this).

`getIndexColumnList()`¶

protected function getIndexColumnList(
    IndexInterface $index,
    bool $wrapExpressions = true
): string;

Builds the per-index parenthesized column list, honoring per-column sort directions and RawValue expression entries.

`getSqlExpressionAll()`¶

final protected function getSqlExpressionAll(
    array $expression,
    string $escapeChar = ""
): string;

Resolve *

`getSqlExpressionBinaryOperations()`¶

final protected function getSqlExpressionBinaryOperations(
    array $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve binary operations expressions

`getSqlExpressionCase()`¶

final protected function getSqlExpressionCase(
    array $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve CASE expressions

`getSqlExpressionCastValue()`¶

final protected function getSqlExpressionCastValue(
    array $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve CAST of values

`getSqlExpressionConvertValue()`¶

final protected function getSqlExpressionConvertValue(
    array $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve CONVERT of values encodings

`getSqlExpressionFrom()`¶

final protected function getSqlExpressionFrom(
    array|string $expression,
    string $escapeChar = ""
): string;

Resolve a FROM clause

`getSqlExpressionFunctionCall()`¶

final protected function getSqlExpressionFunctionCall(
    array $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve function calls

`getSqlExpressionGroupBy()`¶

final protected function getSqlExpressionGroupBy(
    array|string $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve a GROUP BY clause

`getSqlExpressionHaving()`¶

final protected function getSqlExpressionHaving(
    array $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve a HAVING clause

`getSqlExpressionJoins()`¶

final protected function getSqlExpressionJoins(
    array|string $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve a JOINs clause

@todo Isn't expression just an array?

`getSqlExpressionLimit()`¶

final protected function getSqlExpressionLimit(
    array|string $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve a LIMIT clause

`getSqlExpressionList()`¶

final protected function getSqlExpressionList(
    array $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve Lists

`getSqlExpressionObject()`¶

final protected function getSqlExpressionObject(
    array $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve object expressions

`getSqlExpressionOrderBy()`¶

final protected function getSqlExpressionOrderBy(
    array|string $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve an ORDER BY clause

`getSqlExpressionQualified()`¶

final protected function getSqlExpressionQualified(
    array $expression,
    string $escapeChar = ""
): string;

Resolve qualified expressions

`getSqlExpressionScalar()`¶

final protected function getSqlExpressionScalar(
    array $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve Column expressions

`getSqlExpressionUnaryOperations()`¶

final protected function getSqlExpressionUnaryOperations(
    array $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve unary operations expressions

`getSqlExpressionWhere()`¶

final protected function getSqlExpressionWhere(
    array|string $expression,
    string $escapeChar = "",
    array $bindCounts = []
): string;

Resolve a WHERE clause

`prepareColumnAlias()`¶

protected function prepareColumnAlias(
    string $qualified,
    string $alias = "",
    string $escapeChar = ""
): string;

Prepares column for this RDBMS

`prepareQualified()`¶

protected function prepareQualified(
    string $column,
    string $domain = "",
    string $escapeChar = ""
): string;

Prepares qualified for this RDBMS

`prepareTable()`¶

protected function prepareTable(
    string $tableName,
    string|null $schemaName = null,
    string $alias = "",
    string $escapeChar = ""
): string;

Prepares table for this RDBMS

Db\DialectInterface¶

Interface Source on GitHub

Phalcon\Db\DialectInterface

Phalcon\Contracts\Db\Dialect
- 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
- Phalcon\Db\Dialect\Mysql

Uses Phalcon\Db\CheckInterface · Phalcon\Db\Column · Phalcon\Db\ColumnInterface · Phalcon\Db\Dialect · Phalcon\Db\Dialect\Traits\TextTrait · Phalcon\Db\Exception · Phalcon\Db\Exceptions\MissingDefinitionKey · Phalcon\Db\Exceptions\MysqlOnConflictNotSupported · Phalcon\Db\IndexInterface · Phalcon\Db\ReferenceInterface

Method Summary¶

Properties¶

protected string $escapeChar = "`"

protected array $supportedOperators = [...]

Methods¶

Public · 29

`addCheck()`¶

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()`¶

public function addColumn(
    string $tableName,
    string $schemaName,
    ColumnInterface $column
): string;

Generates SQL to add a column to a table

`addForeignKey()`¶

public function addForeignKey(
    string $tableName,
    string $schemaName,
    ReferenceInterface $reference
): string;

Generates SQL to add an index to a table

`addIndex()`¶

public function addIndex(
    string $tableName,
    string $schemaName,
    IndexInterface $index
): string;

Generates SQL to add an index to a table

`addPrimaryKey()`¶

public function addPrimaryKey(
    string $tableName,
    string $schemaName,
    IndexInterface $index
): string;

Generates SQL to add the primary key to a table

`createTable()`¶

public function createTable(
    string $tableName,
    string $schemaName,
    array $definition
): string;

Generates SQL to create a table

`createView()`¶

public function createView(
    string $viewName,
    array $definition,
    string|null $schemaName = null
): string;

Generates SQL to create a view

`describeColumns()`¶

public function describeColumns(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL describing a table

print_r(
    $dialect->describeColumns("posts")
);

`describeIndexes()`¶

public function describeIndexes(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL to query indexes on a table

`describeReferences()`¶

public function describeReferences(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL to query foreign keys on a table

`dropCheck()`¶

public function dropCheck(
    string $tableName,
    string $schemaName,
    string $checkName
): string;

Generates SQL to delete a CHECK constraint from a table.

`dropColumn()`¶

public function dropColumn(
    string $tableName,
    string $schemaName,
    string $columnName
): string;

Generates SQL to delete a column from a table

`dropForeignKey()`¶

public function dropForeignKey(
    string $tableName,
    string $schemaName,
    string $referenceName
): string;

Generates SQL to delete a foreign key from a table

`dropIndex()`¶

public function dropIndex(
    string $tableName,
    string $schemaName,
    string $indexName
): string;

Generates SQL to delete an index from a table

`dropPrimaryKey()`¶

public function dropPrimaryKey(
    string $tableName,
    string $schemaName
): string;

Generates SQL to delete primary key from a table

`dropTable()`¶

public function dropTable(
    string $tableName,
    string|null $schemaName = null,
    bool $ifExists = true
): string;

Generates SQL to drop a table

`dropView()`¶

public function dropView(
    string $viewName,
    string|null $schemaName = null,
    bool $ifExists = true
): string;

Generates SQL to drop a view

`getColumnDefinition()`¶

public function getColumnDefinition( ColumnInterface $column ): string;

Gets the column name in MySQL

`getForeignKeyChecks()`¶

public function getForeignKeyChecks(): string;

Generates SQL to check DB parameter FOREIGN_KEY_CHECKS.

`listTables()`¶

public function listTables( string|null $schemaName = null ): string;

List all tables in database

print_r(
    $dialect->listTables("blog")
);

`listViews()`¶

public function listViews( string|null $schemaName = null ): string;

Generates the SQL to list all views of a schema or user

`modifyColumn()`¶

public function modifyColumn(
    string $tableName,
    string $schemaName,
    ColumnInterface $column,
    ColumnInterface|null $currentColumn = null
): string;

Generates SQL to modify a column in a table

`onConflictUpdate()`¶

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.

`sharedLock()`¶

public function sharedLock(
    string $sqlQuery,
    string $modifier = ""
): string;

Returns a SQL modified with a LOCK IN SHARE MODE clause

$sql = $dialect->sharedLock("SELECT * FROM co_invoices");

echo $sql; // SELECT * FROM co_invoices LOCK IN SHARE MODE

`supportsOnConflictUpdate()`¶

public function supportsOnConflictUpdate(): bool;

MySQL does not support the SQL-standard ON CONFLICT (...) DO UPDATE upsert clause; onConflictUpdate() throws.

`tableExists()`¶

public function tableExists(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL checking for the existence of a schema.table

echo $dialect->tableExists("posts", "blog");

echo $dialect->tableExists("posts");

`tableOptions()`¶

public function tableOptions(
    string $tableName,
    string|null $schemaName = null
): string;

Generates the SQL to describe the table creation options

`truncateTable()`¶

public function truncateTable(
    string $tableName,
    string $schemaName = ""
): string;

Generates SQL to truncate a table

`viewExists()`¶

public function viewExists(
    string $viewName,
    string|null $schemaName = null
): string;

Generates SQL checking for the existence of a schema.view

Db\Dialect\Postgresql¶

Class Source on GitHub

Generates database specific SQL for the PostgreSQL RDBMS

Phalcon\Db\Dialect
- Phalcon\Db\Dialect\Postgresql

Uses Phalcon\Db\CheckInterface · Phalcon\Db\Column · Phalcon\Db\ColumnInterface · Phalcon\Db\Dialect · 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¶

Properties¶

protected string $escapeChar = "\""

protected array $supportedOperators = [...]

Methods¶

Public · 32

`addCheck()`¶

public function addCheck(
    string $tableName,
    string $schemaName,
    CheckInterface $check
): string;

Generates SQL to add a CHECK constraint to an existing table.

`addColumn()`¶

public function addColumn(
    string $tableName,
    string $schemaName,
    ColumnInterface $column
): string;

Generates SQL to add a column to a table

`addForeignKey()`¶

public function addForeignKey(
    string $tableName,
    string $schemaName,
    ReferenceInterface $reference
): string;

Generates SQL to add an index to a table

`addIndex()`¶

public function addIndex(
    string $tableName,
    string $schemaName,
    IndexInterface $index
): string;

Generates SQL to add an index to a table

`addPrimaryKey()`¶

public function addPrimaryKey(
    string $tableName,
    string $schemaName,
    IndexInterface $index
): string;

Generates SQL to add the primary key to a table

`createMaterializedView()`¶

public function createMaterializedView(
    string $viewName,
    array $definition,
    string|null $schemaName = null
): string;

Generates SQL to create a materialized view.

`createTable()`¶

public function createTable(
    string $tableName,
    string $schemaName,
    array $definition
): string;

Generates SQL to create a table

`createView()`¶

public function createView(
    string $viewName,
    array $definition,
    string|null $schemaName = null
): string;

Generates SQL to create a view

`describeColumns()`¶

public function describeColumns(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL describing a table

print_r(
    $dialect->describeColumns("posts")
);

`describeIndexes()`¶

public function describeIndexes(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL to query indexes on a table

`describeReferences()`¶

public function describeReferences(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL to query foreign keys on a table

`dropCheck()`¶

public function dropCheck(
    string $tableName,
    string $schemaName,
    string $checkName
): string;

Generates SQL to delete a CHECK constraint from a table.

`dropColumn()`¶

public function dropColumn(
    string $tableName,
    string $schemaName,
    string $columnName
): string;

Generates SQL to delete a column from a table

`dropForeignKey()`¶

public function dropForeignKey(
    string $tableName,
    string $schemaName,
    string $referenceName
): string;

Generates SQL to delete a foreign key from a table

`dropIndex()`¶

public function dropIndex(
    string $tableName,
    string $schemaName,
    string $indexName
): string;

Generates SQL to delete an index from a table

`dropMaterializedView()`¶

public function dropMaterializedView(
    string $viewName,
    string|null $schemaName = null,
    bool $ifExists = true
): string;

Generates SQL to drop a materialized view.

`dropPrimaryKey()`¶

public function dropPrimaryKey(
    string $tableName,
    string $schemaName
): string;

Generates SQL to delete primary key from a table

`dropTable()`¶

public function dropTable(
    string $tableName,
    string|null $schemaName = null,
    bool $ifExists = true
): string;

Generates SQL to drop a table

`dropView()`¶

public function dropView(
    string $viewName,
    string|null $schemaName = null,
    bool $ifExists = true
): string;

Generates SQL to drop a view

`getColumnDefinition()`¶

public function getColumnDefinition( ColumnInterface $column ): string;

Gets the column name in PostgreSQL

`listTables()`¶

public function listTables( string|null $schemaName = null ): string;

List all tables in database

print_r(
    $dialect->listTables("blog")
);

`listViews()`¶

public function listViews( string|null $schemaName = null ): string;

Generates the SQL to list all views of a schema or user

`modifyColumn()`¶

public function modifyColumn(
    string $tableName,
    string $schemaName,
    ColumnInterface $column,
    ColumnInterface|null $currentColumn = null
): string;

Generates SQL to modify a column in a table

`refreshMaterializedView()`¶

public function refreshMaterializedView(
    string $viewName,
    string|null $schemaName = null,
    bool $concurrent = false
): string;

Generates SQL to refresh a materialized view.

`returning()`¶

public function returning(
    string $sqlQuery,
    array $columns
): string;

Appends a RETURNING clause to the supplied INSERT/UPDATE/DELETE statement.

`sharedLock()`¶

public function sharedLock(
    string $sqlQuery,
    string $modifier = ""
): string;

Returns a SQL modified a shared lock statement. For now this method returns the original query

`supportsMaterializedViews()`¶

public function supportsMaterializedViews(): bool;

PostgreSQL supports materialized views (CREATE MATERIALIZED VIEW).

`supportsReturning()`¶

public function supportsReturning(): bool;

PostgreSQL supports the RETURNING clause.

`tableExists()`¶

public function tableExists(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL checking for the existence of a schema.table

echo $dialect->tableExists("posts", "blog");

echo $dialect->tableExists("posts");

`tableOptions()`¶

public function tableOptions(
    string $tableName,
    string|null $schemaName = null
): string;

Generates the SQL to describe the table creation options

`truncateTable()`¶

public function truncateTable(
    string $tableName,
    string|null $schemaName = ""
): string;

Generates SQL to truncate a table

`viewExists()`¶

public function viewExists(
    string $viewName,
    string|null $schemaName = null
): string;

Generates SQL checking for the existence of a schema.view

Protected · 2

`castDefault()`¶

protected function castDefault( ColumnInterface $column ): string;

`getTableOptions()`¶

protected function getTableOptions( array $definition ): string;

Db\Dialect\Sqlite¶

Class Source on GitHub

Generates database specific SQL for the SQLite RDBMS

Phalcon\Db\Dialect
- Phalcon\Db\Dialect\Sqlite

Uses Phalcon\Db\CheckInterface · Phalcon\Db\Column · Phalcon\Db\ColumnInterface · Phalcon\Db\Dialect · Phalcon\Db\Dialect\Traits\TextTrait · 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\ReferenceInterface

Method Summary¶

Properties¶

protected string $escapeChar = "\""

protected array $supportedOperators = [...]

Methods¶

Public · 32

`addCheck()`¶

public function addCheck(
    string $tableName,
    string $schemaName,
    CheckInterface $check
): string;

SQLite cannot ALTER an existing table to add a CHECK constraint.

`addColumn()`¶

public function addColumn(
    string $tableName,
    string $schemaName,
    ColumnInterface $column
): string;

Generates SQL to add a column to a table

`addForeignKey()`¶

public function addForeignKey(
    string $tableName,
    string $schemaName,
    ReferenceInterface $reference
): string;

Generates SQL to add an index to a table

`addIndex()`¶

public function addIndex(
    string $tableName,
    string $schemaName,
    IndexInterface $index
): string;

Generates SQL to add an index to a table

`addPrimaryKey()`¶

public function addPrimaryKey(
    string $tableName,
    string $schemaName,
    IndexInterface $index
): string;

Generates SQL to add the primary key to a table

`createTable()`¶

public function createTable(
    string $tableName,
    string $schemaName,
    array $definition
): string;

Generates SQL to create a table

`createView()`¶

public function createView(
    string $viewName,
    array $definition,
    string|null $schemaName = null
): string;

Generates SQL to create a view

`describeColumns()`¶

public function describeColumns(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL describing a table

print_r(
    $dialect->describeColumns("posts")
);

`describeIndex()`¶

public function describeIndex( string $index ): string;

Generates SQL to query indexes detail on a table

`describeIndexes()`¶

public function describeIndexes(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL to query indexes on a table

`describeReferences()`¶

public function describeReferences(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL to query foreign keys on a table

`dropCheck()`¶

public function dropCheck(
    string $tableName,
    string $schemaName,
    string $checkName
): string;

SQLite cannot DROP a CHECK constraint from an existing table.

`dropColumn()`¶

public function dropColumn(
    string $tableName,
    string $schemaName,
    string $columnName
): string;

Generates SQL to delete a column from a table

`dropForeignKey()`¶

public function dropForeignKey(
    string $tableName,
    string $schemaName,
    string $referenceName
): string;

Generates SQL to delete a foreign key from a table

`dropIndex()`¶

public function dropIndex(
    string $tableName,
    string $schemaName,
    string $indexName
): string;

Generates SQL to delete an index from a table

`dropPrimaryKey()`¶

public function dropPrimaryKey(
    string $tableName,
    string $schemaName
): string;

Generates SQL to delete primary key from a table

`dropTable()`¶

public function dropTable(
    string $tableName,
    string|null $schemaName = null,
    bool $ifExists = true
): string;

Generates SQL to drop a table

`dropView()`¶

public function dropView(
    string $viewName,
    string|null $schemaName = null,
    bool $ifExists = true
): string;

Generates SQL to drop a view

`forUpdate()`¶

public function forUpdate(
    string $sqlQuery,
    string $modifier = ""
): string;

Returns a SQL modified with a FOR UPDATE clause. For SQLite, it returns the original query

`getColumnDefinition()`¶

public function getColumnDefinition( ColumnInterface $column ): string;

Gets the column name in SQLite

`listIndexesSql()`¶

public function listIndexesSql(
    string $tableName,
    string|null $schemaName = null,
    string|null $keyName = null
): string;

Generates the SQL to get query list of indexes

print_r(
    $dialect->listIndexesSql("blog")
);

`listTables()`¶

public function listTables( string|null $schemaName = null ): string;

List all tables in database

print_r(
    $dialect->listTables("blog")
);

`listViews()`¶

public function listViews( string|null $schemaName = null ): string;

Generates the SQL to list all views of a schema or user

`modifyColumn()`¶

public function modifyColumn(
    string $tableName,
    string $schemaName,
    ColumnInterface $column,
    ColumnInterface|null $currentColumn = null
): string;

Generates SQL to modify a column in a table

`returning()`¶

public function returning(
    string $sqlQuery,
    array $columns
): string;

Appends a RETURNING clause to the supplied INSERT/UPDATE/DELETE statement. SQLite 3.35+.

`sharedLock()`¶

public function sharedLock(
    string $sqlQuery,
    string $modifier = ""
): string;

Returns a SQL modified a shared lock statement. For now this method returns the original query

`supportsAlterTable()`¶

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()`¶

public function supportsReturning(): bool;

SQLite (3.35+) supports the RETURNING clause.

`tableExists()`¶

public function tableExists(
    string $tableName,
    string|null $schemaName = null
): string;

Generates SQL checking for the existence of a schema.table

echo $dialect->tableExists("posts", "blog");

echo $dialect->tableExists("posts");

`tableOptions()`¶

public function tableOptions(
    string $tableName,
    string|null $schemaName = null
): string;

Generates the SQL to describe the table creation options

`truncateTable()`¶

public function truncateTable(
    string $tableName,
    string|null $schemaName = ""
): string;

Generates SQL to truncate a table

`viewExists()`¶

public function viewExists(
    string $viewName,
    string|null $schemaName = null
): string;

Generates SQL checking for the existence of a schema.view

Db\Dialect\Traits\TextTrait¶

Trait Source on GitHub

Phalcon\Db\Dialect\Traits\TextTrait

Uses Phalcon\Db\Column · Phalcon\Db\Exception · Phalcon\Db\Index · Phalcon\Db\RawValue · Phalcon\Db\Reference

Used by Phalcon\Db\Dialect\Mysql · Phalcon\Db\Dialect\Sqlite

Method Summary¶

Methods¶

Protected · 27

`alter()`¶

protected function alter(
    string $tableName,
    string|null $schemaName = null
): string;

`alterTableDrop()`¶

protected function alterTableDrop(
    string $object,
    string $item,
    string $tableName,
    string $schemaName
): string;

`checkColumnComment()`¶

protected function checkColumnComment( Column $column ): string;

`checkColumnFirstAfterPositions()`¶

protected function checkColumnFirstAfterPositions( Column $column ): string;

`checkColumnHasDefault()`¶

protected function checkColumnHasDefault( Column $column ): string;

`checkColumnIsAutoIncrement()`¶

protected function checkColumnIsAutoIncrement( Column $column ): string;

`checkColumnIsGenerated()`¶

protected function checkColumnIsGenerated( Column $column ): string;

Emits the GENERATED ALWAYS AS (...) VIRTUAL|STORED clause. Wraps the shared dialect helper for trait users.

`checkColumnIsInvisible()`¶

protected function checkColumnIsInvisible( Column $column ): string;

Emits the INVISIBLE keyword for MySQL 8.0.23+ invisible columns. Other dialects override this trait helper to return an empty string.

`checkColumnIsNull()`¶

protected function checkColumnIsNull( Column $column ): string;

`checkColumnIsPrimary()`¶

protected function checkColumnIsPrimary( Column $column ): string;

`checkColumnSizeAndScale()`¶

protected function checkColumnSizeAndScale( Column $column ): string;

Checks if the size and/or scale are present and encloses those values in parentheses if need be

`checkColumnUnsigned()`¶

protected function checkColumnUnsigned( Column $column ): string;

Checks if a column is unsigned or not and returns the relevant SQL syntax

`checkReferenceConstraint()`¶

protected function checkReferenceConstraint( Reference $reference ): string;

`checkReferenceOnDelete()`¶

protected function checkReferenceOnDelete( Reference $reference ): string;

`checkReferenceOnUpdate()`¶

protected function checkReferenceOnUpdate( Reference $reference ): string;

`delimit()`¶

protected function delimit(
    string $identifier,
    string $delimiter = "`"
): string;

`drop()`¶

protected function drop( string $type ): string;

`exists()`¶

protected function exists( bool $exists ): string;

`getExistsSql()`¶

protected function getExistsSql(
    string $table,
    string $viewName,
    string|null $schemaName
): string;

`getMysqlSchemaString()`¶

protected function getMysqlSchemaString( string|null $schemaName ): string;

`getNullString()`¶

protected function getNullString(): string;

`getTableChecks()`¶

protected function getTableChecks( array $definition ): array;

Returns the list of CONSTRAINT ... CHECK (...) lines for createTable. Uses the dialect's escape character via the shared getCheckClause() helper.

`getTableColumns()`¶

protected function getTableColumns( array $definition ): array;

`getTableIndexes()`¶

protected function getTableIndexes( array $definition ): array;

`getTableOptions()`¶

protected function getTableOptions( array $definition ): string;

Generates SQL to add the table creation options

`getTableReferences()`¶

protected function getTableReferences( array $definition ): array;

`wrap()`¶

protected function wrap( string $identifier ): string;

Db\Enum¶

Class Source on GitHub

Constants for Phalcon\Db

Phalcon\Db\Enum

Uses PDO

Constants¶

mixed FETCH_ASSOC = PDO::FETCH_ASSOC

mixed FETCH_BOTH = PDO::FETCH_BOTH

mixed FETCH_BOUND = PDO::FETCH_BOUND

mixed FETCH_CLASS = PDO::FETCH_CLASS

mixed FETCH_CLASSTYPE = PDO::FETCH_CLASSTYPE

mixed FETCH_COLUMN = PDO::FETCH_COLUMN

mixed FETCH_DEFAULT = PDO::FETCH_DEFAULT

mixed FETCH_FUNC = PDO::FETCH_FUNC

mixed FETCH_GROUP = PDO::FETCH_GROUP

mixed FETCH_INTO = PDO::FETCH_INTO

mixed FETCH_KEY_PAIR = PDO::FETCH_KEY_PAIR

mixed FETCH_LAZY = PDO::FETCH_LAZY

mixed FETCH_NAMED = PDO::FETCH_NAMED

mixed FETCH_NUM = PDO::FETCH_NUM

mixed FETCH_OBJ = PDO::FETCH_OBJ

mixed FETCH_ORI_NEXT = PDO::FETCH_ORI_NEXT

mixed FETCH_PROPS_LATE = PDO::FETCH_PROPS_LATE

mixed FETCH_SERIALIZE = PDO::FETCH_SERIALIZE

mixed FETCH_UNIQUE = PDO::FETCH_UNIQUE

Db\Event\AbstractCancellableModelEvent¶

Abstract Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent - implements \Psr\EventDispatcher\StoppableEventInterface

Uses Psr\EventDispatcher\StoppableEventInterface

Method Summary¶

public void cancel() public bool isPropagationStopped()

Methods¶

Public · 2

`cancel()`¶

public function cancel(): void;

`isPropagationStopped()`¶

public function isPropagationStopped(): bool;

Db\Event\AbstractModelEvent¶

Abstract Source on GitHub

Phalcon\Db\Event\AbstractModelEvent - implements Phalcon\Events\PsrEventInterface

Uses Phalcon\Events\PsrEventInterface · Phalcon\Mvc\Model

Method Summary¶

public __construct( Model $model )

Properties¶

public Model $model

Methods¶

Public · 1

`__construct()`¶

public function __construct( Model $model );

Db\Event\AfterCreateEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AfterCreateEvent

Db\Event\AfterDeleteEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AfterDeleteEvent

Db\Event\AfterFetchEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AfterFetchEvent

Db\Event\AfterSaveEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AfterSaveEvent

Db\Event\AfterUpdateEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AfterUpdateEvent

Db\Event\AfterValidationEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent
  - Phalcon\Db\Event\AfterValidationEvent

Db\Event\AfterValidationOnCreateEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent
  - Phalcon\Db\Event\AfterValidationOnCreateEvent

Db\Event\AfterValidationOnUpdateEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent
  - Phalcon\Db\Event\AfterValidationOnUpdateEvent

Db\Event\BeforeCreateEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent
  - Phalcon\Db\Event\BeforeCreateEvent

Db\Event\BeforeDeleteEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent
  - Phalcon\Db\Event\BeforeDeleteEvent

Db\Event\BeforeSaveEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent
  - Phalcon\Db\Event\BeforeSaveEvent

Db\Event\BeforeUpdateEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent
  - Phalcon\Db\Event\BeforeUpdateEvent

Db\Event\BeforeValidationEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent
  - Phalcon\Db\Event\BeforeValidationEvent

Db\Event\BeforeValidationOnCreateEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent
  - Phalcon\Db\Event\BeforeValidationOnCreateEvent

Db\Event\BeforeValidationOnUpdateEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent
  - Phalcon\Db\Event\BeforeValidationOnUpdateEvent

Db\Event\Factory¶

Class Source on GitHub

Phalcon\Db\Event\Factory

Uses Phalcon\Events\PsrEventInterface · Phalcon\Mvc\Model

Method Summary¶

public PsrEventInterface|null create(string $eventName,Model $model)

Methods¶

Public · 1

`create()`¶

public function create(
    string $eventName,
    Model $model
): PsrEventInterface|null;

Db\Event\ModelEventNameEnum¶

Class Source on GitHub

Phalcon\Db\Event\ModelEventNameEnum

Method Summary¶

public self fromEventClass( string $eventClassName ) Get an enum case from event class name public string getEventClass( mixed $eventName ) Get the event class associated with this event type public self|null tryFromEventClass( string $eventClassName )

Constants¶

string AFTER_CREATE = "afterCreate"

string AFTER_DELETE = "afterDelete"

string AFTER_FETCH = "afterFetch"

string AFTER_SAVE = "afterSave"

string AFTER_UPDATE = "afterUpdate"

string AFTER_VALIDATION = "afterValidation"

string AFTER_VALIDATION_ON_CREATE = "afterValidationOnCreate"

string AFTER_VALIDATION_ON_UPDATE = "afterValidationOnUpdate"

string BEFORE_CREATE = "beforeCreate"

string BEFORE_DELETE = "beforeDelete"

string BEFORE_SAVE = "beforeSave"

string BEFORE_UPDATE = "beforeUpdate"

string BEFORE_VALIDATION = "beforeValidation"

string BEFORE_VALIDATION_ON_CREATE = "beforeValidationOnCreate"

string BEFORE_VALIDATION_ON_UPDATE = "beforeValidationOnUpdate"

string NOT_DELETED = "notDeleted"

string NOT_SAVED = "notSaved"

string ON_VALIDATION_FAILS = "onValidationFails"

string PREPARE_SAVE = "prepareSave"

string VALIDATION = "validation"

Methods¶

Public · 3

`fromEventClass()`¶

public static function fromEventClass( string $eventClassName ): self;

Get an enum case from event class name

`getEventClass()`¶

public static function getEventClass( mixed $eventName ): string;

Get the event class associated with this event type

`tryFromEventClass()`¶

public static function tryFromEventClass( string $eventClassName ): self|null;

Db\Event\NotDeletedEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\NotDeletedEvent

Db\Event\NotSavedEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\NotSavedEvent

Db\Event\OnValidationFailsEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\OnValidationFailsEvent

Db\Event\PrepareSaveEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\PrepareSaveEvent

Db\Event\UnknownEventTypeException¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Event\UnknownEventTypeException

Uses Phalcon\Db\Exception · Throwable

Method Summary¶

public __construct(string $message = "",int $code = 0,Throwable|null $previous = null)

Methods¶

Public · 1

`__construct()`¶

public function __construct(
    string $message = "",
    int $code = 0,
    Throwable|null $previous = null
);

Db\Event\ValidationEvent¶

Class Source on GitHub

Phalcon\Db\Event\AbstractModelEvent
- Phalcon\Db\Event\AbstractCancellableModelEvent
  - Phalcon\Db\Event\ValidationEvent

Db\Exception¶

Class Source on GitHub

Exceptions thrown in Phalcon\Db will use this class

\Exception
- Phalcon\Db\Exception

Db\Exceptions\CannotInsertWithoutData¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\CannotInsertWithoutData

Uses Phalcon\Db\Exception

Method Summary¶

public __construct( string $table )

Methods¶

Public · 1

`__construct()`¶

public function __construct( string $table );

Db\Exceptions\CannotPrepareStatement¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\CannotPrepareStatement

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\CheckExpressionRequired¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\CheckExpressionRequired

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\ColumnTypeRejectsAutoIncrement¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\ColumnTypeRejectsAutoIncrement

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\ColumnTypeRejectsScale¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\ColumnTypeRejectsScale

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\ColumnTypeRequired¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\ColumnTypeRequired

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\ConflictTargetColumnRequired¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\ConflictTargetColumnRequired

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\ConflictUpdateColumnRequired¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\ConflictUpdateColumnRequired

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\ForeignKeyColumnsRequired¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\ForeignKeyColumnsRequired

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\GeneratedAutoIncrementConflict¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\GeneratedAutoIncrementConflict

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\GeneratedDefaultConflict¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\GeneratedDefaultConflict

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\IncompleteBindTypes¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\IncompleteBindTypes

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidBindParameter¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidBindParameter

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidCheckExpression¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidCheckExpression

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidDialectClass¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidDialectClass

Uses Phalcon\Db\Exception

Method Summary¶

public __construct( string $className )

Methods¶

Public · 1

`__construct()`¶

public function __construct( string $className );

Db\Exceptions\InvalidGenerationExpression¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidGenerationExpression

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidGroupByExpression¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidGroupByExpression

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidIndexColumns¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidIndexColumns

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidIndexDirections¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidIndexDirections

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidIndexWhere¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidIndexWhere

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidListExpression¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidListExpression

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidOrderByExpression¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidOrderByExpression

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidSqlExpression¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidSqlExpression

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidSqlExpressionType¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidSqlExpressionType

Uses Phalcon\Db\Exception

Method Summary¶

public __construct( string $type )

Methods¶

Public · 1

`__construct()`¶

public function __construct( string $type );

Db\Exceptions\InvalidUnaryExpression¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidUnaryExpression

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidWhereConditions¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidWhereConditions

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\InvalidWkb¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\InvalidWkb

Uses Phalcon\Db\Exception

Method Summary¶

public __construct( string $reason )

Methods¶

Public · 1

`__construct()`¶

public function __construct( string $reason );

Db\Exceptions\MatchedParameterNotFound¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\MatchedParameterNotFound

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\MaterializedViewsNotSupported¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\MaterializedViewsNotSupported

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\MissingDefinitionKey¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\MissingDefinitionKey

Uses Phalcon\Db\Exception

Method Summary¶

public __construct( string $key )

Methods¶

Public · 1

`__construct()`¶

public function __construct( string $key );

Db\Exceptions\MissingForeignKeyChecks¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\MissingForeignKeyChecks

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\MissingSqliteDatabase¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\MissingSqliteDatabase

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\MysqlOnConflictNotSupported¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\MysqlOnConflictNotSupported

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\NestedTransactionChangeBlocked¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\NestedTransactionChangeBlocked

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\NoActiveTransaction¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\NoActiveTransaction

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\ReferencedColumnCountMismatch¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\ReferencedColumnCountMismatch

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\ReferencedColumnsRequired¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\ReferencedColumnsRequired

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\ReferencedTableRequired¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\ReferencedTableRequired

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\ReturningNotSupported¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\ReturningNotSupported

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\ReturningRequiresColumn¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\ReturningRequiresColumn

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\SavepointsNotSupported¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\SavepointsNotSupported

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\SqliteAlterCheckNotSupported¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\SqliteAlterCheckNotSupported

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\SqliteAlterColumnNotSupported¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\SqliteAlterColumnNotSupported

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\SqliteAlterForeignKeyNotSupported¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\SqliteAlterForeignKeyNotSupported

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\SqliteAlterPrimaryKeyNotSupported¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\SqliteAlterPrimaryKeyNotSupported

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\SqliteDropCheckNotSupported¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\SqliteDropCheckNotSupported

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\SqliteDropForeignKeyNotSupported¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\SqliteDropForeignKeyNotSupported

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\SqliteDropPrimaryKeyNotSupported¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\SqliteDropPrimaryKeyNotSupported

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\TableMustHaveColumn¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\TableMustHaveColumn

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Exceptions\UnrecognizedDataType¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\UnrecognizedDataType

Uses Phalcon\Db\Exception

Method Summary¶

public __construct(string $dialect,string $column)

Methods¶

Public · 1

`__construct()`¶

public function __construct(
    string $dialect,
    string $column
);

Db\Exceptions\UnsupportedOperator¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\UnsupportedOperator

Uses Phalcon\Db\Exception

Method Summary¶

public __construct( string $operator )

Methods¶

Public · 1

`__construct()`¶

public function __construct( string $operator );

Db\Exceptions\UpdateFieldCountMismatch¶

Class Source on GitHub

\Exception
- Phalcon\Db\Exception
  - Phalcon\Db\Exceptions\UpdateFieldCountMismatch

Uses Phalcon\Db\Exception

Method Summary¶

public __construct()

Methods¶

Public · 1

`__construct()`¶

public function __construct();

Db\Geometry\AbstractGeometry¶

Abstract Source on GitHub

Phalcon\Db\Geometry\AbstractGeometry - implements Phalcon\Db\Geometry\GeometryInterface

Method Summary¶

public string __toString() public int getSrid() public int getType() public string toWkt()

Properties¶

protected int $srid = 0

Methods¶

Public · 4

`__toString()`¶

public function __toString(): string;

`getSrid()`¶

public function getSrid(): int;

`getType()`¶

abstract public function getType(): int;

`toWkt()`¶

abstract public function toWkt(): string;

Db\Geometry\GeometryCollection¶

Class Source on GitHub

Phalcon\Db\Geometry\AbstractGeometry
- Phalcon\Db\Geometry\GeometryCollection

Uses Phalcon\Db\Column

Method Summary¶

public __construct(array $geometries,int $srid = 0) public array getGeometries() public int getType() public string toWkt()

Properties¶

protected GeometryInterface[] $geometries

Methods¶

Public · 4

`__construct()`¶

public function __construct(
    array $geometries,
    int $srid = 0
);

`getGeometries()`¶

public function getGeometries(): array;

`getType()`¶

public function getType(): int;

`toWkt()`¶

public function toWkt(): string;

Db\Geometry\GeometryInterface¶

Interface Source on GitHub

Phalcon\Db\Geometry\GeometryInterface

Phalcon\Contracts\Db\Geometry\Geometry
- Phalcon\Db\Geometry\GeometryInterface

Uses Phalcon\Contracts\Db\Geometry\Geometry

Db\Geometry\LineString¶

Class Source on GitHub

Phalcon\Db\Geometry\AbstractGeometry
- Phalcon\Db\Geometry\LineString

Uses Phalcon\Db\Column

Method Summary¶

public __construct(array $points,int $srid = 0) public array getPoints() public int getType() public string pointsWkt() public string toWkt()

Properties¶

protected Point[] $points

Methods¶

Public · 5

`__construct()`¶

public function __construct(
    array $points,
    int $srid = 0
);

`getPoints()`¶

public function getPoints(): array;

`getType()`¶

public function getType(): int;

`pointsWkt()`¶

public function pointsWkt(): string;

`toWkt()`¶

public function toWkt(): string;

Db\Geometry\MultiLineString¶

Class Source on GitHub

Phalcon\Db\Geometry\AbstractGeometry
- Phalcon\Db\Geometry\MultiLineString

Uses Phalcon\Db\Column

Method Summary¶

public __construct(array $lineStrings,int $srid = 0) public array getLineStrings() public int getType() public string toWkt()

Properties¶

protected LineString[] $lineStrings

Methods¶

Public · 4

`__construct()`¶

public function __construct(
    array $lineStrings,
    int $srid = 0
);

`getLineStrings()`¶

public function getLineStrings(): array;

`getType()`¶

public function getType(): int;

`toWkt()`¶

public function toWkt(): string;

Db\Geometry\MultiPoint¶

Class Source on GitHub

Phalcon\Db\Geometry\AbstractGeometry
- Phalcon\Db\Geometry\MultiPoint

Uses Phalcon\Db\Column

Method Summary¶

public __construct(array $points,int $srid = 0) public array getPoints() public int getType() public string toWkt()

Properties¶

protected Point[] $points

Methods¶

Public · 4

`__construct()`¶

public function __construct(
    array $points,
    int $srid = 0
);

`getPoints()`¶

public function getPoints(): array;

`getType()`¶

public function getType(): int;

`toWkt()`¶

public function toWkt(): string;

Db\Geometry\MultiPolygon¶

Class Source on GitHub

Phalcon\Db\Geometry\AbstractGeometry
- Phalcon\Db\Geometry\MultiPolygon

Uses Phalcon\Db\Column

Method Summary¶

public __construct(array $polygons,int $srid = 0) public array getPolygons() public int getType() public string toWkt()

Properties¶

protected Polygon[] $polygons

Methods¶

Public · 4

`__construct()`¶

public function __construct(
    array $polygons,
    int $srid = 0
);

`getPolygons()`¶

public function getPolygons(): array;

`getType()`¶

public function getType(): int;

`toWkt()`¶

public function toWkt(): string;

Db\Geometry\Point¶

Class Source on GitHub

Phalcon\Db\Geometry\AbstractGeometry
- Phalcon\Db\Geometry\Point

Uses Phalcon\Db\Column

Method Summary¶

public __construct(float $x,float $y,int $srid = 0) public string coordsWkt() public int getType() public float getX() public float getY() public string toWkt()

Properties¶

protected float $x

protected float $y

Methods¶

Public · 6

`__construct()`¶

public function __construct(
    float $x,
    float $y,
    int $srid = 0
);

`coordsWkt()`¶

public function coordsWkt(): string;

`getType()`¶

public function getType(): int;

`getX()`¶

public function getX(): float;

`getY()`¶

public function getY(): float;

`toWkt()`¶

public function toWkt(): string;

Db\Geometry\Polygon¶

Class Source on GitHub

Phalcon\Db\Geometry\AbstractGeometry
- Phalcon\Db\Geometry\Polygon

Uses Phalcon\Db\Column

Method Summary¶

public __construct(array $rings,int $srid = 0) public array getRings() public int getType() public string ringsWkt() public string toWkt()

Properties¶

protected Point[][] $rings

Methods¶

Public · 5

`__construct()`¶

public function __construct(
    array $rings,
    int $srid = 0
);

`getRings()`¶

public function getRings(): array;

`getType()`¶

public function getType(): int;

`ringsWkt()`¶

public function ringsWkt(): string;

`toWkt()`¶

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¶

public GeometryInterface parse( string $raw ) protected int readByte() protected float readDouble( bool $little ) protected GeometryInterface readGeometry( int $outerSrid ) protected Point readPoint(bool $little,bool $hasZ,bool $hasM,int $srid) protected array readPointList(bool $little,bool $hasZ,bool $hasM) protected array readRingList(bool $little,bool $hasZ,bool $hasM) protected int readUint32( bool $little ) protected void skipExtraOrdinates(bool $little,bool $hasZ,bool $hasM)

Properties¶

protected string $buffer = ""

protected int $length = 0

protected int $position = 0

Methods¶

Public · 1

`parse()`¶

public function parse( string $raw ): GeometryInterface;

Protected · 8

`readByte()`¶

protected function readByte(): int;

`readDouble()`¶

protected function readDouble( bool $little ): float;

`readGeometry()`¶

protected function readGeometry( int $outerSrid ): GeometryInterface;

`readPoint()`¶

protected function readPoint(
    bool $little,
    bool $hasZ,
    bool $hasM,
    int $srid
): Point;

`readPointList()`¶

protected function readPointList(
    bool $little,
    bool $hasZ,
    bool $hasM
): array;

`readRingList()`¶

protected function readRingList(
    bool $little,
    bool $hasZ,
    bool $hasM
): array;

`readUint32()`¶

protected function readUint32( bool $little ): int;

`skipExtraOrdinates()`¶

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+), directions, where, and concurrently.

// 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,
        'directions' => ['DESC'],
    ]
);

Phalcon\Db\Index - implements Phalcon\Db\IndexInterface

Uses Phalcon\Db\Exceptions\InvalidIndexColumns · Phalcon\Db\Exceptions\InvalidIndexDirections · Phalcon\Db\Exceptions\InvalidIndexWhere

Method Summary¶

public __construct(string $name,array $columnsOrDefinition,string $type = "") Phalcon\Db\Index constructor. public array getColumns() Index columns public array getDirections() Returns the per-column sort directions array (ASC / DESC). public string getName() Index name public string getType() Index type public string getWhere() Returns the partial-index WHERE predicate, or an empty string when public bool isConcurrent() Whether the index is built CONCURRENTLY (PostgreSQL only). public bool isInvisible() Whether the index is declared INVISIBLE (MySQL 8.0+).

Properties¶

protected array $columns Index columns. Entries may be plain strings (column names) or Phalcon\Db\RawValue instances (functional/expression index entries).

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. MySQL and SQLite 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.

protected bool $invisible = false Whether the index is declared INVISIBLE (MySQL 8.0+).

protected string $name

protected string $type = ""

protected string $where = "" Optional partial-index WHERE predicate. Supported by PostgreSQL and SQLite. Empty string means no predicate.

Methods¶

Public · 8

`__construct()`¶

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()`¶

public function getColumns(): array;

Index columns

`getDirections()`¶

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.

`getName()`¶

public function getName(): string;

Index name

`getType()`¶

public function getType(): string;

Index type

`getWhere()`¶

public function getWhere(): string;

Returns the partial-index WHERE predicate, or an empty string when the index has none.

`isConcurrent()`¶

public function isConcurrent(): bool;

Whether the index is built CONCURRENTLY (PostgreSQL only).

`isInvisible()`¶

public function isInvisible(): bool;

Whether the index is declared INVISIBLE (MySQL 8.0+).

Db\IndexInterface¶

Interface Source on GitHub

Phalcon\Db\IndexInterface

Phalcon\Contracts\Db\Index
- 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.

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¶

public Item|null getLastProfile() Returns the last profile executed in the profiler public int getMaxProfiles() Returns the configured maximum number of retained profiles public int getNumberTotalStatements() Returns the total number of SQL statements processed public array getProfiles() Returns all the processed profiles public float getTotalElapsedNanoseconds() Returns the total time in nanoseconds spent by the profiles public static reset() Resets the profiler, cleaning up all the profiles public static setMaxProfiles( int $maxProfiles ) Sets the maximum number of retained profiles. 0 disables the cap public static startProfile(string $sqlStatement,array $sqlVariables = [],array $sqlBindTypes = []) Starts the profile of a SQL sentence public static stopProfile() Stops the active profile

Properties¶

protected Item|null $activeProfile = null 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()`¶

public function getLastProfile(): Item|null;

Returns the last profile executed in the profiler

`getMaxProfiles()`¶

public function getMaxProfiles(): int;

Returns the configured maximum number of retained profiles (0 = unlimited)

`getNumberTotalStatements()`¶

public function getNumberTotalStatements(): int;

Returns the total number of SQL statements processed

`getProfiles()`¶

public function getProfiles(): array;

Returns all the processed profiles

`getTotalElapsedNanoseconds()`¶

public function getTotalElapsedNanoseconds(): float;

Returns the total time in nanoseconds spent by the profiles

`reset()`¶

public function reset(): static;

Resets the profiler, cleaning up all the profiles

`setMaxProfiles()`¶

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()`¶

public function startProfile(
    string $sqlStatement,
    array $sqlVariables = [],
    array $sqlBindTypes = []
): static;

Starts the profile of a SQL sentence

`stopProfile()`¶

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¶

public float getFinalTime() Return the timestamp when the profile ended public float getInitialTime() Return the timestamp when the profile started public array getSqlBindTypes() Return the SQL bind types related to the profile public string getSqlStatement() Return the SQL statement related to the profile public array getSqlVariables() Return the SQL variables related to the profile public float getTotalElapsedNanoseconds() Returns the total time in nanoseconds spent by the profile public static setFinalTime( float $finalTime ) Return the timestamp when the profile ended public static setInitialTime( float $initialTime ) Return the timestamp when the profile started public static setSqlBindTypes( array $sqlBindTypes ) Return the SQL bind types related to the profile public static setSqlStatement( string $sqlStatement ) Return the SQL statement related to the profile public static setSqlVariables( array $sqlVariables ) Return the SQL variables related to the profile

Properties¶

protected float $finalTime Timestamp when the profile ended

protected float $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()`¶

public function getFinalTime(): float;

Return the timestamp when the profile ended

`getInitialTime()`¶

public function getInitialTime(): float;

Return the timestamp when the profile started

`getSqlBindTypes()`¶

public function getSqlBindTypes(): array;

Return the SQL bind types related to the profile

`getSqlStatement()`¶

public function getSqlStatement(): string;

Return the SQL statement related to the profile

`getSqlVariables()`¶

public function getSqlVariables(): array;

Return the SQL variables related to the profile

`getTotalElapsedNanoseconds()`¶

public function getTotalElapsedNanoseconds(): float;

Returns the total time in nanoseconds spent by the profile

`setFinalTime()`¶

public function setFinalTime( float $finalTime ): static;

Return the timestamp when the profile ended

`setInitialTime()`¶

public function setInitialTime( float $initialTime ): static;

Return the timestamp when the profile started

`setSqlBindTypes()`¶

public function setSqlBindTypes( array $sqlBindTypes ): static;

Return the SQL bind types related to the profile

`setSqlStatement()`¶

public function setSqlStatement( string $sqlStatement ): static;

Return the SQL statement related to the profile

`setSqlVariables()`¶

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.

$subscriber = new Subscribers();

$subscriber->email     = "[email protected]";
$subscriber->createdAt = new \Phalcon\Db\RawValue("now()");

$subscriber->save();

Phalcon\Db\RawValue

Method Summary¶

public __construct( mixed $value = null ) Phalcon\Db\RawValue constructor public string __toString() public string getValue()

Properties¶

protected string $value Raw value without quoting or formatting

Methods¶

Public · 3

`__construct()`¶

public function __construct( mixed $value = null );

Phalcon\Db\RawValue constructor

`__toString()`¶

public function __toString(): string;

`getValue()`¶

public function getValue(): string;

Db\Reference¶

Class Source on GitHub

Allows to define reference constraints on tables

$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

Uses Phalcon\Db\Exceptions\ForeignKeyColumnsRequired · Phalcon\Db\Exceptions\ReferencedColumnCountMismatch · Phalcon\Db\Exceptions\ReferencedColumnsRequired · Phalcon\Db\Exceptions\ReferencedTableRequired

Method Summary¶

public __construct(string $name,array $definition) Phalcon\Db\Reference constructor public array getColumns() Local reference columns public string getName() Constraint name public string|null getOnDelete() ON DELETE public string|null getOnUpdate() ON UPDATE public array getReferencedColumns() Referenced Columns public string|null getReferencedSchema() Referenced Schema public string getReferencedTable() Referenced Table public string|null getSchemaName() Schema name

Properties¶

protected array $columns Local reference columns

protected string $name

protected string|null $onDelete = null ON DELETE

protected string|null $onUpdate = null ON UPDATE

protected array $referencedColumns Referenced Columns

protected string|null $referencedSchema = null Referenced Schema

protected string $referencedTable Referenced Table

protected string|null $schemaName = null Schema name

Methods¶

Public · 9

`__construct()`¶

public function __construct(
    string $name,
    array $definition
);

Phalcon\Db\Reference constructor

`getColumns()`¶

public function getColumns(): array;

Local reference columns

`getName()`¶

public function getName(): string;

Constraint name

`getOnDelete()`¶

public function getOnDelete(): string|null;

ON DELETE

`getOnUpdate()`¶

public function getOnUpdate(): string|null;

ON UPDATE

`getReferencedColumns()`¶

public function getReferencedColumns(): array;

Referenced Columns

`getReferencedSchema()`¶

public function getReferencedSchema(): string|null;

Referenced Schema

`getReferencedTable()`¶

public function getReferencedTable(): string;

Referenced Table

`getSchemaName()`¶

public function getSchemaName(): string|null;

Schema name

Db\ReferenceInterface¶

Interface Source on GitHub

Phalcon\Db\ReferenceInterface

Phalcon\Contracts\Db\Reference
- Phalcon\Db\ReferenceInterface

Uses Phalcon\Contracts\Db\Reference

Db\ResultInterface¶

Interface Source on GitHub

Phalcon\Db\ResultInterface

Phalcon\Contracts\Db\Result
- Phalcon\Db\ResultInterface

Uses Phalcon\Contracts\Db\Result

Db\Result\PdoResult¶

Class Source on GitHub

Encapsulates the resultset internals

$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

Uses PDOStatement · Phalcon\Db\Adapter\AdapterInterface · Phalcon\Db\Enum · Phalcon\Db\ResultInterface

Method Summary¶

public

__construct(AdapterInterface $connection,PDOStatement $pdoStatement,string $sqlStatement = "",array $bindParams = [],array $bindTypes = [])

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 mixed 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,array|null $constructorArgs = null) Returns an array of arrays containing all the records in the result public mixed 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,object|string|null $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

protected mixed $result

protected int|null $rowCount = null

protected string $sqlStatement = ""

Methods¶

Public · 9

`__construct()`¶

public function __construct(
    AdapterInterface $connection,
    PDOStatement $pdoStatement,
    string $sqlStatement = "",
    array $bindParams = [],
    array $bindTypes = []
);

Phalcon\Db\Result\Pdo constructor

`dataSeek()`¶

public function dataSeek( int $number ): void;

Moves internal resultset cursor to another position letting us to fetch a certain row

$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()`¶

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()`¶

public function fetch(
    int|null $fetchStyle = null,
    int $cursorOrientation = Enum::FETCH_ORI_NEXT,
    int $cursorOffset = 0
): mixed;

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()

$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()`¶

public function fetchAll(
    int $mode = Enum::FETCH_DEFAULT,
    mixed $fetchArgument = Enum::FETCH_ORI_NEXT,
    array|null $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()

$result = $connection->query(
    "SELECT * FROM co_invoices ORDER BY inv_title"
);

$invoices = $result->fetchAll();

`fetchArray()`¶

public function fetchArray(): mixed;

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()

$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()`¶

public function getInternalResult(): PDOStatement;

Gets the internal PDO result object

`numRows()`¶

public function numRows(): int;

Gets number of rows returned by a resultset

$result = $connection->query(
    "SELECT * FROM co_invoices ORDER BY inv_title"
);

echo "There are ", $result->numRows(), " rows in the resultset";

`setFetchMode()`¶

public function setFetchMode(
    int $fetchMode,
    object|string|null $colNoOrClassNameOrObject = null,
    mixed $ctorargs = null
): bool;

Changes the fetching mode affecting Phalcon\Db\Result\Pdo::fetch()

// 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 · Phalcon\Db\Profiler\Item

Method Summary¶

public float getTotalElapsedMilliseconds() Returns the total time in milliseconds spent by the profiles public float getTotalElapsedNanoseconds() Returns the total time in nanoseconds spent by the profiles. Implemented public float getTotalElapsedSeconds() Returns the total time in seconds spent by the profiles

Methods¶

Public · 3

`getTotalElapsedMilliseconds()`¶

public function getTotalElapsedMilliseconds(): float;

Returns the total time in milliseconds spent by the profiles

`getTotalElapsedNanoseconds()`¶

abstract public function getTotalElapsedNanoseconds(): float;

Returns the total time in nanoseconds spent by the profiles. Implemented by the using class.

`getTotalElapsedSeconds()`¶

public function getTotalElapsedSeconds(): float;

Returns the total time in seconds spent by the profiles

Phalcon db

Db\AbstractDb¶

Method Summary¶

Methods¶

setup()¶

Db\Adapter\AbstractAdapter¶

Method Summary¶

Properties¶

Methods¶

__construct()¶

addCheck()¶

addColumn()¶

addForeignKey()¶

addIndex()¶

addPrimaryKey()¶

createMaterializedView()¶

createSavepoint()¶

createTable()¶

createView()¶

delete()¶

describeIndexes()¶

describeReferences()¶

dropCheck()¶

dropColumn()¶

dropForeignKey()¶

dropIndex()¶

dropMaterializedView()¶

dropPrimaryKey()¶

dropTable()¶

dropView()¶

escapeIdentifier()¶

fetchAll()¶

fetchColumn()¶

fetchOne()¶

forUpdate()¶

getColumnDefinition()¶

getColumnList()¶

getConnectionId()¶

getDefaultIdValue()¶

getDefaultValue()¶

getDescriptor()¶

getDialect()¶

getDialectType()¶

getNestedTransactionSavepointName()¶

getRealSQLStatement()¶

getSQLBindTypes()¶

getSQLStatement()¶

getSQLVariables()¶

getType()¶

insert()¶

insertAsDict()¶

isNestedTransactionsWithSavepoints()¶

limit()¶

listTables()¶

listViews()¶

modifyColumn()¶

onConflictUpdate()¶

refreshMaterializedView()¶

releaseSavepoint()¶

returning()¶

rollbackSavepoint()¶

setDialect()¶

setNestedTransactionsWithSavepoints()¶

setup()¶

sharedLock()¶

supportSequences()¶

supportsDefaultValue()¶

tableExists()¶

tableOptions()¶

update()¶

updateAsDict()¶

useExplicitIdValue()¶

viewExists()¶

checkSavepoints()¶

Db\Adapter\AdapterInterface¶

Db\Adapter\PdoFactory¶

Method Summary¶

Methods¶

__construct()¶

load()¶

`setup()`¶

`__construct()`¶

`addCheck()`¶

`addColumn()`¶

`addForeignKey()`¶

`addIndex()`¶

`addPrimaryKey()`¶

`createMaterializedView()`¶

`createSavepoint()`¶

`createTable()`¶

`createView()`¶

`delete()`¶

`describeIndexes()`¶

`describeReferences()`¶

`dropCheck()`¶

`dropColumn()`¶

`dropForeignKey()`¶

`dropIndex()`¶

`dropMaterializedView()`¶

`dropPrimaryKey()`¶

`dropTable()`¶

`dropView()`¶

`escapeIdentifier()`¶

`fetchAll()`¶

`fetchColumn()`¶

`fetchOne()`¶

`forUpdate()`¶

`getColumnDefinition()`¶

`getColumnList()`¶

`getConnectionId()`¶

`getDefaultIdValue()`¶

`getDefaultValue()`¶

`getDescriptor()`¶

`getDialect()`¶

`getDialectType()`¶

`getNestedTransactionSavepointName()`¶

`getRealSQLStatement()`¶

`getSQLBindTypes()`¶

`getSQLStatement()`¶

`getSQLVariables()`¶

`getType()`¶

`insert()`¶

`insertAsDict()`¶

`isNestedTransactionsWithSavepoints()`¶

`limit()`¶

`listTables()`¶

`listViews()`¶

`modifyColumn()`¶

`onConflictUpdate()`¶

`refreshMaterializedView()`¶

`releaseSavepoint()`¶

`returning()`¶

`rollbackSavepoint()`¶

`setDialect()`¶

`setNestedTransactionsWithSavepoints()`¶

`setup()`¶

`sharedLock()`¶

`supportSequences()`¶

`supportsDefaultValue()`¶

`tableExists()`¶

`tableOptions()`¶

`update()`¶

`updateAsDict()`¶

`useExplicitIdValue()`¶

`viewExists()`¶

`checkSavepoints()`¶

`__construct()`¶

`load()`¶

`newInstance()`¶

`getExceptionClass()`¶

`getServices()`¶

`__construct()`¶

`affectedRows()`¶

`begin()`¶

`close()`¶

`commit()`¶

`connect()`¶

`convertBoundParams()`¶

`ensureConnection()`¶

`escapeString()`¶