抽象類別 yii\db\Schema
Schema 是具體 DBMS 特定結構描述類別的基底類別。
Schema 代表資料庫綱要資訊,該資訊是 DBMS 特定的。
公開屬性
屬性 | 類型 | 描述 | 定義於 |
---|---|---|---|
$columnQuoteCharacter | string|string[] | 用於引用資料行名稱的字元。 | yii\db\Schema |
$columnSchemaClass | string|array | 資料行綱要類別或類別設定 | yii\db\Schema |
$db | yii\db\Connection | 資料庫連線 | yii\db\Schema |
$defaultSchema | string | 目前工作階段使用的預設綱要名稱。 | yii\db\Schema |
$exceptionMap | array | DB 錯誤及其對應例外狀況的對應表。如果在 DB 錯誤訊息中找到左側部分,則使用右側部分的例外狀況類別。 | yii\db\Schema |
$lastInsertID | string | 最後插入的資料列 ID,或從序列物件檢索的最後一個值。 | yii\db\Schema |
$queryBuilder | yii\db\QueryBuilder | 此連線的查詢建構器。 | yii\db\Schema |
$schemaNames | string[] | 資料庫中所有綱要名稱,系統綱要除外。 | yii\db\Schema |
$serverVersion | string | 伺服器版本,以字串表示。 | yii\db\Schema |
$tableNames | string[] | 資料庫中所有表格名稱。 | yii\db\Schema |
$tableQuoteCharacter | string|string[] | 用於引用綱要、表格等的字元。 | yii\db\Schema |
$tableSchemas | yii\db\TableSchema[] | 資料庫中所有表格的中繼資料。 | yii\db\Schema |
$transactionIsolationLevel | string | 此交易使用的交易隔離等級。 | yii\db\Schema |
公開方法
受保護的方法
方法 | 描述 | 定義於 |
---|---|---|
createColumnSchema() | 為資料庫建立資料行綱要。 | yii\db\Schema |
findSchemaNames() | 傳回資料庫中所有綱要名稱,包括預設綱要,但不包括系統綱要。 | yii\db\Schema |
findTableNames() | 傳回資料庫中所有表格名稱。 | yii\db\Schema |
getCacheKey() | 傳回指定表格名稱的快取金鑰。 | yii\db\Schema |
getCacheTag() | 傳回快取標籤名稱。 | yii\db\Schema |
getColumnPhpType() | 從抽象 DB 類型中提取 PHP 類型。 | yii\db\Schema |
getSchemaMetadata() | 傳回給定綱要中所有表格的給定類型中繼資料。 | yii\db\Schema |
getTableMetadata() | 傳回給定表格的給定類型中繼資料。 | yii\db\Schema |
getTableNameParts() | 將完整表格名稱拆分為多個部分 | yii\db\Schema |
loadTableSchema() | 載入指定表格的中繼資料。 | yii\db\Schema |
normalizePdoRowKeyCase() | 如果 PDO 的陣列鍵大小寫設定為大寫,則將資料列的陣列鍵大小寫變更為小寫。 | yii\db\Schema |
resolveTableName() | 解析表格名稱和綱要名稱(如果有的話)。 | yii\db\Schema |
setTableMetadata() | 設定給定表格的給定類型中繼資料。 | yii\db\Schema |
常數
常數 | 值 | 描述 | 定義於 |
---|---|---|---|
SCHEMA_CACHE_VERSION | 1 | 綱要快取版本,用於偵測快取值在快取資料格式變更時的不相容性。 | 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 |
屬性詳細資訊
用於引用資料行名稱的字元。如果開始和結束字元不同,則可以使用 2 個字元的陣列。
資料行綱要類別或類別設定
DB 錯誤及其對應例外狀況的對應表。如果在 DB 錯誤訊息中找到左側部分,則使用右側部分的例外狀況類別。
用於引用綱要、表格等名稱的字元。如果開始和結束字元不同,則可以使用 2 個字元的陣列。
資料庫中所有表格的中繼資料。每個陣列元素都是 yii\db\TableSchema 或其子類別的實例。
此交易使用的交易隔離等級。可以是 yii\db\Transaction::READ_UNCOMMITTED、yii\db\Transaction::READ_COMMITTED、yii\db\Transaction::REPEATABLE_READ 和 yii\db\Transaction::SERIALIZABLE 其中之一,也可以是包含 DBMS 特定語法的字串,用於 SET TRANSACTION ISOLATION LEVEL
之後。
方法詳細資訊
public mixed __call ( $name, $params ) | ||
$name | string |
方法名稱 |
$params | array |
方法參數 |
return | mixed |
方法傳回值 |
---|---|---|
throws | yii\base\UnknownMethodException |
當呼叫未知方法時 |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
定義於: yii\base\BaseObject::__construct()
建構子。
預設實作執行兩項操作
- 使用給定的組態
$config
初始化物件。 - 呼叫 init()。
如果在子類別中覆寫此方法,建議
- 建構子的最後一個參數是組態陣列,例如此處的
$config
。 - 在建構子結尾呼叫父類別實作。
public void __construct ( $config = [] ) | ||
$config | array |
將用於初始化物件屬性的名稱-值配對 |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
定義於: yii\base\BaseObject::__get()
傳回物件屬性的值。
請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 $value = $object->property;
時,將會隱式呼叫此方法。
另請參閱 __set()。
public mixed __get ( $name ) | ||
$name | string |
屬性名稱 |
return | mixed |
屬性值 |
---|---|---|
throws | yii\base\UnknownPropertyException |
如果屬性未定義 |
throws | yii\base\InvalidCallException |
如果屬性為唯寫 |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
定義於: yii\base\BaseObject::__isset()
檢查屬性是否已設定,即已定義且非 null。
請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 isset($object->property)
時,將會隱式呼叫此方法。
請注意,如果屬性未定義,將會傳回 false。
public boolean __isset ( $name ) | ||
$name | string |
屬性名稱或事件名稱 |
return | boolean |
具名屬性是否已設定 (非 null)。 |
---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
定義於: yii\base\BaseObject::__set()
設定物件屬性的值。
請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 $object->property = $value;
時,將會隱式呼叫此方法。
另請參閱 __get()。
public void __set ( $name, $value ) | ||
$name | string |
屬性名稱或事件名稱 |
$value | mixed |
屬性值 |
throws | yii\base\UnknownPropertyException |
如果屬性未定義 |
---|---|---|
throws | yii\base\InvalidCallException |
如果屬性為唯讀 |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
定義於: yii\base\BaseObject::__unset()
將物件屬性設定為 null。
請勿直接呼叫此方法,因為它是 PHP 魔術方法,當執行 unset($object->property)
時,將會隱式呼叫此方法。
請注意,如果屬性未定義,此方法將不會執行任何操作。 如果屬性為唯讀,則會擲回例外狀況。
public void __unset ( $name ) | ||
$name | string |
屬性名稱 |
throws | yii\base\InvalidCallException |
如果屬性為唯讀。 |
---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
定義於: yii\base\BaseObject::canGetProperty()
傳回一個值,指示屬性是否可讀取。
如果符合以下條件,屬性為可讀取:
- 類別具有與指定名稱相關聯的 getter 方法(在此情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時);
另請參閱 canSetProperty()。
public boolean canGetProperty ( $name, $checkVars = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
return | boolean |
是否可以讀取屬性 |
---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
定義於: yii\base\BaseObject::canSetProperty()
傳回一個值,指示屬性是否可設定。
如果符合以下條件,屬性為可寫入:
- 類別具有與指定名稱相關聯的 setter 方法(在此情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時);
另請參閱 canGetProperty()。
public boolean canSetProperty ( $name, $checkVars = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
return | boolean |
是否可以寫入屬性 |
---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class
。
定義於: yii\base\BaseObject::className()
傳回此類別的完整限定名稱。
public static string className ( ) | ||
return | string |
此類別的完整限定名稱。 |
---|
public static function className()
{
return get_called_class();
}
如果可能,將 DB 例外狀況轉換為更具體的例外狀況。
public yii\db\Exception convertException ( Exception $e, $rawSql ) | ||
$e | 例外狀況 | |
$rawSql | string |
產生例外狀況的 SQL |
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);
}
為資料庫建立資料行綱要。
子類別可以覆寫此方法,以建立 DBMS 特定的資料行綱要。
protected yii\db\ColumnSchema createColumnSchema ( ) | ||
return | yii\db\ColumnSchema |
資料行綱要實例。 |
---|---|---|
throws | yii\base\InvalidConfigException |
如果無法建立資料行綱要類別。 |
protected function createColumnSchema()
{
return Yii::createObject($this->columnSchemaClass);
}
建立資料行綱要建構器實例,並指定類型和值精確度。
此方法可能會被子類別覆寫,以建立特定於 DBMS 的資料行結構描述建構器。
public yii\db\ColumnSchemaBuilder createColumnSchemaBuilder ( $type, $length = null ) | ||
$type | string |
資料行的類型。請參閱 yii\db\ColumnSchemaBuilder::$type。 |
$length | integer|string|array|null |
資料行的長度或精確度。請參閱 yii\db\ColumnSchemaBuilder::$length。 |
return | yii\db\ColumnSchemaBuilder |
資料行結構描述建構器實例 |
---|
public function createColumnSchemaBuilder($type, $length = null)
{
return Yii::createObject(ColumnSchemaBuilder::className(), [$type, $length]);
}
為資料庫建立查詢建構器。
此方法可能會被子類別覆寫,以建立特定於 DBMS 的查詢建構器。
public yii\db\QueryBuilder createQueryBuilder ( ) | ||
return | yii\db\QueryBuilder |
查詢建構器實例 |
---|
public function createQueryBuilder()
{
return Yii::createObject(QueryBuilder::className(), [$this->db]);
}
建立新的儲存點。
public void createSavepoint ( $name ) | ||
$name | string |
儲存點名稱 |
public function createSavepoint($name)
{
$this->db->createCommand("SAVEPOINT $name")->execute();
}
傳回資料庫中所有綱要名稱,包括預設綱要,但不包括系統綱要。
子類別應覆寫此方法以支援此功能,因為預設實作只會拋出例外。
protected array findSchemaNames ( ) | ||
return | array |
資料庫中所有綱要名稱,系統綱要除外。 |
---|---|---|
throws | yii\base\NotSupportedException |
如果 DBMS 不支援此方法。 |
protected function findSchemaNames()
{
throw new NotSupportedException(get_class($this) . ' does not support fetching all schema names.');
}
傳回資料庫中所有表格名稱。
子類別應覆寫此方法以支援此功能,因為預設實作只會拋出例外。
protected array findTableNames ( $schema = '' ) | ||
$schema | string |
資料表的結構描述。預設為空字串,表示目前的或預設的結構描述。 |
return | array |
資料庫中的所有資料表名稱。名稱不包含結構描述名稱前綴。 |
---|---|---|
throws | yii\base\NotSupportedException |
如果 DBMS 不支援此方法。 |
protected function findTableNames($schema = '')
{
throw new NotSupportedException(get_class($this) . ' does not support fetching all table names.');
}
傳回指定表格的所有唯一索引。
每個陣列元素都具有以下結構
[
'IndexName1' => ['col1' [, ...]],
'IndexName2' => ['col2' [, ...]],
]
子類別應覆寫此方法以支援此功能,因為預設實作只會拋出例外
public array findUniqueIndexes ( $table ) | ||
$table | yii\db\TableSchema |
資料表的中繼資料 |
return | array |
指定資料表的所有唯一索引。 |
---|---|---|
throws | yii\base\NotSupportedException |
如果呼叫此方法 |
public function findUniqueIndexes($table)
{
throw new NotSupportedException(get_class($this) . ' does not support getting unique indexes information.');
}
傳回指定表格名稱的快取金鑰。
protected mixed getCacheKey ( $name ) | ||
$name | string |
資料表名稱。 |
return | mixed |
快取鍵。 |
---|
protected function getCacheKey($name)
{
return [
__CLASS__,
$this->db->dsn,
$this->db->username,
$this->getRawTableName($name),
];
}
傳回快取標籤名稱。
這允許 refresh() 使所有快取的資料表結構描述失效。
protected string getCacheTag ( ) | ||
return | string |
快取標籤名稱 |
---|
protected function getCacheTag()
{
return md5(serialize([
__CLASS__,
$this->db->dsn,
$this->db->username,
]));
}
從抽象 DB 類型中提取 PHP 類型。
protected string getColumnPhpType ( $column ) | ||
$column | yii\db\ColumnSchema |
資料行結構描述資訊 |
return | string |
PHP 類型名稱 |
---|
protected function getColumnPhpType($column)
{
static $typeMap = [
// abstract type => php type
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';
}
傳回最後插入的資料列或序列值的 ID。
另請參閱 https://php.dev.org.tw/manual/en/function.PDO-lastInsertId.php。
public string getLastInsertID ( $sequenceName = '' ) | ||
$sequenceName | string |
序列物件的名稱 (某些 DBMS 需要) |
return | string |
最後插入的列的列 ID,或從序列物件檢索的最後一個值 |
---|---|---|
throws | yii\base\InvalidCallException |
如果資料庫連線未啟用 |
public function getLastInsertID($sequenceName = '')
{
if ($this->db->isActive) {
return $this->db->pdo->lastInsertId($sequenceName === '' ? null : $this->quoteTableName($sequenceName));
}
throw new InvalidCallException('DB Connection is not active.');
}
判斷給定 PHP 資料值的 PDO 類型。
public integer getPdoType ( $data ) | ||
$data | mixed |
要判斷 PDO 類型的資料 |
return | integer |
PDO 類型 |
---|
public function getPdoType($data)
{
static $typeMap = [
// php type => PDO type
'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;
}
public yii\db\QueryBuilder getQueryBuilder ( ) | ||
return | yii\db\QueryBuilder |
此連線的查詢建構器。 |
---|
public function getQueryBuilder()
{
if ($this->_builder === null) {
$this->_builder = $this->createQueryBuilder();
}
return $this->_builder;
}
傳回給定表格名稱的實際名稱。
此方法將從給定的資料表名稱中移除大括號,並將百分比字元 '%' 替換為 yii\db\Connection::$tablePrefix。
public string getRawTableName ( $name ) | ||
$name | string |
要轉換的資料表名稱 |
return | string |
給定資料表名稱的實際名稱 |
---|
public function getRawTableName($name)
{
if (strpos($name, '{{') !== false) {
$name = preg_replace('/\\{\\{(.*?)\\}\\}/', '\1', $name);
return str_replace('%', $this->db->tablePrefix, $name);
}
return $name;
}
傳回給定綱要中所有表格的給定類型中繼資料。
此方法將呼叫一個名為 'getTable' . ucfirst($type)
的方法,並帶有資料表名稱和重新整理標誌以取得中繼資料。
protected array getSchemaMetadata ( $schema, $type, $refresh ) | ||
$schema | string |
中繼資料的結構描述。預設為空字串,表示目前的或預設的結構描述名稱。 |
$type | string |
中繼資料類型。 |
$refresh | boolean |
是否要擷取最新的可用資料表的中繼資料。如果這是 |
return | array |
中繼資料陣列。 |
---|
protected function getSchemaMetadata($schema, $type, $refresh)
{
$metadata = [];
$methodName = 'getTable' . ucfirst($type);
foreach ($this->getTableNames($schema, $refresh) as $name) {
if ($schema !== '') {
$name = $schema . '.' . $name;
}
$tableMetadata = $this->$methodName($name, $refresh);
if ($tableMetadata !== null) {
$metadata[] = $tableMetadata;
}
}
return $metadata;
}
傳回資料庫中所有綱要名稱,系統綱要除外。
public string[] getSchemaNames ( $refresh = false ) | ||
$refresh | boolean |
是否要擷取最新的可用結構描述名稱。如果這是 false,則會傳回先前擷取的結構描述名稱 (如果可用)。 |
return | string[] |
資料庫中所有綱要名稱,系統綱要除外。 |
---|
public function getSchemaNames($refresh = false)
{
if ($this->_schemaNames === null || $refresh) {
$this->_schemaNames = $this->findSchemaNames();
}
return $this->_schemaNames;
}
傳回伺服器版本,以字串形式,可使用 \version_compare() 進行比較。
public string getServerVersion ( ) | ||
return | string |
伺服器版本,以字串表示。 |
---|
public function getServerVersion()
{
if ($this->_serverVersion === null) {
$this->_serverVersion = $this->db->getSlavePdo(true)->getAttribute(\PDO::ATTR_SERVER_VERSION);
}
return $this->_serverVersion;
}
傳回給定表格的給定類型中繼資料。
如果快取中沒有中繼資料,此方法將呼叫一個名為 'loadTable' . ucfirst($type)
的方法,並帶有資料表名稱以取得中繼資料。
protected mixed getTableMetadata ( $name, $type, $refresh ) | ||
$name | string |
資料表名稱。資料表名稱可能包含結構描述名稱 (如果有的話)。請勿加上引號。 |
$type | string |
中繼資料類型。 |
$refresh | boolean |
是否即使在快取中找到資料表的中繼資料,仍要重新載入。 |
return | mixed |
中繼資料。 |
---|
protected function getTableMetadata($name, $type, $refresh)
{
$cache = null;
if ($this->db->enableSchemaCache && !in_array($name, $this->db->schemaCacheExclude, true)) {
$schemaCache = is_string($this->db->schemaCache) ? Yii::$app->get($this->db->schemaCache, false) : $this->db->schemaCache;
if ($schemaCache instanceof CacheInterface) {
$cache = $schemaCache;
}
}
$rawName = $this->getRawTableName($name);
if (!isset($this->_tableMetadata[$rawName])) {
$this->loadTableMetadataFromCache($cache, $rawName);
}
if ($refresh || !array_key_exists($type, $this->_tableMetadata[$rawName])) {
$this->_tableMetadata[$rawName][$type] = $this->{'loadTable' . ucfirst($type)}($rawName);
$this->saveTableMetadataToCache($cache, $rawName);
}
return $this->_tableMetadata[$rawName][$type];
}
將完整表格名稱拆分為多個部分
protected array getTableNameParts ( $name ) | ||
$name | string |
protected function getTableNameParts($name)
{
return explode('.', $name);
}
傳回資料庫中所有表格名稱。
public string[] getTableNames ( $schema = '', $refresh = false ) | ||
$schema | string |
資料表的結構描述。預設為空字串,表示目前的或預設的結構描述名稱。如果不是空字串,則傳回的資料表名稱將會加上結構描述名稱前綴。 |
$refresh | boolean |
是否要擷取最新的可用資料表名稱。如果這是 false,則會傳回先前擷取的資料表名稱 (如果可用)。 |
return | string[] |
資料庫中所有表格名稱。 |
---|
public function getTableNames($schema = '', $refresh = false)
{
if (!isset($this->_tableNames[$schema]) || $refresh) {
$this->_tableNames[$schema] = $this->findTableNames($schema);
}
return $this->_tableNames[$schema];
}
取得指定表格的中繼資料。
public yii\db\TableSchema|null getTableSchema ( $name, $refresh = false ) | ||
$name | string |
資料表名稱。資料表名稱可能包含結構描述名稱 (如果有的話)。請勿加上引號。 |
$refresh | boolean |
是否即使在快取中找到資料表結構描述,仍要重新載入。 |
return | yii\db\TableSchema|null |
資料表中繼資料。如果指定的資料表不存在,則為 |
---|
public function getTableSchema($name, $refresh = false)
{
return $this->getTableMetadata($name, 'schema', $refresh);
}
傳回資料庫中所有表格的中繼資料。
public yii\db\TableSchema[] getTableSchemas ( $schema = '', $refresh = false ) | ||
$schema | string |
資料表的結構描述。預設為空字串,表示目前的或預設的結構描述名稱。 |
$refresh | boolean |
是否要擷取最新的可用資料表結構描述。如果這是 |
return | yii\db\TableSchema[] |
資料庫中所有表格的中繼資料。每個陣列元素都是 yii\db\TableSchema 或其子類別的實例。 |
---|
public function getTableSchemas($schema = '', $refresh = false)
{
return $this->getSchemaMetadata($schema, 'schema', $refresh);
}
定義於: yii\base\BaseObject::hasMethod()
傳回一個值,指示是否已定義方法。
預設實作是對 php 函數 method_exists()
的呼叫。當您實作 php 魔術方法 __call()
時,您可以覆寫此方法。
public boolean hasMethod ( $name ) | ||
$name | string |
方法名稱 |
return | boolean |
方法是否已定義 |
---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
定義於: yii\base\BaseObject::hasProperty()
傳回一個值,指示是否已定義屬性。
如果滿足以下條件,則定義了屬性
- 類別具有與指定名稱關聯的 getter 或 setter 方法 (在這種情況下,屬性名稱不區分大小寫);
- 類別具有具有指定名稱的成員變數(當
$checkVars
為 true 時);
另請參閱
public boolean hasProperty ( $name, $checkVars = true ) | ||
$name | string |
屬性名稱 |
$checkVars | boolean |
是否將成員變數視為屬性 |
return | boolean |
屬性是否已定義 |
---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
public void init ( ) |
public function init()
{
}
執行 INSERT 命令,傳回主鍵值。
public array|false insert ( $table, $columns ) | ||
$table | string |
新列將插入的資料表。 |
$columns | array |
要插入資料表的資料行資料 (name => value)。 |
return | array|false |
主鍵值,如果命令失敗則為 false |
---|
public function insert($table, $columns)
{
$command = $this->db->createCommand()->insert($table, $columns);
if (!$command->execute()) {
return false;
}
$tableSchema = $this->getTableSchema($table);
$result = [];
foreach ($tableSchema->primaryKey as $name) {
if ($tableSchema->columns[$name]->autoIncrement) {
$result[$name] = $this->getLastInsertID($tableSchema->sequenceName);
break;
}
$result[$name] = isset($columns[$name]) ? $columns[$name] : $tableSchema->columns[$name]->defaultValue;
}
return $result;
}
傳回一個值,指示 SQL 陳述式是否用於讀取目的。
public boolean isReadQuery ( $sql ) | ||
$sql | string |
SQL 陳述式 |
return | boolean |
SQL 陳述式是否用於讀取目的。 |
---|
public function isReadQuery($sql)
{
$pattern = '/^\s*(SELECT|SHOW|DESCRIBE)\b/i';
return preg_match($pattern, $sql) > 0;
}
載入指定表格的中繼資料。
protected abstract yii\db\TableSchema|null loadTableSchema ( $name ) | ||
$name | string |
資料表名稱 |
return | yii\db\TableSchema|null |
與 DBMS 相關的資料表中繼資料,如果資料表不存在,則為 |
---|
abstract protected function loadTableSchema($name);
如果 PDO 的陣列鍵大小寫設定為大寫,則將資料列的陣列鍵大小寫變更為小寫。
protected array normalizePdoRowKeyCase ( array $row, $multiple ) | ||
$row | array |
列的陣列或列的陣列的陣列。 |
$multiple | boolean |
是否傳遞多列或單列。 |
return | array |
標準化的列或列。 |
---|
protected function normalizePdoRowKeyCase(array $row, $multiple)
{
if ($this->db->getSlavePdo(true)->getAttribute(\PDO::ATTR_CASE) !== \PDO::CASE_UPPER) {
return $row;
}
if ($multiple) {
return array_map(function (array $row) {
return array_change_key_case($row, CASE_LOWER);
}, $row);
}
return array_change_key_case($row, CASE_LOWER);
}
引用資料行名稱,以便在查詢中使用。
如果資料行名稱包含前綴,前綴也將被正確地加上引號。如果資料行名稱已加上引號或包含 '('、'[[' 或 '{{',則此方法將不執行任何操作。
另請參閱 quoteSimpleColumnName()。
public string quoteColumnName ( $name ) | ||
$name | string |
資料行名稱 |
return | string |
正確加上引號的資料行名稱 |
---|
public function quoteColumnName($name)
{
if (strpos($name, '(') !== false || strpos($name, '[[') !== false) {
return $name;
}
if (($pos = strrpos($name, '.')) !== false) {
$prefix = $this->quoteTableName(substr($name, 0, $pos)) . '.';
$name = substr($name, $pos + 1);
} else {
$prefix = '';
}
if (strpos($name, '{{') !== false) {
return $name;
}
return $prefix . $this->quoteSimpleColumnName($name);
}
引用簡單資料行名稱,以便在查詢中使用。
簡單的資料行名稱應僅包含資料行名稱,而不包含任何前綴。如果資料行名稱已加上引號或是星號字元 '*',則此方法將不執行任何操作。
public string quoteSimpleColumnName ( $name ) | ||
$name | string |
資料行名稱 |
return | string |
正確加上引號的資料行名稱 |
---|
public function quoteSimpleColumnName($name)
{
if (is_string($this->columnQuoteCharacter)) {
$startingCharacter = $endingCharacter = $this->columnQuoteCharacter;
} else {
list($startingCharacter, $endingCharacter) = $this->columnQuoteCharacter;
}
return $name === '*' || strpos($name, $startingCharacter) !== false ? $name : $startingCharacter . $name . $endingCharacter;
}
引用簡單表格名稱,以便在查詢中使用。
簡單的資料表名稱應僅包含資料表名稱,而不包含任何結構描述前綴。如果資料表名稱已加上引號,則此方法將不執行任何操作。
public string quoteSimpleTableName ( $name ) | ||
$name | string |
資料表名稱 |
return | string |
正確加上引號的資料表名稱 |
---|
public function quoteSimpleTableName($name)
{
if (is_string($this->tableQuoteCharacter)) {
$startingCharacter = $endingCharacter = $this->tableQuoteCharacter;
} else {
list($startingCharacter, $endingCharacter) = $this->tableQuoteCharacter;
}
return strpos($name, $startingCharacter) !== false ? $name : $startingCharacter . $name . $endingCharacter;
}
引用表格名稱,以便在查詢中使用。
如果資料表名稱包含結構描述前綴,前綴也將被正確地加上引號。如果資料表名稱已加上引號或包含 '(' 或 '{{',則此方法將不執行任何操作。
另請參閱 quoteSimpleTableName()。
public string quoteTableName ( $name ) | ||
$name | string |
資料表名稱 |
return | string |
正確加上引號的資料表名稱 |
---|
public function quoteTableName($name)
{
if (strncmp($name, '(', 1) === 0 && strpos($name, ')') === strlen($name) - 1) {
return $name;
}
if (strpos($name, '{{') !== false) {
return $name;
}
if (strpos($name, '.') === false) {
return $this->quoteSimpleTableName($name);
}
$parts = $this->getTableNameParts($name);
foreach ($parts as $i => $part) {
$parts[$i] = $this->quoteSimpleTableName($part);
}
return implode('.', $parts);
}
引用字串值,以便在查詢中使用。
請注意,如果參數不是字串,它將在不更改的情況下傳回。
另請參閱 https://php.dev.org.tw/manual/en/function.PDO-quote.php。
public string quoteValue ( $str ) | ||
$str | string |
要加上引號的字串 |
return | string |
正確加上引號的字串 |
---|
public function quoteValue($str)
{
if (!is_string($str)) {
return $str;
}
if (mb_stripos((string)$this->db->dsn, 'odbc:') === false && ($value = $this->db->getSlavePdo(true)->quote($str)) !== false) {
return $value;
}
// the driver doesn't support quote (e.g. oci)
return "'" . addcslashes(str_replace("'", "''", $str), "\000\n\r\\\032") . "'";
}
重新整理綱要。
此方法清除所有快取的資料表結構描述,以便稍後可以重新建立它們以反映資料庫結構描述變更。
public void refresh ( ) |
public function refresh()
{
/* @var $cache CacheInterface */
$cache = is_string($this->db->schemaCache) ? Yii::$app->get($this->db->schemaCache, false) : $this->db->schemaCache;
if ($this->db->enableSchemaCache && $cache instanceof CacheInterface) {
TagDependency::invalidate($cache, $this->getCacheTag());
}
$this->_tableNames = [];
$this->_tableMetadata = [];
}
重新整理特定表格綱要。
此方法清除快取的資料表結構描述,以便稍後可以重新建立它以反映資料庫結構描述變更。
public void refreshTableSchema ( $name ) | ||
$name | string |
資料表名稱。 |
public function refreshTableSchema($name)
{
$rawName = $this->getRawTableName($name);
unset($this->_tableMetadata[$rawName]);
$this->_tableNames = [];
/* @var $cache CacheInterface */
$cache = is_string($this->db->schemaCache) ? Yii::$app->get($this->db->schemaCache, false) : $this->db->schemaCache;
if ($this->db->enableSchemaCache && $cache instanceof CacheInterface) {
$cache->delete($this->getCacheKey($rawName));
}
}
釋放現有的儲存點。
public void releaseSavepoint ( $name ) | ||
$name | string |
儲存點名稱 |
public function releaseSavepoint($name)
{
$this->db->createCommand("RELEASE SAVEPOINT $name")->execute();
}
解析表格名稱和綱要名稱(如果有的話)。
protected yii\db\TableSchema resolveTableName ( $name ) | ||
$name | string |
資料表名稱 |
return | yii\db\TableSchema |
yii\db\TableSchema 與已解析的資料表、結構描述等名稱。 |
---|---|---|
throws | yii\base\NotSupportedException |
如果 DBMS 不支援此方法。 |
protected function resolveTableName($name)
{
throw new NotSupportedException(get_class($this) . ' does not support resolving table names.');
}
回滾到先前建立的儲存點。
public void rollBackSavepoint ( $name ) | ||
$name | string |
儲存點名稱 |
public function rollBackSavepoint($name)
{
$this->db->createCommand("ROLLBACK TO SAVEPOINT $name")->execute();
}
設定給定表格的給定類型中繼資料。
protected void setTableMetadata ( $name, $type, $data ) | ||
$name | string |
資料表名稱。 |
$type | string |
中繼資料類型。 |
$data | mixed |
中繼資料。 |
protected function setTableMetadata($name, $type, $data)
{
$this->_tableMetadata[$this->getRawTableName($name)][$type] = $data;
}
設定目前交易的隔離等級。
另請參閱 https://en.wikipedia.org/wiki/Isolation_(database_systems)#Isolation_levels。
public void setTransactionIsolationLevel ( $level ) | ||
$level | string |
此交易使用的交易隔離等級。可以是 yii\db\Transaction::READ_UNCOMMITTED、yii\db\Transaction::READ_COMMITTED、yii\db\Transaction::REPEATABLE_READ 和 yii\db\Transaction::SERIALIZABLE 其中之一,也可以是包含 DBMS 特定語法的字串,用於 |
public function setTransactionIsolationLevel($level)
{
$this->db->createCommand("SET TRANSACTION ISOLATION LEVEL $level")->execute();
}
public boolean supportsSavepoint ( ) | ||
return | boolean |
此 DBMS 是否支援 savepoint。 |
---|
public function supportsSavepoint()
{
return $this->db->enableSavepoint;
}
取消引用簡單資料行名稱。
簡單的欄位名稱應僅包含欄位名稱,不帶任何前綴。如果欄位名稱未被引號括起來或是星號字元 '*',此方法將不會執行任何操作。
public string unquoteSimpleColumnName ( $name ) | ||
$name | string |
欄位名稱。 |
return | string |
未被引號括起來的欄位名稱。 |
---|
public function unquoteSimpleColumnName($name)
{
if (is_string($this->columnQuoteCharacter)) {
$startingCharacter = $this->columnQuoteCharacter;
} else {
$startingCharacter = $this->columnQuoteCharacter[0];
}
return strpos($name, $startingCharacter) === false ? $name : substr($name, 1, -1);
}
取消引用簡單表格名稱。
簡單的資料表名稱應僅包含資料表名稱,不帶任何結構描述前綴。如果資料表名稱未被引號括起來,此方法將不會執行任何操作。
public string unquoteSimpleTableName ( $name ) | ||
$name | string |
資料表名稱。 |
return | string |
未被引號括起來的資料表名稱。 |
---|
public function unquoteSimpleTableName($name)
{
if (is_string($this->tableQuoteCharacter)) {
$startingCharacter = $this->tableQuoteCharacter;
} else {
$startingCharacter = $this->tableQuoteCharacter[0];
}
return strpos($name, $startingCharacter) === false ? $name : substr($name, 1, -1);
}
註冊 或 登入 以便評論。