0 follower

Class yii\db\oci\Schema

Inheritanceyii\db\oci\Schema » yii\db\Schema » yii\base\BaseObject
Implementsyii\base\Configurable, yii\db\ConstraintFinderInterface
Uses Traitsyii\db\ConstraintFinderTrait
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/db/oci/Schema.php

Schema is the class for retrieving metadata from an Oracle database.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$columnSchemaClass string|array Column schema class or class config yii\db\Schema
$db yii\db\Connection The database connection yii\db\Schema
$defaultSchema string The default schema name used for the current session. yii\db\Schema
$exceptionMap array Map of DB errors and corresponding exceptions If left part is found in DB error message exception class from the right part is used. yii\db\oci\Schema
$lastInsertID string The row ID of the last row inserted, or the last value retrieved from the sequence object yii\db\oci\Schema
$queryBuilder yii\db\QueryBuilder The query builder for this connection. yii\db\Schema
$schemaChecks \yii\db\CheckConstraint[][] Check constraints for all tables in the database. yii\db\ConstraintFinderTrait
$schemaDefaultValues yii\db\DefaultValueConstraint[] Default value constraints for all tables in the database. yii\db\ConstraintFinderTrait
$schemaForeignKeys \yii\db\ForeignKeyConstraint[][] Foreign keys for all tables in the database. yii\db\ConstraintFinderTrait
$schemaIndexes \yii\db\IndexConstraint[][] Indexes for all tables in the database. yii\db\ConstraintFinderTrait
$schemaNames string[] All schema names in the database, except system schemas. yii\db\Schema
$schemaPrimaryKeys yii\db\Constraint[] Primary keys for all tables in the database. yii\db\ConstraintFinderTrait
$schemaUniques \yii\db\Constraint[][] Unique constraints for all tables in the database. yii\db\ConstraintFinderTrait
$serverVersion string Server version as a string. yii\db\Schema
$tableNames string[] All table names in the database. yii\db\Schema
$tableSchemas yii\db\TableSchema[] The metadata for all tables in the database. yii\db\Schema
$transactionIsolationLevel string The transaction isolation level to use for this transaction. yii\db\Schema

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$columnQuoteCharacter string|string[] Character used to quote column names. yii\db\Schema
$tableQuoteCharacter {@inheritdoc} yii\db\oci\Schema

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__call() Calls the named method which is not a class method. yii\base\BaseObject
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of an object property. yii\base\BaseObject
__isset() Checks if a property is set, i.e. defined and not null. yii\base\BaseObject
__set() Sets value of an object property. yii\base\BaseObject
__unset() Sets an object property to null. yii\base\BaseObject
canGetProperty() Returns a value indicating whether a property can be read. yii\base\BaseObject
canSetProperty() Returns a value indicating whether a property can be set. yii\base\BaseObject
className() Returns the fully qualified name of this class. yii\base\BaseObject
convertException() Converts a DB exception to a more concrete one if possible. yii\db\Schema
createColumnSchemaBuilder() {@inheritdoc} yii\db\oci\Schema
createQueryBuilder() {@inheritdoc} yii\db\oci\Schema
createSavepoint() Creates a new savepoint. yii\db\Schema
findUniqueIndexes() Returns all unique indexes for the given table. yii\db\oci\Schema
getLastInsertID() yii\db\oci\Schema
getPdoType() Determines the PDO type for the given PHP data value. yii\db\Schema
getQueryBuilder() yii\db\Schema
getRawTableName() Returns the actual name of a given table name. yii\db\Schema
getSchemaChecks() Returns check constraints for all tables in the database. yii\db\ConstraintFinderTrait
getSchemaDefaultValues() Returns default value constraints for all tables in the database. yii\db\ConstraintFinderTrait
getSchemaForeignKeys() Returns foreign keys for all tables in the database. yii\db\ConstraintFinderTrait
getSchemaIndexes() Returns indexes for all tables in the database. yii\db\ConstraintFinderTrait
getSchemaNames() Returns all schema names in the database, except system schemas. yii\db\Schema
getSchemaPrimaryKeys() Returns primary keys for all tables in the database. yii\db\ConstraintFinderTrait
getSchemaUniques() Returns unique constraints for all tables in the database. yii\db\ConstraintFinderTrait
getServerVersion() Returns a server version as a string comparable by \version_compare(). yii\db\Schema
getTableChecks() Obtains the check constraints information for the named table. yii\db\ConstraintFinderTrait
getTableDefaultValues() Obtains the default value constraints information for the named table. yii\db\ConstraintFinderTrait
getTableForeignKeys() Obtains the foreign keys information for the named table. yii\db\ConstraintFinderTrait
getTableIndexes() Obtains the indexes information for the named table. yii\db\ConstraintFinderTrait
getTableNames() Returns all table names in the database. yii\db\Schema
getTablePrimaryKey() Obtains the primary key for the named table. yii\db\ConstraintFinderTrait
getTableSchema() Obtains the metadata for the named table. yii\db\Schema
getTableSchemas() Returns the metadata for all tables in the database. yii\db\Schema
getTableUniques() Obtains the unique constraints information for the named table. yii\db\ConstraintFinderTrait
hasMethod() Returns a value indicating whether a method is defined. yii\base\BaseObject
hasProperty() Returns a value indicating whether a property is defined. yii\base\BaseObject
init() {@inheritdoc} yii\db\oci\Schema
insert() {@inheritdoc} yii\db\oci\Schema
isReadQuery() Returns a value indicating whether a SQL statement is for read purpose. yii\db\Schema
quoteColumnName() Quotes a column name for use in a query. yii\db\Schema
quoteSimpleColumnName() Quotes a simple column name for use in a query. yii\db\Schema
quoteSimpleTableName() {@inheritdoc} yii\db\oci\Schema
quoteTableName() Quotes a table name for use in a query. yii\db\Schema
quoteValue() Quotes a string value for use in a query. yii\db\Schema
refresh() Refreshes the schema. yii\db\Schema
refreshTableSchema() Refreshes the particular table schema. yii\db\Schema
releaseSavepoint() {@inheritdoc} yii\db\oci\Schema
rollBackSavepoint() Rolls back to a previously created savepoint. yii\db\Schema
setTransactionIsolationLevel() Sets the isolation level of the current transaction. yii\db\Schema
supportsSavepoint() yii\db\Schema
unquoteSimpleColumnName() Unquotes a simple column name. yii\db\Schema
unquoteSimpleTableName() Unquotes a simple table name. yii\db\Schema

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
createColumn() Creates ColumnSchema instance. yii\db\oci\Schema
createColumnSchema() Creates a column schema for the database. yii\db\Schema
extractColumnSize() Extracts size, precision and scale information from column's DB type. yii\db\oci\Schema
extractColumnType() Extracts the data types for the given column. yii\db\oci\Schema
findColumns() Collects the table column metadata. yii\db\oci\Schema
findConstraints() Finds constraints and fills them into TableSchema object passed. yii\db\oci\Schema
findSchemaNames() {@inheritdoc} yii\db\oci\Schema
findTableNames() {@inheritdoc} yii\db\oci\Schema
getCacheKey() Returns the cache key for the specified table name. yii\db\Schema
getCacheTag() Returns the cache tag name. yii\db\Schema
getColumnPhpType() Extracts the PHP type from abstract DB type. yii\db\Schema
getSchemaMetadata() Returns the metadata of the given type for all tables in the given schema. yii\db\ConstraintFinderTrait
getTableMetadata() Returns the metadata of the given type for the given table. yii\db\ConstraintFinderTrait
getTableSequenceName() Sequence name of table. yii\db\oci\Schema
loadTableChecks() {@inheritdoc} yii\db\oci\Schema
loadTableDefaultValues() {@inheritdoc} yii\db\oci\Schema
loadTableForeignKeys() {@inheritdoc} yii\db\oci\Schema
loadTableIndexes() {@inheritdoc} yii\db\oci\Schema
loadTablePrimaryKey() {@inheritdoc} yii\db\oci\Schema
loadTableSchema() {@inheritdoc} yii\db\oci\Schema
loadTableUniques() {@inheritdoc} yii\db\oci\Schema
normalizePdoRowKeyCase() Changes row's array key case to lower if PDO's one is set to uppercase. yii\db\Schema
resolveTableName() {@inheritdoc} yii\db\oci\Schema
resolveTableNames() Resolves the table name and schema name (if any). yii\db\oci\Schema
setTableMetadata() Sets the metadata of the given type for the given table. yii\db\Schema

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
SCHEMA_CACHE_VERSION 1 Schema cache version, to detect incompatibilities in cached values when the data format of the cache changes. yii\db\Schema
TYPE_BIGINT 'bigint' yii\db\Schema
TYPE_BIGPK 'bigpk' yii\db\Schema
TYPE_BINARY 'binary' yii\db\Schema
TYPE_BOOLEAN 'boolean' yii\db\Schema
TYPE_CHAR 'char' yii\db\Schema
TYPE_DATE 'date' yii\db\Schema
TYPE_DATETIME 'datetime' yii\db\Schema
TYPE_DECIMAL 'decimal' yii\db\Schema
TYPE_DOUBLE 'double' yii\db\Schema
TYPE_FLOAT 'float' yii\db\Schema
TYPE_INTEGER 'integer' yii\db\Schema
TYPE_JSON 'json' yii\db\Schema
TYPE_MONEY 'money' yii\db\Schema
TYPE_PK 'pk' yii\db\Schema
TYPE_SMALLINT 'smallint' yii\db\Schema
TYPE_STRING 'string' yii\db\Schema
TYPE_TEXT 'text' yii\db\Schema
TYPE_TIME 'time' yii\db\Schema
TYPE_TIMESTAMP 'timestamp' yii\db\Schema
TYPE_TINYINT 'tinyint' yii\db\Schema
TYPE_UBIGPK 'ubigpk' yii\db\Schema
TYPE_UPK 'upk' yii\db\Schema

