.. -*- rst -*-

.. highlightlang:: none

table_list
==========

名前
----

table_list - DBに定義されているテーブルをリスト表示

書式
----
::

 table_list

説明
----

groonga組込コマンドの一つであるtable_listについて説明します。組込コマンドは、groonga実行ファイルの引数、標準入力、またはソケット経由でgroongaサーバにリクエストを送信することによって実行します。

table_listは、DBに定義されているテーブルのリストを表示します。

引数
----

ありません。

返値
----

json形式
^^^^^^^^

テーブル名一覧が以下の形式で返却されます。::

  [[[テーブル情報名1,テーブル情報型1],...], テーブル情報1,...]

``テーブル情報名n``

  ``テーブル情報n`` には複数の情報が含まれますが、そこに入る情報がどんな内容かを示す名前を出力します。
  情報名は以下の通りです。

  ``id``

    テーブルオブジェクトに割り当てられたID

  ``name``

    テーブル名

  ``path``

    テーブルのレコードを格納するファイル名

  ``flags``

    テーブルのflags属性

  ``domain``

    主キー値の属する型

  ``range``

    valueが属する型

``テーブル情報型n``

  テーブル情報の型を出力します。

``テーブル情報n``

  ``テーブル情報名n`` で示された情報の配列を出力します。
  情報の順序は ``テーブル情報名n`` の順序と同じです。

例
--
::

 table_list Entry

 [[["id", "UInt32"],
   ["name","ShortText"],
   ["path","ShortText"],
   ["flags","ShortText"],
   ["domain", "ShortText"],
   ["range","ShortText"]],
  [256,
   "Entry",
   "test.db.0000100",
   "TABLE_HASH_KEY|PERSISTENT",
   "ShortText",
   "null"],
  [257,
   "Term",
   "test.db.0000101",
   "TABLE_PAT_KEY|KEY_NORMALIZE|PERSISTENT",
   "ShortText",
   "null"]]

注: 実際は改行が入りません。