DB - Classes - FuelPHP Documentation

DB クラス

DB クラスは、データベースクエリの生成と実行および結果の取得を行います。

query($query)

query メソッドは、新しい Database_Query オブジェクトを返します。

Static Yes

パラメータ

引数	規定値	説明
`$query`	必須	SQL クエリ

返り値 Database_Query_Builder_Select オブジェクトを返します。

例

// Will prepare: SELECT * FROM `users`
$query = DB::query('SELECT * FROM `users`');

last_query()

last_query メソッドは、最後に実行した SQL クエリを返します。

Static Yes

パラメータ

引数	規定値	説明
`$db`	null	データベースコネクション

返り値最後に実行した SQL クエリ

例

// クエリを実行する
$user = DB::select()->from('users')->where('id', 1);

echo DB::last_query();
// SELECT * FROM `users` WHERE `id` = 1

select()

select メソッドは、新しい Database_Query_Builder_Select オブジェクトを返します。

Static Yes

パラメータ

引数	規定値	説明
`$columns`	null	select するカラム

返り値 Database_Query_Builder_Select オブジェクト

例

// Will prepare: SELECT *
$query = DB::select();

// Will prepare: SELECT `id`, `name`
$query = DB::select('id', 'name');

select_array($columns)

select_array メソッドは、新しい Database_Query_Builder_Select オブジェクトを返します。

Static Yes

パラメータ

引数	規定値	説明
`$columns`	array();	select するカラムの配列

返り値 Database_Query_Builder_Select オブジェクト

例

// Will prepare: SELECT *
$query = DB::select_array();

// Will prepare: SELECT `id`, `name`
$query = DB::select_array(array('id', 'name'));

insert($table = null, $columns = array())

insert メソッドは、新しい Database_Query_Builder_Insert オブジェクトを返します。

Static Yes

パラメータ

引数	規定値	説明
`$table`	null	The table to insert into.
`$columns`	array();	Array of columns to select.

返り値 Database_Query_Builder_Insert オブジェクト

例

// Will prepare: INSERT INTO `table_name`
$query = DB::insert('table_name');

// Will prepare: INSERT INTO `table_name` (`id`, `name`)
$query = DB::insert('table_name', array('id', 'name'));

update($table = null)

update メソッドは、新しい Database_Query_Builder_Update オブジェクトを返します。

Static Yes

パラメータ

引数	規定値	説明
`$table`	null	update するテーブル

返り値 Database_Query_Builder_Update オブジェクト

例

// Will prepare: UPDATE `table_name`
$query = DB::update('table_name');

delete($table = null)

delete メソッドは、新しい Database_Query_Builder_Delete オブジェクトを返します。

Static Yes

パラメータ

引数	規定値	説明
`$table`	null	delete 元のテーブル

返り値 Database_Query_Builder_Delete オブジェクト

例

// Will prepare: DELETE FROM `table_name`
$query = DB::delete('table_name');

expr($expression)

expr メソッドは、新しい Database_Expression オブジェクトを返します。

Static Yes

パラメータ

引数	規定値	説明
`$expression`	null	式

返り値 Database_Expression オブジェクト

例

// returns new Database_Expression('COUNT(table_name.table_column)');
$query = DB::expr('COUNT(table_name.table_column)');

quote($string, $db = null)

quote メソッドは、クオートで囲まれた SQL クエリ文字列を返します。

Static Yes

パラメータ

引数	規定値	説明
`$string`	必須	クオートで囲う文字列
`$db`	null	データベースコネクション

返り値 Database_Expression オブジェクト

例

// 返り値: 'something\'s quoted'
$query = DB::quote("'something's quoted'");

// 返り値: 'something\'s quoted' (定義済みのデータベースコネクションで)
$query = DB::quote("'something's quoted'", $db_connection);

quote_identifier($string, $db)

quote_identifier メソッドは、クオートで囲まれた SQL クエリ文字列を返します。

Static Yes

パラメータ

引数	規定値	説明
`$string`	必須	クオートで囲う文字列または配列
`$db`	null	データベースコネクション

返り値クオートで囲まれた SQL 文字列

例

// `users`.`name`
print_r(DB::quote_identifier('users.name'));

// array(
//    [0] => `users`.`name`
// )
print_r(DB::quote_identifier(array('users.name')));

quote_table($string, $db = null)

quote_table メソッドは、クオートで囲まれた SQL クエリ文字列を返します。

Static Yes

パラメータ

引数	規定値	説明
`$string`	必須	クオートで囲う文字列または配列
`$db`	null	データベースコネクション

返り値クオートで囲まれた SQL 文字列

例

// `users`
print_r(DB::quote_table('users'));

// array(
//    [0] => `users`
// )
print_r(DB::quote_identifier(array('users')));

table_prefix($table, $db = null)

table_prefix メソッドは、設定された接頭辞を付加したテーブル名を返します。 If not, then just the prefix is returned.

Static Yes

パラメータ

引数	規定値	説明
`$table`	必須	接頭辞を付加するテーブル名
`$db`	null	データベースコネクション

返り値接頭辞が付加されたテーブル名もしくはテーブル名

例

// prefixed_table_name
print_r(DB::table_prefix('table_name'));

escape($string, $db = null)

escape メソッドは、エスケープされた SQL クエリ文字列を返します。

Static Yes

パラメータ

引数	規定値	説明
`$string`	必須	エスケープする文字列
`$db`	null	データベースコネクション

返り値エスケープされた SQL クエリ文字列

例

// 'or *\' \"'
print_r(DB::escape('or *\' "'));

list_columns($table, $like = null, $db = null)

