RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://www.yiiframework.com/doc/api/2.0/yii-db-oci-schema below:

Schema, yii\db\oci\Schema | API Documentation for Yii 2.0

Class yii\db\oci\Schema

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

Property Details

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', ]

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

Character used to quote schema, table, etc. names. An array of 2 characters can be used in case starting and ending characters are different.

Method Details

Hide inherited methods

Defined in: yii\base\BaseObject::__call()

Calls the named method which is not a class method.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Source code

                public function __call($name, $params)
{
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

Initializes the object with the given configuration $config.
Call init().

If this method is overridden in a child class, it is recommended that

the last parameter of the constructor is a configuration array, like $config here.
call the parent implementation at the end of the constructor.

public void __construct ( $config = [] ) $config array

Name-value pairs that will be used to initialize the object properties

Source code

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

Defined in: yii\base\BaseObject::__get()

Returns the value of an object property.

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $object->property;.

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true ) $name string

The property name

$checkVars boolean

Whether to treat member variables as properties

return boolean

Whether the property can be written

Source code

                public function canSetProperty($name, $checkVars = true)
{
    return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}

Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Source code

                public static function className()
{
    return get_called_class();
}

Source code

                public function convertException(\Exception $e, $rawSql)
{
    if ($e instanceof Exception) {
        return $e;
    }
    $exceptionClass = '\yii\db\Exception';
    foreach ($this->exceptionMap as $error => $class) {
        if (strpos($e->getMessage(), $error) !== false) {
            $exceptionClass = $class;
        }
    }
    $message = $e->getMessage() . "\nThe SQL being executed was: $rawSql";
    $errorInfo = $e instanceof \PDOException ? $e->errorInfo : null;
    return new $exceptionClass($message, $errorInfo, $e->getCode(), $e);
}

Creates ColumnSchema instance.

Source code

                protected function createColumn($column)
{
    $c = $this->createColumnSchema();
    $c->name = $column['COLUMN_NAME'];
    $c->allowNull = $column['NULLABLE'] === 'Y';
    $c->comment = $column['COLUMN_COMMENT'] === null ? '' : $column['COLUMN_COMMENT'];
    $c->isPrimaryKey = false;
    $this->extractColumnType($c, $column['DATA_TYPE'], $column['DATA_PRECISION'], $column['DATA_SCALE'], $column['DATA_LENGTH']);
    $this->extractColumnSize($c, $column['DATA_TYPE'], $column['DATA_PRECISION'], $column['DATA_SCALE'], $column['DATA_LENGTH']);
    $c->phpType = $this->getColumnPhpType($c);
    if (!$c->isPrimaryKey) {
        if (stripos((string) $column['DATA_DEFAULT'], 'timestamp') !== false) {
            $c->defaultValue = null;
        } else {
            $defaultValue = (string) $column['DATA_DEFAULT'];
            if ($c->type === 'timestamp' && $defaultValue === 'CURRENT_TIMESTAMP') {
                $c->defaultValue = new Expression('CURRENT_TIMESTAMP');
            } else {
                if ($defaultValue !== null) {
                    if (
                        strlen($defaultValue) > 2
                        && strncmp($defaultValue, "'", 1) === 0
                        && substr($defaultValue, -1) === "'"
                    ) {
                        $defaultValue = substr($defaultValue, 1, -1);
                    } else {
                        $defaultValue = trim($defaultValue);
                    }
                }
                $c->defaultValue = $c->phpTypecast($defaultValue);
            }
        }
    }
    return $c;
}

Defined in: yii\db\Schema::createColumnSchema()

Creates a column schema for the database.

This method may be overridden by child classes to create a DBMS-specific column schema.

Source code

                protected function createColumnSchema()
{
    return Yii::createObject($this->columnSchemaClass);
}

Create a column schema builder instance giving the type and value precision.

This method may be overridden by child classes to create a DBMS-specific column schema builder.

Source code

                public function createColumnSchemaBuilder($type, $length = null)
{
    return Yii::createObject(ColumnSchemaBuilder::className(), [$type, $length]);
}

Creates a query builder for the database.

This method may be overridden by child classes to create a DBMS-specific query builder.

Source code

                public function createQueryBuilder()
{
    return Yii::createObject(QueryBuilder::className(), [$this->db]);
}

Source code

                public function createSavepoint($name)
{
    $this->db->createCommand("SAVEPOINT $name")->execute();
}

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.

