PHP Класс lithium\data\source\database\adapter\PostgreSql

- Implements timezone support. - Implements schema/searchPath support. For more information on configuring the database connection, see the __construct() method.
См. также: lithium\data\source\database\adapter\PostgreSql::timezone()
См. также: lithium\data\source\database\adapter\PostgreSql::searchPath()
См. также: lithium\data\source\database\adapter\PostgreSql::__construct()
Наследование: extends lithium\data\source\Database
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_columns array PostgreSQL column type definitions.
$_constraints array Column contraints
$_metas array Column/table metas By default 'escape' is false and 'join' is ' '
$_quotes array Pair of opening and closing quote characters used for quoting identifiers in queries.

Открытые методы

Метод Описание
__construct ( array $config = [] ) : void Constructor. Constructs the PostgreSQL adapter and sets the default port to 5432.
alias ( $alias, $context )
conditions ( string $conditions, string $context, array $options = [] ) : string
connect ( ) : boolean Connects to the database by constructing DSN string and creating a PDO intance using the parent class. Will set specific options on the connection as provided (timezone, schema).
describe ( mixed $entity, array $fields = [], array $meta = [] ) : array Gets the column schema for a given PostgreSQL table.
enabled ( string $feature = null ) : boolean Check for required PHP extension, or supported database feature.
encoding ( $encoding = null ) : mixed Gets or sets the encoding for the connection.
error ( ) : array Retrieves database error message and error code.
searchPath ( $searchPath ) : mixed Gets or sets the search path for the connection.
sources ( string $model = null ) : array Returns the list of tables in the currently-connected database.
timezone ( $timezone = null ) : mixed Gets or sets the time zone for the connection
value ( mixed $value, array $schema = [] ) : mixed Converts a given value into the proper type based on a given schema definition.

Защищенные методы

Метод Описание
_buildColumn ( array $field ) : string Helper for Database::column().
_column ( string $real ) : array Converts database-layer column types to basic types.
_distinctExport ( object $query ) : array Helper method for PostgreSql::_queryExport() to export data for use in distinct query.
_execute ( string $sql, array $options = [] ) : Result Execute a given query.
_formatters ( ) Provide an associative array of Closures to be used as the "formatter" key inside of the Database::$_columns specification.
_insertId ( object $query ) : mixed Gets the last auto-generated ID from the query that inserted a new record.
_queryExport ( object $query ) : array Helper method for Database::read() to export query while handling additional joins when using relationships and limited result sets. Filters conditions on subsequent queries to just the ones applying to the relation.

Описание методов

__construct() публичный Метод

Constructor. Constructs the PostgreSQL adapter and sets the default port to 5432.
См. также: lithium\data\source\Database::__construct()
См. также: lithium\data\Source::__construct()
См. также: lithium\data\Connections::add()
public __construct ( array $config = [] ) : void
$config array The available configuration options are the following. Further options are inherited from the parent classes. Typically, these parameters are set in `Connections::add()`, when adding the adapter to the list of active connections. - `'host'` _string_: Defaults to `'localhost:5432'`. - `'schema'` _string_: The name of the database schema to use. Defaults to `'public'`. - `'timezone'` _string_: The timezone to use. Defaults to `'null'`
Результат void

_buildColumn() защищенный Метод

Helper for Database::column().
См. также: lithium\data\source\Database::column()
protected _buildColumn ( array $field ) : string
$field array A field array.
Результат string SQL column string.

_column() защищенный Метод

Converts database-layer column types to basic types.
protected _column ( string $real ) : array
$real string Real database-layer column type (i.e. `"varchar(255)"`)
Результат array Column type (i.e. "string") plus 'length' when appropriate.

_distinctExport() защищенный Метод

Helper method for PostgreSql::_queryExport() to export data for use in distinct query.
См. также: lithium\data\source\PostgreSql::_queryExport()
protected _distinctExport ( object $query ) : array
$query object The query object.
Результат array Returns an array with the fields as the first value and the orders as the second value.

_execute() защищенный Метод

