truncate_table

(CDBT 2.0.0)

truncate_tableテーブルに含まれる全データを削除します

Description

bool truncate_table ( string $table_name )
テーブルに含まれる全データを削除して、テーブルを初期化します。削除に成功した場合、truncate_table()はTRUEを返します。

Parameters

table_name
全データの削除を行うテーブル名。

Return

テーブルの初期化に成功した場合にTRUEを、失敗した場合にはFALSEを返します。

History

バージョン 内容
2.0.0 CDBT v1の同名メソッドをリファクタリング

Example

<?php
global $cdbt;
$table_name = "prefix_table";
if ( $cdbt->truncate_table( $table_name ) ) {
  echo "The table of $table_name was truncated.";
} else {
  echo "The $table_name truncation was failed.";
}

Caution

truncate_table()で初期化されるテーブルに自動採番（AUTOINCRIMENT）のプライマリ・キー等が存在する場合、データ削除とともに発番番号がリセットされます。

Included Hooks

Reference

Related Methods