164 lines
4.3 KiB
PHP
164 lines
4.3 KiB
PHP
<?php
|
|
|
|
/**
|
|
* This file is part of CodeIgniter 4 framework.
|
|
*
|
|
* (c) CodeIgniter Foundation <admin@codeigniter.com>
|
|
*
|
|
* For the full copyright and license information, please view
|
|
* the LICENSE file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace CodeIgniter\Database;
|
|
|
|
/**
|
|
* @template TConnection
|
|
* @template TResult
|
|
*/
|
|
interface ConnectionInterface
|
|
{
|
|
/**
|
|
* Initializes the database connection/settings.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function initialize();
|
|
|
|
/**
|
|
* Connect to the database.
|
|
*
|
|
* @return false|object|resource
|
|
* @phpstan-return false|TConnection
|
|
*/
|
|
public function connect(bool $persistent = false);
|
|
|
|
/**
|
|
* Create a persistent database connection.
|
|
*
|
|
* @return false|object|resource
|
|
* @phpstan-return false|TConnection
|
|
*/
|
|
public function persistentConnect();
|
|
|
|
/**
|
|
* Keep or establish the connection if no queries have been sent for
|
|
* a length of time exceeding the server's idle timeout.
|
|
*
|
|
* @return void
|
|
*/
|
|
public function reconnect();
|
|
|
|
/**
|
|
* Returns the actual connection object. If both a 'read' and 'write'
|
|
* connection has been specified, you can pass either term in to
|
|
* get that connection. If you pass either alias in and only a single
|
|
* connection is present, it must return the sole connection.
|
|
*
|
|
* @return false|object|resource
|
|
* @phpstan-return false|TConnection
|
|
*/
|
|
public function getConnection(?string $alias = null);
|
|
|
|
/**
|
|
* Select a specific database table to use.
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function setDatabase(string $databaseName);
|
|
|
|
/**
|
|
* Returns the name of the current database being used.
|
|
*/
|
|
public function getDatabase(): string;
|
|
|
|
/**
|
|
* Returns the last error encountered by this connection.
|
|
* Must return this format: ['code' => string|int, 'message' => string]
|
|
* intval(code) === 0 means "no error".
|
|
*
|
|
* @return array<string, int|string>
|
|
*/
|
|
public function error(): array;
|
|
|
|
/**
|
|
* The name of the platform in use (MySQLi, mssql, etc)
|
|
*/
|
|
public function getPlatform(): string;
|
|
|
|
/**
|
|
* Returns a string containing the version of the database being used.
|
|
*/
|
|
public function getVersion(): string;
|
|
|
|
/**
|
|
* Orchestrates a query against the database. Queries must use
|
|
* Database\Statement objects to store the query and build it.
|
|
* This method works with the cache.
|
|
*
|
|
* Should automatically handle different connections for read/write
|
|
* queries if needed.
|
|
*
|
|
* @param array|string|null $binds
|
|
*
|
|
* @return BaseResult|bool|Query
|
|
* @phpstan-return BaseResult<TConnection, TResult>|bool|Query
|
|
*/
|
|
public function query(string $sql, $binds = null);
|
|
|
|
/**
|
|
* Performs a basic query against the database. No binding or caching
|
|
* is performed, nor are transactions handled. Simply takes a raw
|
|
* query string and returns the database-specific result id.
|
|
*
|
|
* @return false|object|resource
|
|
* @phpstan-return false|TResult
|
|
*/
|
|
public function simpleQuery(string $sql);
|
|
|
|
/**
|
|
* Returns an instance of the query builder for this connection.
|
|
*
|
|
* @param array|string $tableName Table name.
|
|
*
|
|
* @return BaseBuilder Builder.
|
|
*/
|
|
public function table($tableName);
|
|
|
|
/**
|
|
* Returns the last query's statement object.
|
|
*
|
|
* @return Query
|
|
*/
|
|
public function getLastQuery();
|
|
|
|
/**
|
|
* "Smart" Escaping
|
|
*
|
|
* Escapes data based on type.
|
|
* Sets boolean and null types.
|
|
*
|
|
* @param array|bool|float|int|object|string|null $str
|
|
*
|
|
* @return array|float|int|string
|
|
* @phpstan-return ($str is array ? array : float|int|string)
|
|
*/
|
|
public function escape($str);
|
|
|
|
/**
|
|
* Allows for custom calls to the database engine that are not
|
|
* supported through our database layer.
|
|
*
|
|
* @param array ...$params
|
|
*
|
|
* @return array|bool|float|int|object|resource|string|null
|
|
*/
|
|
public function callFunction(string $functionName, ...$params);
|
|
|
|
/**
|
|
* Determines if the statement is a write-type query or not.
|
|
*
|
|
* @param string $sql
|
|
*/
|
|
public function isWriteType($sql): bool;
|
|
}
|