Source code

                protected function extractColumnSize($column, $dbType, $precision, $scale, $length)
{
    $column->size = trim((string) $length) === '' ? null : (int) $length;
    $column->precision = trim((string) $precision) === '' ? null : (int) $precision;
    $column->scale = trim((string) $scale) === '' ? null : (int) $scale;
}

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.

Source code

                protected function extractColumnType($column, $dbType, $precision, $scale, $length)
{
    $column->dbType = $dbType;
    if (strpos($dbType, 'FLOAT') !== false || strpos($dbType, 'DOUBLE') !== false) {
        $column->type = 'double';
    } elseif (strpos($dbType, 'NUMBER') !== false) {
        if ($scale === null || $scale > 0) {
            $column->type = 'decimal';
        } else {
            $column->type = 'integer';
        }
    } elseif (strpos($dbType, 'INTEGER') !== false) {
        $column->type = 'integer';
    } elseif (strpos($dbType, 'BLOB') !== false) {
        $column->type = 'binary';
    } elseif (strpos($dbType, 'CLOB') !== false) {
        $column->type = 'text';
    } elseif (strpos($dbType, 'TIMESTAMP') !== false) {
        $column->type = 'timestamp';
    } else {
        $column->type = 'string';
    }
}

Collects the table column metadata.

Source code

                protected function findColumns($table)
{
    $sql = <<<'SQL'
CT
A.COLUMN_NAME,
A.DATA_TYPE,
A.DATA_PRECISION,
A.DATA_SCALE,
(
  CASE A.CHAR_USED WHEN 'C' THEN A.CHAR_LENGTH
    ELSE A.DATA_LENGTH
  END
) AS DATA_LENGTH,
A.NULLABLE,
A.DATA_DEFAULT,
COM.COMMENTS AS COLUMN_COMMENT
 ALL_TAB_COLUMNS A
INNER JOIN ALL_OBJECTS B ON B.OWNER = A.OWNER AND LTRIM(B.OBJECT_NAME) = LTRIM(A.TABLE_NAME)
LEFT JOIN ALL_COL_COMMENTS COM ON (A.OWNER = COM.OWNER AND A.TABLE_NAME = COM.TABLE_NAME AND A.COLUMN_NAME = COM.COLUMN_NAME)
E
A.OWNER = :schemaName
AND B.OBJECT_TYPE IN ('TABLE', 'VIEW', 'MATERIALIZED VIEW')
AND B.OBJECT_NAME = :tableName
R BY A.COLUMN_ID

    try {
        $columns = $this->db->createCommand($sql, [
            ':tableName' => $table->name,
            ':schemaName' => $table->schemaName,
        ])->queryAll();
    } catch (\Exception $e) {
        return false;
    }
    if (empty($columns)) {
        return false;
    }
    foreach ($columns as $column) {
        if ($this->db->slavePdo->getAttribute(\PDO::ATTR_CASE) === \PDO::CASE_LOWER) {
            $column = array_change_key_case($column, CASE_UPPER);
        }
        $c = $this->createColumn($column);
        $table->columns[$c->name] = $c;
    }
    return true;
}

Finds constraints and fills them into TableSchema object passed.

Source code

                protected function findConstraints($table)
{
    $sql = <<<'SQL'
CT

D.CONSTRAINT_NAME,
D.CONSTRAINT_TYPE,
C.COLUMN_NAME,
C.POSITION,
D.R_CONSTRAINT_NAME,
E.TABLE_NAME AS TABLE_REF,
F.COLUMN_NAME AS COLUMN_REF,
C.TABLE_NAME
 ALL_CONS_COLUMNS C
INNER JOIN ALL_CONSTRAINTS D ON D.OWNER = C.OWNER AND D.CONSTRAINT_NAME = C.CONSTRAINT_NAME
LEFT JOIN ALL_CONSTRAINTS E ON E.OWNER = D.R_OWNER AND E.CONSTRAINT_NAME = D.R_CONSTRAINT_NAME
LEFT JOIN ALL_CONS_COLUMNS F ON F.OWNER = E.OWNER AND F.CONSTRAINT_NAME = E.CONSTRAINT_NAME AND F.POSITION = C.POSITION
E
C.OWNER = :schemaName
AND C.TABLE_NAME = :tableName
R BY D.CONSTRAINT_NAME, C.POSITION

    $command = $this->db->createCommand($sql, [
        ':tableName' => $table->name,
        ':schemaName' => $table->schemaName,
    ]);
    $constraints = [];
    foreach ($command->queryAll() as $row) {
        if ($this->db->slavePdo->getAttribute(\PDO::ATTR_CASE) === \PDO::CASE_LOWER) {
            $row = array_change_key_case($row, CASE_UPPER);
        }
        if ($row['CONSTRAINT_TYPE'] === 'P') {
            $table->columns[$row['COLUMN_NAME']]->isPrimaryKey = true;
            $table->primaryKey[] = $row['COLUMN_NAME'];
            if (empty($table->sequenceName)) {
                $table->sequenceName = $this->getTableSequenceName($table->name);
            }
        }
        if ($row['CONSTRAINT_TYPE'] !== 'R') {
            
            
            continue;
        }
        $name = $row['CONSTRAINT_NAME'];
        if (!isset($constraints[$name])) {
            $constraints[$name] = [
                'tableName' => $row['TABLE_REF'],
                'columns' => [],
            ];
        }
        $constraints[$name]['columns'][$row['COLUMN_NAME']] = $row['COLUMN_REF'];
    }
    foreach ($constraints as $constraint) {
        $name = current(array_keys($constraint));
        $table->foreignKeys[$name] = array_merge([$constraint['tableName']], $constraint['columns']);
    }
}

