- Custom DataBase Tables
- CDBT Version 2.x
- メソッド・リファレンス
- get_table_schema
get_table_schema
(CDBT 2.0.0)
get_table_schema指定テーブルのカラム構造情報を取得します
Description
mixed get_table_schema ( string $table_name [, string $db_name ] )指定されたテーブルのカラム構造情報をデータベースのインフォメーション・スキーマから取得します。テーブル・スキーマを取得した場合、
get_table_schema()はキー・バリュー型の連想配列を返します。Parameters
- table_name
- テーブル・スキーマを取得したいテーブル名。
- db_name
- データベース名。省略時はWordPressの定数DB_NAMEが指定されます。
Return
指定したテーブルのテーブル・スキーマが存在していた場合、テーブルのカラム名をキーとしたカラム構造情報の連想配列を返します。テーブル・スキーマが取得できなかった場合はFALSEを返します。
取得できる各カラムのスキーマの内容:
- logical_name ─ 論理名としてカラムのコメントが入る
- max_length ─ 数値型、文字列型、日時型のカラムの場合、格納値の最大数
- octet_length ─ 数値型のカラムの場合、格納値の最大数(8ビット値)
- not_null ─ NULLを許可しないカラムかどうか(真偽値)
- default ─ カラムの初期値
- type ─ カラムのデータ型
- type_format ─ カラムのデータ型(詳細)
- primary_key ─ プライマリ・キーインデックスを持つカラムかどうか(真偽値)
- column_key ─ カラムが持つキー/インデックス
- unsigned ─ 数値型カラムの場合にUNSIGNED属性を持っているかどうか(真偽値)
- extra ─ その他の定義値
History
| バージョン | 内容 |
|---|---|
| 2.0.0 | CDBT v1の同名メソッドをリファクタリング |
Example
<?php
global $cdbt;
$table_name = "prefix_table";
if ( $table_schema = $cdbt->get_table_schema( $table_name ) ) {
print_r( $table_schema );
}