[Groonga-commit] groonga/groonga [master] fix out-dated table_list document.

Zurück zum Archiv-Index

null+****@clear***** null+****@clear*****
2011年 3月 27日 (日) 16:43:52 JST


Kouhei Sutou	2011-03-27 07:43:52 +0000 (Sun, 27 Mar 2011)

  New Revision: ed2e9685dd61bcda40f356880a7f3a19674cdb54

  Log:
    fix out-dated table_list document.

  Modified files:
    doc/ja/source/commands/column_list.txt
    doc/ja/source/commands/table_list.txt

  Modified: doc/ja/source/commands/column_list.txt (+2 -3)
===================================================================
--- doc/ja/source/commands/column_list.txt    2011-03-27 07:36:47 +0000 (dab1639)
+++ doc/ja/source/commands/column_list.txt    2011-03-27 07:43:52 +0000 (9045792)
@@ -37,12 +37,11 @@ json形式
 
 カラム名一覧を以下の形式で返却します。::
 
-  [[[カラム情報名1,カラム情報型1],...], [カラム情報1,...]]
+  [[[カラム情報名1,カラム情報型1],...], カラム情報1,...]
 
 ``カラム情報名n``
 
-  ``カラム情報n`` には複数の情報が含まれています。
-  それぞれの情報がどんな内容かを示す名前を出力します。
+  ``カラム情報n`` には複数の情報が含まれますが、そこに入る情報がどんな内容かを示す名前を出力します。
   情報名は以下の通りです。
 
   ``id``

  Modified: doc/ja/source/commands/table_list.txt (+42 -27)
===================================================================
--- doc/ja/source/commands/table_list.txt    2011-03-27 07:36:47 +0000 (0ef742f)
+++ doc/ja/source/commands/table_list.txt    2011-03-27 07:43:52 +0000 (a37062c)
@@ -34,51 +34,47 @@ table_listは、DBに定義されているテーブルのリストを表示し
 json形式
 ^^^^^^^^
 
-::
-  テーブル名一覧が以下の形式で返却されます。
-
-    [[検索件数], [[カラム名1,カラム型1],..], 検索結果1,..]
-
-  ``検索件数``
+テーブル名一覧が以下の形式で返却されます。::
 
-    検索件数が出力されます。
+  [[[テーブル情報名1,テーブル情報型1],...], テーブル情報1,...]
 
-  ``カラム名n``
+``テーブル情報名n``
 
-    output_columnsに指定された条件に従って、対象となるカラム名が出力されます。
-    カラム名ごとに格納されている情報は、以下のとおりです。
+  ``テーブル情報n`` には複数の情報が含まれますが、そこに入る情報がどんな内容かを示す名前を出力します。
+  情報名は以下の通りです。
 
-    ``id``
+  ``id``
 
-      テーブルオブジェクトに割り当てられたID
+    テーブルオブジェクトに割り当てられたID
 
-    ``name``
+  ``name``
 
-      テーブル名
+    テーブル名
 
-    ``path``
+  ``path``
 
-      テーブルのレコードを格納するファイル名
+    テーブルのレコードを格納するファイル名
 
-    ``flags``
+  ``flags``
 
-      テーブルのflags属性
+    テーブルのflags属性
 
-    ``domain``
+  ``domain``
 
-      主キー値の属する型のID
+    主キー値の属する型
 
-    ``range``
+  ``range``
 
-      range
+    valueが属する型
 
-  ``カラム型n``
+``テーブル情報型n``
 
-    output_columnsに指定された条件に従って、対象となるカラム型が出力されます。
+  テーブル情報の型を出力します。
 
-  ``テーブル情報n``
+``テーブル情報n``
 
-    テーブル情報が出力されます。
+  ``テーブル情報名n`` で示された情報の配列を出力します。
+  情報の順序は ``テーブル情報名n`` の順序と同じです。
 
 例
 --
@@ -86,4 +82,23 @@ json形式
 
  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"]]
+ [[["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"]]
+
+注: 実際は改行が入りません。




Groonga-commit メーリングリストの案内
Zurück zum Archiv-Index