Source code

                protected function findSchemaNames()
{
    static $sql = <<<'SQL'
CT "u"."USERNAME"
 "DBA_USERS" "u"
E "u"."DEFAULT_TABLESPACE" NOT IN ('SYSTEM', 'SYSAUX')
R BY "u"."USERNAME" ASC

    return $this->db->createCommand($sql)->queryColumn();
}

Returns all table names in the database.

This method should be overridden by child classes in order to support this feature because the default implementation simply throws an exception.

protected array findTableNames ( $schema = '' ) $schema string

The schema of the tables. Defaults to empty string, meaning the current or default schema.

return array

All table names in the database. The names have NO schema name prefix.

throws yii\base\NotSupportedException

if this method is not supported by the DBMS.

Source code

                protected function findTableNames($schema = '')
{
    if ($schema === '') {
        $sql = <<<'SQL'
CT
TABLE_NAME
 USER_TABLES
N ALL
CT
VIEW_NAME AS TABLE_NAME
 USER_VIEWS
N ALL
CT
MVIEW_NAME AS TABLE_NAME
 USER_MVIEWS
R BY TABLE_NAME

        $command = $this->db->createCommand($sql);
    } else {
        $sql = <<<'SQL'
CT
OBJECT_NAME AS TABLE_NAME
 ALL_OBJECTS
E
OBJECT_TYPE IN ('TABLE', 'VIEW', 'MATERIALIZED VIEW')
AND OWNER = :schema
R BY OBJECT_NAME

        $command = $this->db->createCommand($sql, [':schema' => $schema]);
    }
    $rows = $command->queryAll();
    $names = [];
    foreach ($rows as $row) {
        if ($this->db->slavePdo->getAttribute(\PDO::ATTR_CASE) === \PDO::CASE_LOWER) {
            $row = array_change_key_case($row, CASE_UPPER);
        }
        $names[] = $row['TABLE_NAME'];
    }
    return $names;
}

Returns all unique indexes for the given table.

Each array element is of the following structure:.

[
    'IndexName1' => ['col1' [, ...]],
    'IndexName2' => ['col2' [, ...]],
]

Source code

                public function findUniqueIndexes($table)
{
    $query = <<<'SQL'
CT
DIC.INDEX_NAME,
DIC.COLUMN_NAME
 ALL_INDEXES DI
INNER JOIN ALL_IND_COLUMNS DIC ON DI.TABLE_NAME = DIC.TABLE_NAME AND DI.INDEX_NAME = DIC.INDEX_NAME
E
DI.UNIQUENESS = 'UNIQUE'
AND DIC.TABLE_OWNER = :schemaName
AND DIC.TABLE_NAME = :tableName
R BY DIC.TABLE_NAME, DIC.INDEX_NAME, DIC.COLUMN_POSITION

    $result = [];
    $command = $this->db->createCommand($query, [
        ':tableName' => $table->name,
        ':schemaName' => $table->schemaName,
    ]);
    foreach ($command->queryAll() as $row) {
        $result[$row['INDEX_NAME']][] = $row['COLUMN_NAME'];
    }
    return $result;
}

protected mixed getCacheKey ( $name ) $name string

The table name.

return mixed

The cache key.

