Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • Net
  • None
  • PHP
  • system
    • base
    • caching
      • dependencies
    • collections
    • console
    • db
      • ar
      • schema
        • cubrid
        • mssql
        • mysql
        • oci
        • pgsql
        • sqlite
    • i18n
      • gettext
    • logging
    • test
    • utils
    • validators
    • web
      • actions
      • auth
      • filters
      • form
      • helpers
      • renderers
      • services
      • widgets
        • captcha
        • pagers
  • Text
    • Highlighter
  • zii
    • behaviors
    • widgets
      • grid
      • jui

Classes

  • CCubridColumnSchema
  • CCubridSchema
  • CCubridTableSchema
  • Overview
  • Package
  • Class
  • Tree

Class CCubridSchema

CCubridSchema is the class for retrieving metadata information from a CUBRID database (version 8.4.0 and later).

CComponent
Extended by CDbSchema
Extended by CCubridSchema
Package: system\db\schema\cubrid
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Esen Sagynov <kadismal@gmail.com>
Since: 1.1.16
Located at x2engine/framework/db/schema/cubrid/CCubridSchema.php
Methods summary
public string
# quoteSimpleTableName( string $name )

Quotes a table name for use in a query. A simple table name does not schema prefix.

Quotes a table name for use in a query. A simple table name does not schema prefix.

Parameters

$name
string
$name table name

Returns

string
the properly quoted table name

Overrides

CDbSchema::quoteSimpleTableName()
public string
# quoteSimpleColumnName( string $name )

Quotes a column name for use in a query. A simple column name does not contain prefix.

Quotes a column name for use in a query. A simple column name does not contain prefix.

Parameters

$name
string
$name column name

Returns

string
the properly quoted column name

Overrides

CDbSchema::quoteSimpleColumnName()
public boolean
# compareTableNames( string $name1, string $name2 )

Compares two table names. The table names can be either quoted or unquoted. This method will consider both cases.

Compares two table names. The table names can be either quoted or unquoted. This method will consider both cases.

Parameters

$name1
string
$name1 table name 1
$name2
string
$name2 table name 2

Returns

boolean
whether the two table names refer to the same table.

Overrides

CDbSchema::compareTableNames()
public
# resetSequence( CDbTableSchema $table, mixed $value = null )

Resets the sequence value of a table's primary key. The sequence will be reset such that the primary key of the next new row inserted will have the specified value or 1.

Resets the sequence value of a table's primary key. The sequence will be reset such that the primary key of the next new row inserted will have the specified value or 1.

Parameters

$table
CDbTableSchema
$table the table schema whose primary key sequence will be reset
$value
mixed
$value the value for the primary key of the next new row inserted. If this is not set, the next new row's primary key will have a value 1.

Overrides

CDbSchema::resetSequence()
protected CCubridTableSchema
# loadTable( string $name )

Creates a table instance representing the metadata for the named table.

Creates a table instance representing the metadata for the named table.

Parameters

$name
string
$name table name

Returns

CCubridTableSchema
driver dependent table metadata. Null if the table does not exist.
protected
# resolveTableNames( CCubridTableSchema $table, string $name )

Generates various kinds of table names.

Generates various kinds of table names.

Parameters

$table
CCubridTableSchema
$table the table instance
$name
string
$name the unquoted table name
protected boolean
# findColumns( CCubridTableSchema $table )

Collects the table column metadata.

Collects the table column metadata.

Parameters

$table
CCubridTableSchema
$table the table metadata

Returns

boolean
whether the table exists in the database
protected CDbColumnSchema
# createColumn( array $column )

Creates a table column.

Creates a table column.

Parameters

$column
array
$column column metadata

Returns

CDbColumnSchema
normalized column metadata
protected float
# getServerVersion( )

Returns

float
server version.
protected
# findConstraints( CCubridTableSchema $table )

Collects the foreign key column details for the given table.

Collects the foreign key column details for the given table.

Parameters

$table
CCubridTableSchema
$table the table metadata
protected
# findPrimaryKeys( CCubridTableSchema $table )

Collects the primary key column details for the given table.

Collects the primary key column details for the given table.

Parameters

$table
CCubridTableSchema
$table the table metadata
protected array
# findTableNames( string $schema = '' )

Returns all table names in the database.

Returns all table names in the database.

Parameters

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

Returns

array
all table names in the database.

Throws

CDbException
if current schema does not support fetching all table names

Overrides

CDbSchema::findTableNames()
Methods inherited from CDbSchema
__construct(), addColumn(), addForeignKey(), addPrimaryKey(), alterColumn(), checkIntegrity(), createCommandBuilder(), createIndex(), createTable(), dropColumn(), dropForeignKey(), dropIndex(), dropPrimaryKey(), dropTable(), getColumnType(), getCommandBuilder(), getDbConnection(), getTable(), getTableNames(), getTables(), quoteColumnName(), quoteTableName(), refresh(), renameColumn(), renameTable(), truncateTable()
Methods inherited from CComponent
__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()
Properties summary
public array $columnTypes array( 'pk' => 'INTEGER NOT NULL AUTO_INCREMENT PRIMARY KEY', // same as STRING or CHARACTER VARYING 'string' => 'VARCHAR(255)', 'text' => 'VARCHAR(65535)', 'integer' => 'INTEGER', 'float' => 'NUMERIC', 'real' => 'NUMERIC', 'decimal' => 'NUMERIC', 'datetime' => 'DATETIME', 'timestamp' => 'TIMESTAMP', 'time' => 'TIME', 'date' => 'DATE', 'binary' => 'BIT VARYING', 'bool' => 'SHORT', 'boolean' => 'SHORT', 'money' => 'NUMERIC(19,4)', )
#

the abstract column types mapped to physical column types.

the abstract column types mapped to physical column types.

Since

1.1.6
Magic properties inherited from CDbSchema
$commandBuilder, $dbConnection, $tableNames, $tables
API documentation generated by ApiGen 2.8.0