7.3.39. object_exist

7.3.39.1. 概要

バージョン 5.0.6 で追加.

object_exist は指定した名前のオブジェクトがデータベースに存在するかどうかを返します。

これは軽い操作です。データベース内に名前が存在するかだけをチェックします。ディスクから該当オブジェクトをロードしません。

object_exist はオブジェクトの種類をチェックしません。存在しているオブジェクトはテーブルかもしれませんし、カラムや関数かもしれません。

7.3.39.2. 構文

このコマンドの引数は1つで必須です:

object_exist name

7.3.39.3. 使い方

データベース内で指定した名前がすでに使われているかをチェックできます。

実行例:

object_exist Users
# [[0, 1337566253.89858, 0.000355720520019531], false]
table_create Users TABLE_HASH_KEY ShortText
# [[0, 1337566253.89858, 0.000355720520019531], true]
object_exist Users
# [[0, 1337566253.89858, 0.000355720520019531], true]

object_exist UsersUsers テーブルを作る前は false を返します。

object_exist UsersUsers テーブルを作った後は true を返します。

7.3.39.4. 引数

このセクションではすべての引数について説明します。

7.3.39.4.1. 必須引数

1つだけ必須の引数があります。

7.3.39.4.1.1. name

チェック対象のオブジェクト名を指定してください。

カラムが存在するかどうかをチェックしたいときは、次のように テーブル名.カラム名 という書式を使ってください。

実行例:

table_create Logs TABLE_NO_KEY
# [[0, 1337566253.89858, 0.000355720520019531], true]
column_create Logs timestamp COLUMN_SCALAR Time
# [[0, 1337566253.89858, 0.000355720520019531], true]
object_exist Logs.timestamp
# [[0, 1337566253.89858, 0.000355720520019531], true]

Logs.timestamp 内の Logs がテーブル名で timestamp がカラム名です。

7.3.39.4.2. 省略可能引数

省略可能な引数はありません。

7.3.39.5. 戻り値

データベース内に指定した名前のオブジェクトが存在するときは、このコマンドは以下のようにボディとして true を返します:

[HEADER, true]

そうでない場合は false を返します:

[HEADER, false]

HEADER については 出力形式 を参照してください。