Source code

                protected function getCacheKey($name)
{
    return [
        __CLASS__,
        $this->db->dsn,
        $this->db->username,
        $this->getRawTableName($name),
    ];
}

Source code

                protected function getCacheTag()
{
    return md5(serialize([
        __CLASS__,
        $this->db->dsn,
        $this->db->username,
    ]));
}

Source code

                protected function getColumnPhpType($column)
{
    static $typeMap = [
        
        self::TYPE_TINYINT => 'integer',
        self::TYPE_SMALLINT => 'integer',
        self::TYPE_INTEGER => 'integer',
        self::TYPE_BIGINT => 'integer',
        self::TYPE_BOOLEAN => 'boolean',
        self::TYPE_FLOAT => 'double',
        self::TYPE_DOUBLE => 'double',
        self::TYPE_BINARY => 'resource',
        self::TYPE_JSON => 'array',
    ];
    if (isset($typeMap[$column->type])) {
        if ($column->type === 'bigint') {
            return PHP_INT_SIZE === 8 && !$column->unsigned ? 'integer' : 'string';
        } elseif ($column->type === 'integer') {
            return PHP_INT_SIZE === 4 && $column->unsigned ? 'string' : 'integer';
        }
        return $typeMap[$column->type];
    }
    return 'string';
}

Source code

                public function getLastInsertID($sequenceName = '')
{
    if ($this->db->isActive) {
        
        $sequenceName = $this->quoteSimpleTableName($sequenceName);
        return $this->db->useMaster(function (Connection $db) use ($sequenceName) {
            return $db->createCommand("SELECT {$sequenceName}.CURRVAL FROM DUAL")->queryScalar();
        });
    } else {
        throw new InvalidCallException('DB Connection is not active.');
    }
}

Source code

                public function getPdoType($data)
{
    static $typeMap = [
        
        'boolean' => \PDO::PARAM_BOOL,
        'integer' => \PDO::PARAM_INT,
        'string' => \PDO::PARAM_STR,
        'resource' => \PDO::PARAM_LOB,
        'NULL' => \PDO::PARAM_NULL,
    ];
    $type = gettype($data);
    return isset($typeMap[$type]) ? $typeMap[$type] : \PDO::PARAM_STR;
}

Source code

                public function getQueryBuilder()
{
    if ($this->_builder === null) {
        $this->_builder = $this->createQueryBuilder();
    }
    return $this->_builder;
}

Source code

                public function getRawTableName($name)
{
    if (strpos($name, '{{') !== false) {
        $name = preg_replace('/\\{\\{(.*?)\\}\\}/', '\1', $name);
        return str_replace('%', $this->db->tablePrefix, $name);
    }
    return $name;
}

public \yii\db\CheckConstraint[][] getSchemaChecks ( $schema = '', $refresh = false ) $schema string

The schema of the tables. Defaults to empty string, meaning the current or default schema name.

$refresh boolean

Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available.

return \yii\db\CheckConstraint[][]

Check constraints for all tables in the database. Each array element is an array of yii\db\CheckConstraint or its child classes.

Source code

                public function getSchemaChecks($schema = '', $refresh = false)
{
    return $this->getSchemaMetadata($schema, 'checks', $refresh);
}

Source code

                public function getSchemaDefaultValues($schema = '', $refresh = false)
{
    return $this->getSchemaMetadata($schema, 'defaultValues', $refresh);
}

public \yii\db\ForeignKeyConstraint[][] getSchemaForeignKeys ( $schema = '', $refresh = false ) $schema string

The schema of the tables. Defaults to empty string, meaning the current or default schema name.

$refresh boolean

Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available.

return \yii\db\ForeignKeyConstraint[][]

Foreign keys for all tables in the database. Each array element is an array of yii\db\ForeignKeyConstraint or its child classes.

Source code

                public function getSchemaForeignKeys($schema = '', $refresh = false)
{
    return $this->getSchemaMetadata($schema, 'foreignKeys', $refresh);
}

public \yii\db\IndexConstraint[][] getSchemaIndexes ( $schema = '', $refresh = false ) $schema string

The schema of the tables. Defaults to empty string, meaning the current or default schema name.

$refresh boolean

Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available.

return \yii\db\IndexConstraint[][]

Indexes for all tables in the database. Each array element is an array of yii\db\IndexConstraint or its child classes.

Source code

                public function getSchemaIndexes($schema = '', $refresh = false)
{
    return $this->getSchemaMetadata($schema, 'indexes', $refresh);
}