Execute a given query.
См. также: lithium\data\source\Database::renderCommand()
protected _execute ( string $sql, array $options = [] ) : Result
$sql string The sql string to execute
$options array Available options:
Результат lithium\data\source\Result Returns a result object if the query was successful.

_formatters() защищенный Метод

Provide an associative array of Closures to be used as the "formatter" key inside of the Database::$_columns specification.
См. также: lithium\data\source\Database::_formatters()
protected _formatters ( )

_insertId() защищенный Метод

Gets the last auto-generated ID from the query that inserted a new record.
protected _insertId ( object $query ) : mixed
$query object The `Query` object associated with the query which generated
Результат mixed Returns the last inserted ID key for an auto-increment column or a column bound to a sequence.

_queryExport() защищенный Метод

Helper method for Database::read() to export query while handling additional joins when using relationships and limited result sets. Filters conditions on subsequent queries to just the ones applying to the relation.
См. также: lithium\data\source\Database::read()
protected _queryExport ( object $query ) : array
$query object The query object.
Результат array The exported query returned by reference.

alias() публичный Метод

public alias ( $alias, $context )

conditions() публичный Метод

public conditions ( string $conditions, string $context, array $options = [] ) : string
$conditions string
$context string
$options array
Результат string

connect() публичный Метод

Connects to the database by constructing DSN string and creating a PDO intance using the parent class. Will set specific options on the connection as provided (timezone, schema).
См. также: lithium\data\source\database\adapter\PostgreSql::timezone()
public connect ( ) : boolean
Результат boolean Returns `true` if a database connection could be established, otherwise `false`.

describe() публичный Метод

Gets the column schema for a given PostgreSQL table.
public describe ( mixed $entity, array $fields = [], array $meta = [] ) : array
$entity mixed Specifies the table name for which the schema should be returned, or the class name of the model object requesting the schema, in which case the model class will be queried for the correct table name.
$fields array Any schema data pre-defined by the model.
$meta array
Результат array Returns an associative array describing the given table's schema, where the array keys are the available fields, and the values are arrays describing each field, containing the following keys: - `'type'`: The field type name

enabled() публичный статический Метод

Check for required PHP extension, or supported database feature.
public static enabled ( string $feature = null ) : boolean
$feature string Test for support for a specific feature, i.e. `"transactions"` or `"arrays"`.
Результат boolean Returns `true` if the particular feature (or if PostgreSQL) support is enabled, otherwise `false`.

encoding() публичный Метод

Gets or sets the encoding for the connection.
public encoding ( $encoding = null ) : mixed
$encoding
Результат mixed If setting the encoding; returns true on success, else false. When getting, returns the encoding.

error() публичный Метод

Retrieves database error message and error code.
public error ( ) : array
Результат array

searchPath() публичный Метод

Gets or sets the search path for the connection.
public searchPath ( $searchPath ) : mixed
$searchPath
Результат mixed If setting the searchPath; returns ture on success, else false When getting, returns the searchPath

sources() публичный Метод

Returns the list of tables in the currently-connected database.
public sources ( string $model = null ) : array
$model string The fully-name-spaced class name of the model object making the request.
Результат array Returns an array of sources to which models can connect.

timezone() публичный Метод

Gets or sets the time zone for the connection
public timezone ( $timezone = null ) : mixed
$timezone
Результат mixed If setting the time zone; returns true on success, else false When getting, returns the time zone

value() публичный Метод

Converts a given value into the proper type based on a given schema definition.
См. также: lithium\data\source\Database::schema()
public value ( mixed $value, array $schema = [] ) : mixed
$value mixed The value to be converted. Arrays will be recursively converted.
$schema array Formatted array from `lithium\data\source\Database::schema()`
Результат mixed Value with converted type.

Описание свойств

$_columns защищенное свойство

PostgreSQL column type definitions.
protected array $_columns
Результат array

$_constraints защищенное свойство

Column contraints
protected array $_constraints
Результат array

$_metas защищенное свойство

Column/table metas By default 'escape' is false and 'join' is ' '
protected array $_metas
Результат array

$_quotes защищенное свойство

Pair of opening and closing quote characters used for quoting identifiers in queries.
protected array $_quotes
Результат array