Property Details

$exceptionMap public property

Map of DB errors and corresponding exceptions If left part is found in DB error message exception class from the right part is used.

public array $exceptionMap = ['ORA-00001: unique constraint' => 'yii\db\IntegrityException']
$lastInsertID public read-only property

The row ID of the last row inserted, or the last value retrieved from the sequence object

public string getLastInsertID ( $sequenceName '' )
$tableQuoteCharacter protected property
protected $tableQuoteCharacter '"'

Method Details

createColumn() protected method

Creates ColumnSchema instance.

protected yii\db\ColumnSchema createColumn ( $column )
$column array
createColumnSchemaBuilder() public method

{@inheritdoc}

public void createColumnSchemaBuilder ( $type, $length null )
$type
$length
createQueryBuilder() public method

{@inheritdoc}

public void createQueryBuilder ( )
extractColumnSize() protected method

Extracts size, precision and scale information from column's DB type.

protected void extractColumnSize ( $column, $dbType, $precision, $scale, $length )
$column yii\db\ColumnSchema
$dbType string

The column's DB type

$precision string

Total number of digits. This parameter is available since version 2.0.4.

$scale string

Number of digits on the right of the decimal separator. This parameter is available since version 2.0.4.

$length string

Length for character types. This parameter is available since version 2.0.4.