public string[] getSchemaNames ( $refresh = false ) $refresh boolean

Whether to fetch the latest available schema names. If this is false, schema names fetched previously (if available) will be returned.

return string[]

All schema names in the database, except system schemas.

Source code

                public function getSchemaNames($refresh = false)
{
    if ($this->_schemaNames === null || $refresh) {
        $this->_schemaNames = $this->findSchemaNames();
    }
    return $this->_schemaNames;
}

public yii\db\Constraint[] getSchemaPrimaryKeys ( $schema = '', $refresh = false ) $schema string

The schema of the tables. Defaults to empty string, meaning the current or default schema name.

$refresh boolean

Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available.

return yii\db\Constraint[]

Primary keys for all tables in the database. Each array element is an instance of yii\db\Constraint or its child class.

Source code

                public function getSchemaPrimaryKeys($schema = '', $refresh = false)
{
    return $this->getSchemaMetadata($schema, 'primaryKey', $refresh);
}

public \yii\db\Constraint[][] getSchemaUniques ( $schema = '', $refresh = false ) $schema string

The schema of the tables. Defaults to empty string, meaning the current or default schema name.

$refresh boolean

Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available.

return \yii\db\Constraint[][]

Unique constraints for all tables in the database. Each array element is an array of yii\db\Constraint or its child classes.

Source code

                public function getSchemaUniques($schema = '', $refresh = false)
{
    return $this->getSchemaMetadata($schema, 'uniques', $refresh);
}

Source code

                public function getServerVersion()
{
    if ($this->_serverVersion === null) {
        $this->_serverVersion = $this->db->getSlavePdo(true)->getAttribute(\PDO::ATTR_SERVER_VERSION);
    }
    return $this->_serverVersion;
}

Source code

                public function getTableChecks($name, $refresh = false)
{
    return $this->getTableMetadata($name, 'checks', $refresh);
}

Source code

                public function getTableDefaultValues($name, $refresh = false)
{
    return $this->getTableMetadata($name, 'defaultValues', $refresh);
}

Source code

                public function getTableForeignKeys($name, $refresh = false)
{
    return $this->getTableMetadata($name, 'foreignKeys', $refresh);
}

Source code

                public function getTableIndexes($name, $refresh = false)
{
    return $this->getTableMetadata($name, 'indexes', $refresh);
}

Source code

                protected function getTableNameParts($name)
{
    return explode('.', $name);
}

public string[] getTableNames ( $schema = '', $refresh = false ) $schema string

The schema of the tables. Defaults to empty string, meaning the current or default schema name. If not empty, the returned table names will be prefixed with the schema name.

$refresh boolean

Whether to fetch the latest available table names. If this is false, table names fetched previously (if available) will be returned.

return string[]

All table names in the database.

Source code

                public function getTableNames($schema = '', $refresh = false)
{
    if (!isset($this->_tableNames[$schema]) || $refresh) {
        $this->_tableNames[$schema] = $this->findTableNames($schema);
    }
    return $this->_tableNames[$schema];
}

Source code

                public function getTablePrimaryKey($name, $refresh = false)
{
    return $this->getTableMetadata($name, 'primaryKey', $refresh);
}

Source code

                public function getTableSchema($name, $refresh = false)
{
    return $this->getTableMetadata($name, 'schema', $refresh);
}

public yii\db\TableSchema[] getTableSchemas ( $schema = '', $refresh = false ) $schema string

The schema of the tables. Defaults to empty string, meaning the current or default schema name.

$refresh boolean

Whether to fetch the latest available table schemas. If this is false, cached data may be returned if available.

return yii\db\TableSchema[]

The metadata for all tables in the database. Each array element is an instance of yii\db\TableSchema or its child class.

Source code

                public function getTableSchemas($schema = '', $refresh = false)
{
    return $this->getSchemaMetadata($schema, 'schema', $refresh);
}

Source code

                public function getTableUniques($name, $refresh = false)
{
    return $this->getTableMetadata($name, 'uniques', $refresh);
}

Defined in: yii\base\BaseObject::hasMethod()

Returns a value indicating whether a method is defined.

The default implementation is a call to php function method_exists(). You may override this method when you implemented the php magic method __call().

Source code

                public function hasMethod($name)
{
    return method_exists($this, $name);
}

Defined in: yii\base\BaseObject::hasProperty()

Returns a value indicating whether a property is defined.

A property is defined if:

the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
the class has a member variable with the specified name (when $checkVars is true);