Source of file DriverInterface.php
Size: 6,266 Bytes - Last Modified: 2020-04-23T17:38:36-04:00
src/Drivers/DriverInterface.php
| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286 | <?php declare(strict_types=1); /** * Query * * SQL Query Builder / Database Abstraction Layer * * PHP version 7.4 * * @package Query * @author Timothy J. Warren <tim@timshomepage.net> * @copyright 2012 - 2020 Timothy J. Warren * @license http://www.opensource.org/licenses/mit-license.html MIT License * @link https://git.timshomepage.net/aviat/Query * @version 3.0.0 */namespace Query\Drivers; use InvalidArgumentException; use PDO; use PDOStatement; /** * PDO Interface to implement for database drivers * * @method beginTransaction(): bool * @method commit(): bool * @method errorCode(): string * @method errorInfo(): array * @method exec(string $statement): int * @method getAttribute(int $attribute) * @method inTransaction(): bool * @method lastInsertId(string $name = NULL): string * @method prepare(string $statement, array $driver_options = []): PDOStatement * @method query(string $statement): PDOStatement * @method quote(string $string, int $parameter_type = PDO::PARAM_STR): string * @method rollback(): bool * @method setAttribute(int $attribute, $value): bool */interface DriverInterface /* extends the interface of PDO */ { /** * Constructor/Connection method * * @param string $dsn * @param string $username * @param string $password * @param array $driverOptions */public function __construct(string $dsn, string $username=NULL, string $password=NULL, array $driverOptions = []); /** * Simplifies prepared statements for database queries * * @param string $sql * @param array $data * @return PDOStatement|null * @throws InvalidArgumentException */public function prepareQuery(string $sql, array $data): PDOStatement; /** * Retrieve column information for the current database table * * @param string $table * @return array */public function getColumns(string $table): ?array; /** * Retrieve list of data types for the database * * @return array */public function getTypes(): ?array; /** * Retrieve indexes for the table * * @param string $table * @return array */public function getIndexes(string $table): ?array; /** * Retrieve foreign keys for the table * * @param string $table * @return array */public function getFks(string $table): ?array; /** * Return list of tables for the current database * * @return array */public function getTables(): ?array; /** * Retrieves an array of non-user-created tables for * the connection/database * * @return array */public function getSystemTables(): ?array; /** * Return schemas for databases that list them. Returns * database list if schemas are databases for the current driver. * * @return array */public function getSchemas(): ?array; /** * Return list of dbs for the current connection, if possible * * @return array */public function getDbs(): ?array; /** * Return list of views for the current database * * @return array */public function getViews(): ?array; /** * Return list of sequences for the current database, if they exist * * @return array */public function getSequences(): ?array; /** * Return list of functions for the current database * * @return array */public function getFunctions(): ?array; /** * Return list of stored procedures for the current database * * @return array */public function getProcedures(): ?array; /** * Return list of triggers for the current database * * @return array */public function getTriggers(): ?array; /** * Surrounds the string with the databases identifier escape characters * * @param string|array $ident * @return string|array */public function quoteIdent($ident); /** * Quote database table name, and set prefix * * @param string $table * @return string */public function quoteTable(string $table): string; /** * Create and execute a prepared statement with the provided parameters * * @param string $sql * @param array $params * @return PDOStatement */public function prepareExecute(string $sql, array $params): PDOStatement; /** * Method to simplify retrieving db results for meta-data queries * * @param string|array|null $query * @param bool $filteredIndex * @return array */public function driverQuery($query, $filteredIndex=TRUE): ?array; /** * Returns number of rows affected by an INSERT, UPDATE, DELETE type query * * @return int */public function affectedRows(): int; /** * Return the number of rows returned for a SELECT query * @see http://us3.php.net/manual/en/pdostatement.rowcount.php#87110 * * @return int */public function numRows(): ?int; /** * Prefixes a table if it is not already prefixed * * @param string $table * @return string */public function prefixTable(string $table): string; /** * Create sql for batch insert * * @param string $table * @param array $data * @return array */public function insertBatch(string $table, array $data=[]): array; /** * Creates a batch update, and executes it. * Returns the number of affected rows * * @param string $table * @param array $data * @param string $where * @return array */public function updateBatch(string $table, array $data, string $where): array; /** * Empty the passed table * * @param string $table * @return PDOStatement */public function truncate(string $table): PDOStatement; /** * Get the SQL class for the current driver * * @return SQLInterface */public function getSql(): SQLInterface; /** * Get the Util class for the current driver * * @return AbstractUtil */public function getUtil(): AbstractUtil; /** * Get the version of the database engine * * @return string */public function getVersion(): string; /** * Get the last sql query executed * * @return string */public function getLastQuery(): string; /** * Set the last query sql * * @param string $queryString * @return void */public function setLastQuery(string $queryString): void; /** * Set the common table name prefix * * @param string $prefix * @return void */public function setTablePrefix(string $prefix): void; } |