0 フォロワー

インターフェース yii\db\ConstraintFinderInterface

全クラス | メソッド
実装クラスyii\db\cubrid\Schema、yii\db\mssql\Schema、yii\db\mysql\Schema、yii\db\oci\Schema、yii\db\pgsql\Schema、yii\db\sqlite\Schema
利用可能バージョン2.0.14
ソースコード https://github.com/yiisoft/yii2/blob/master/framework/db/ConstraintFinderInterface.php

ConstraintFinderInterface は、テーブル制約情報を取得するためのメソッドを定義します。

公開メソッド

継承メソッドを非表示

メソッド 説明 定義元
getSchemaChecks() データベース内のすべてのテーブルのチェック制約を返します。 yii\db\ConstraintFinderInterface
getSchemaDefaultValues() データベース内のすべてのテーブルのデフォルト値制約を返します。 yii\db\ConstraintFinderInterface
getSchemaForeignKeys() データベース内のすべてのテーブルの外部キーを返します。 yii\db\ConstraintFinderInterface
getSchemaIndexes() データベース内のすべてのテーブルのインデックスを返します。 yii\db\ConstraintFinderInterface
getSchemaPrimaryKeys() データベース内のすべてのテーブルの主キーを返します。 yii\db\ConstraintFinderInterface
getSchemaUniques() データベース内のすべてのテーブルの一意制約を返します。 yii\db\ConstraintFinderInterface
getTableChecks() 指定されたテーブルのチェック制約情報を取得します。 yii\db\ConstraintFinderInterface
getTableDefaultValues() 指定されたテーブルのデフォルト値制約情報を取得します。 yii\db\ConstraintFinderInterface
getTableForeignKeys() 指定されたテーブルの外部キー情報を取得します。 yii\db\ConstraintFinderInterface
getTableIndexes() 指定されたテーブルのインデックス情報を取得します。 yii\db\ConstraintFinderInterface
getTablePrimaryKey() 指定されたテーブルの主キーを取得します。 yii\db\ConstraintFinderInterface
getTableUniques() 指定されたテーブルの一意制約情報を取得します。 yii\db\ConstraintFinderInterface

メソッドの詳細

継承メソッドを非表示

getSchemaChecks() public abstract method

データベース内のすべてのテーブルのチェック制約を返します。

public abstract \yii\db\CheckConstraint[][] getSchemaChecks ( $schema = '', $refresh = false )
$schema 文字列

テーブルのスキーマ。デフォルトは空文字列で、現在のまたはデフォルトのスキーマ名を意味します。
$refresh ブール値

最新の利用可能なテーブルスキーマを取得するかどうか。falseの場合、利用可能な場合はキャッシュされたデータが返される可能性があります。
戻り値 \yii\db\CheckConstraint[][]

データベース内のすべてのテーブルのチェック制約。各配列要素は、yii\db\CheckConstraintまたはその子クラスの配列です。

 

                public function getSchemaChecks($schema = '', $refresh = false);
getSchemaDefaultValues() public abstract method

データベース内のすべてのテーブルのデフォルト値制約を返します。

public abstract yii\db\DefaultValueConstraint[] getSchemaDefaultValues ( $schema = '', $refresh = false )
$schema 文字列

テーブルのスキーマ。デフォルトは空文字列で、現在のまたはデフォルトのスキーマ名を意味します。
$refresh ブール値

最新の利用可能なテーブルスキーマを取得するかどうか。falseの場合、利用可能な場合はキャッシュされたデータが返される可能性があります。
戻り値 yii\db\DefaultValueConstraint[]

データベース内のすべてのテーブルのデフォルト値制約。各配列要素は、yii\db\DefaultValueConstraintまたはその子クラスの配列です。

 

                public function getSchemaDefaultValues($schema = '', $refresh = false);
getSchemaForeignKeys() public abstract method

データベース内のすべてのテーブルの外部キーを返します。

public abstract \yii\db\ForeignKeyConstraint[][] getSchemaForeignKeys ( $schema = '', $refresh = false )
$schema 文字列

テーブルのスキーマ。デフォルトは空文字列で、現在のまたはデフォルトのスキーマ名を意味します。
$refresh ブール値

最新の利用可能なテーブルスキーマを取得するかどうか。falseの場合、利用可能な場合はキャッシュされたデータが返される可能性があります。
戻り値 \yii\db\ForeignKeyConstraint[][]

データベース内のすべてのテーブルの外部キー。各配列要素は、yii\db\ForeignKeyConstraintまたはその子クラスの配列です。

 

                public function getSchemaForeignKeys($schema = '', $refresh = false);
getSchemaIndexes() public abstract method

データベース内のすべてのテーブルのインデックスを返します。

public abstract \yii\db\IndexConstraint[][] getSchemaIndexes ( $schema = '', $refresh = false )
$schema 文字列

テーブルのスキーマ。デフォルトは空文字列で、現在のまたはデフォルトのスキーマ名を意味します。
$refresh ブール値

最新の利用可能なテーブルスキーマを取得するかどうか。falseの場合、利用可能な場合はキャッシュされたデータが返される可能性があります。
戻り値 \yii\db\IndexConstraint[][]