extractColumnType() protected method

Extracts the data types for the given column.

protected void extractColumnType ( $column, $dbType, $precision, $scale, $length )
$column yii\db\ColumnSchema
$dbType string

DB type

$precision string

Total number of digits. This parameter is available since version 2.0.4.

$scale string

Number of digits on the right of the decimal separator. This parameter is available since version 2.0.4.

$length string

Length for character types. This parameter is available since version 2.0.4.

findColumns() protected method

Collects the table column metadata.

protected boolean findColumns ( $table )
$table yii\db\TableSchema

The table schema

return boolean

Whether the table exists

findConstraints() protected method

Finds constraints and fills them into TableSchema object passed.

protected void findConstraints ( $table )
$table yii\db\TableSchema
findSchemaNames() protected method
protected void findSchemaNames ( )
findTableNames() protected method

{@inheritdoc}

protected void findTableNames ( $schema '' )
$schema
findUniqueIndexes() public method (available since version 2.0.4)

Returns all unique indexes for the given table.

Each array element is of the following structure:.

[
    'IndexName1' => ['col1' [, ...]],
    'IndexName2' => ['col2' [, ...]],
]
public array findUniqueIndexes ( $table )
$table yii\db\TableSchema

The table metadata

return array

All unique indexes for the given table.

getLastInsertID() public method

See also http://www.php.net/manual/en/function.PDO-lastInsertId.php -> Oracle does not support this Returns the ID of the last inserted row or sequence value.

public string getLastInsertID ( $sequenceName '' )
$sequenceName string

Name of the sequence object (required by some DBMS)

return string

The row ID of the last row inserted, or the last value retrieved from the sequence object

throws yii\base\InvalidCallException

if the DB connection is not active

getTableSequenceName() protected method

Sequence name of table.

protected string|null getTableSequenceName ( $tableName )
$tableName string
return string|null

Whether the sequence exists

init() public method

{@inheritdoc}

public void init ( )
insert() public method

{@inheritdoc}

public void insert ( $table, $columns )
$table
$columns
loadTableChecks() protected method

{@inheritdoc}

protected void loadTableChecks ( $tableName )
$tableName
loadTableDefaultValues() protected method

{@inheritdoc}

protected void loadTableDefaultValues ( $tableName )
$tableName
throws yii\base\NotSupportedException

if this method is called.

loadTableForeignKeys() protected method

{@inheritdoc}

protected void loadTableForeignKeys ( $tableName )
$tableName
loadTableIndexes() protected method

{@inheritdoc}

protected void loadTableIndexes ( $tableName )
$tableName
loadTablePrimaryKey() protected method

{@inheritdoc}

protected void loadTablePrimaryKey ( $tableName )
$tableName
loadTableSchema() protected method

{@inheritdoc}

protected void loadTableSchema ( $name )
$name
loadTableUniques() protected method

{@inheritdoc}

protected void loadTableUniques ( $tableName )
$tableName
quoteSimpleTableName() public method

{@inheritdoc}

public void quoteSimpleTableName ( $name )
$name
releaseSavepoint() public method

{@inheritdoc}

public void releaseSavepoint ( $name )
$name
resolveTableName() protected method

{@inheritdoc}

protected void resolveTableName ( $name )
$name
resolveTableNames() protected method

Resolves the table name and schema name (if any).

protected void resolveTableNames ( $table, $name )
$table yii\db\TableSchema

The table metadata object

$name string

The table name