list_columns メソッドは、テーブル内のすべてのカラムのリストを返します。オプションで、特定のフィールドの検索に LIKE 文字列を使うこともできます。

Static Yes

パラメータ

引数	規定値	説明
`$table`	null	中を見るテーブル
`$like`	null	検索するカラム
`$db`	null	データベースコネクション

返り値フィールドのデータの配列

例

/*
Array
(
	[id] => Array
	(
		[type] => int
		[min] => -2147483648
		[max] => 2147483647
		[column_name] => id
		[column_default] =>
		[data_type] => int
		[is_nullable] =>
		[ordinal_position] => 1
		[display] => 255
		[comment] =>
		[extra] => auto_increment
		[key] => PRI
		[privileges] => select,insert,update,references
	)

	[name] => Array
	(
		[type] => string
		[column_name] => name
		[column_default] =>
		[data_type] => varchar
		[is_nullable] =>
		[ordinal_position] => 3
		[character_maximum_length] => 255
		[collation_name] => utf8_unicode_ci
		[comment] =>
		[extra] =>
		[key] =>
		[privileges] => select,insert,update,references
	)
)
*/
print_r(DB::list_columns('users'));

/*
Array
(
	[name] => Array
	(
		[type] => string
		[column_name] => name
		[column_default] =>
		[data_type] => varchar
		[is_nullable] =>
		[ordinal_position] => 3
		[character_maximum_length] => 255
		[collation_name] => utf8_unicode_ci
		[comment] =>
		[extra] =>
		[key] =>
		[privileges] => select,insert,update,references
	)
)
*/
print_r(DB::list_columns('users','%name%'));

list_tables($like = null, $db = null)

list_tables メソッドは、データベース内のすべてのテーブルのリストを返します。オプションで、特定のテーブルの検索に LIKE 文字列を使うこともできます。

Static Yes

パラメータ

引数	規定値	説明
`$like`	null	The table to search for.
`$db`	null	データベースコネクション

返り値テーブル名の配列

例

/*
Array
(
    [0] => areas
    [1] => fuel_sessions
    [2] => config
    [3] => files
)
*/
DB::list_tables();

/*
Array
(
    [0] => fuel_sessions

)
*/
DB::list_tables('%sessions%');

datatype($type, $db = null)

The datatype method returns a normalized array describing the SQL data type.

Static Yes

パラメータ

引数	規定値	説明
`$type`	必須	The SQL data type.
`$db`	null	データベースコネクション

返り値 Returns a normalized array describing the SQL data type.

例

/*
Array
(
    [type] => string
    [exact] => 1
)
*/
DB::datatype('char');

count_records($table, $db = null)

count_records メソッドは、テーブルのレコード数を返します。

Static Yes

パラメータ

引数	規定値	説明
`$table`	必須	カウント元のテーブル
`$db`	null	データベースコネクション

返り値テーブルのレコード数

例

// (int) 14
DB::count_records('users');

count_last_query($db = null)

count_last_query メソッドは、LIMIT や OFFSET 句を取り除いた、最後のクエリでのレコードの行数を返します。

Static Yes

パラメータ

引数	規定値	説明
`$db`	null	データベースコネクション

返り値 LIMIT や OFFSET 句を取り除いた、最後のクエリでのレコードの行数

例

// SELECT * FROM `users` WHERE `active` = "yes" LIMIT 10;
$limited_result = DB::select()->from('users')->where('active', '=', 'yes')->limit(10)->execute();

// SELECT count(*) as count FROM `users` WHERE `active` = "yes";
DB::count_last_query();

set_charset($charset, $db)

set_charset メソッドは、コネクションの文字セットを設定します。This is called automatically by [static::connect].

Static Yes

パラメータ

引数	規定値	説明
`$charset`	必須	文字セットの名前
`$db`	null	データベースコネクション

返り値なし

例

DB::set_charset('utf8');

in_transaction($db = null)

in_transaction メソッドは、コネクションがトランザクションの中にあるかどうかチェックします。

Static Yes

パラメータ

引数	規定値	説明
`$db`	null	データベースコネクション

返り値 bool - PDO ドライバでのみ有効。トランザクションの中なら true、そうでなければ false を返す。

例

DB::in_transaction();

start_transaction($db = null)

start_transaction メソッドは、そのインスタンスでトランザクションを開始します。

Static Yes

パラメータ

引数	規定値	説明
`$db`	null	データベースコネクション

返り値 bool - PDO ドライバでのみ有効。常に true を返すが、SQL コマンドが失敗した場合は例外を投げる。

例

DB::start_transaction();

commit_transaction($db = null)

commit_transaction メソッドは、未決のすべてのトランザクションクエリをコミットします。

Static Yes

パラメータ

引数	規定値	説明
`$db`	null	データベースコネクション

返り値 bool - PDO ドライバでのみ有効。常に true を返すが、SQL コマンドが失敗した場合は例外を投げる。

例

DB::commit_transaction();

rollback_transaction($db = null)

rollback_transaction メソッドは、未決のすべてのトランザクションクエリをロールバックします。

Static Yes

パラメータ

引数	規定値	説明
`$db`	null	データベースコネクション

返り値 bool - PDO ドライバでのみ有効。常に true を返すが、SQL コマンドが失敗した場合は例外を投げる。

例

DB::rollback_transaction();

トランザクションの例

// 典型的なトランザクションコードの流れ
try
{
    DB::start_transaction();

    // 何らかのクエリ...

    DB::commit_transaction();

    // クエリの結果を返す
}
catch (Exception $e)
{
    // 未決のトランザクションクエリをロールバックする
    DB::rollback_transaction();

    throw $e;
}