データベース内のすべてのテーブルのインデックス。各配列要素は、yii\db\IndexConstraintまたはその子クラスの配列です。

 

                public function getSchemaIndexes($schema = '', $refresh = false);
getSchemaPrimaryKeys() public abstract method

データベース内のすべてのテーブルの主キーを返します。

public abstract yii\db\Constraint[] getSchemaPrimaryKeys ( $schema = '', $refresh = false )
$schema 文字列

テーブルのスキーマ。デフォルトは空文字列で、現在のまたはデフォルトのスキーマ名を意味します。
$refresh ブール値

最新の利用可能なテーブルスキーマを取得するかどうか。これがfalseの場合、利用可能な場合はキャッシュされたデータが返される可能性があります。
戻り値 yii\db\Constraint[]

データベース内のすべてのテーブルの主キー。各配列要素は、yii\db\Constraintまたはその子クラスのインスタンスです。

 

                public function getSchemaPrimaryKeys($schema = '', $refresh = false);
getSchemaUniques() public abstract method

データベース内のすべてのテーブルの一意制約を返します。

public abstract \yii\db\Constraint[][] getSchemaUniques ( $schema = '', $refresh = false )
$schema 文字列

テーブルのスキーマ。デフォルトは空文字列で、現在のまたはデフォルトのスキーマ名を意味します。
$refresh ブール値

最新の利用可能なテーブルスキーマを取得するかどうか。falseの場合、利用可能な場合はキャッシュされたデータが返される可能性があります。
戻り値 \yii\db\Constraint[][]

データベース内のすべてのテーブルの一意制約。各配列要素は、yii\db\Constraintまたはその子クラスの配列です。

 

                public function getSchemaUniques($schema = '', $refresh = false);
getTableChecks() public abstract method

指定されたテーブルのチェック制約情報を取得します。

public abstract yii\db\CheckConstraint[] getTableChecks ( $name, $refresh = false )
$name 文字列

テーブル名。テーブル名には、スキーマ名が含まれる場合があります。テーブル名を引用符で囲まないでください。
$refresh ブール値

キャッシュ内に見つかった場合でも、情報を再読み込みするかどうか。
戻り値 yii\db\CheckConstraint[]

テーブルチェック制約。

 

                public function getTableChecks($name, $refresh = false);
getTableDefaultValues() public abstract method

指定されたテーブルのデフォルト値制約情報を取得します。

public abstract yii\db\DefaultValueConstraint[] getTableDefaultValues ( $name, $refresh = false )
$name 文字列

テーブル名。テーブル名には、スキーマ名が含まれる場合があります。テーブル名を引用符で囲まないでください。
$refresh ブール値

キャッシュ内に見つかった場合でも、情報を再読み込みするかどうか。
戻り値 yii\db\DefaultValueConstraint[]

テーブルのデフォルト値制約。

 

                public function getTableDefaultValues($name, $refresh = false);
getTableForeignKeys() public abstract method

指定されたテーブルの外部キー情報を取得します。

public abstract yii\db\ForeignKeyConstraint[] getTableForeignKeys ( $name, $refresh = false )
$name 文字列

テーブル名。テーブル名には、スキーマ名が含まれる場合があります。テーブル名を引用符で囲まないでください。
$refresh ブール値

キャッシュ内に見つかった場合でも、情報を再読み込みするかどうか。
戻り値 yii\db\ForeignKeyConstraint[]

テーブルの外部キー。

 

                public function getTableForeignKeys($name, $refresh = false);
getTableIndexes() public abstract method

指定されたテーブルのインデックス情報を取得します。

public abstract yii\db\IndexConstraint[] getTableIndexes ( $name, $refresh = false )
$name 文字列

テーブル名。テーブル名には、スキーマ名が含まれる場合があります。テーブル名を引用符で囲まないでください。
$refresh ブール値

キャッシュ内に見つかった場合でも、情報を再読み込みするかどうか。
戻り値 yii\db\IndexConstraint[]

テーブルのインデックス。

 

                public function getTableIndexes($name, $refresh = false);
getTablePrimaryKey() public abstract method

指定されたテーブルの主キーを取得します。

public abstract yii\db\Constraint|null getTablePrimaryKey ( $name, $refresh = false )
$name 文字列

テーブル名。テーブル名には、スキーマ名が含まれる場合があります。テーブル名を引用符で囲まないでください。
$refresh ブール値

キャッシュ内に見つかった場合でも、情報を再読み込みするかどうか。
戻り値 yii\db\Constraint|null

テーブルの主キー。テーブルに主キーがない場合はnull。

 

                public function getTablePrimaryKey($name, $refresh = false);
getTableUniques() public abstract method

指定されたテーブルの一意制約情報を取得します。

public abstract yii\db\Constraint[] getTableUniques ( $name, $refresh = false )
$name 文字列

テーブル名。テーブル名には、スキーマ名が含まれる場合があります。テーブル名を引用符で囲まないでください。
$refresh ブール値

キャッシュ内に見つかった場合でも、情報を再読み込みするかどうか。
戻り値 yii\db\Constraint[]

テーブルの一意制約。

 

                public function getTableUniques($name, $refresh = false);