[Groonga-commit] droonga/droonga.org at ed5f565 [gh-pages] Update description about command parameters: optional or not

Back to archive index

YUKI Hiroshi null+****@clear*****
Thu Dec 19 15:49:12 JST 2013


YUKI Hiroshi	2013-12-19 15:49:12 +0900 (Thu, 19 Dec 2013)

  New Revision: ed5f565f4adf09567ba31dd597f524fbe98c3d62
  https://github.com/droonga/droonga.org/commit/ed5f565f4adf09567ba31dd597f524fbe98c3d62

  Message:
    Update description about command parameters: optional or not

  Modified files:
    ja/reference/commands/add/index.md
    ja/reference/commands/search/index.md
    reference/commands/add/index.md
    reference/commands/search/index.md

  Modified: ja/reference/commands/add/index.md (+4 -7)
===================================================================
--- ja/reference/commands/add/index.md    2013-12-19 15:14:08 +0900 (a212b1f)
+++ ja/reference/commands/add/index.md    2013-12-19 15:49:12 +0900 (025f7f3)
@@ -142,8 +142,8 @@ Jobテーブル(主キー有り):
 値
 : テーブル名の文字列。
 
-指定の省略
-: 不可能。
+省略時の既定値
+: なし。このパラメータは必須です。
 
 ### `key` {#parameter-key}
 
@@ -153,8 +153,8 @@ Jobテーブル(主キー有り):
 値
 : 主キーとなる文字列。
 
-指定の省略
-: 対象のテーブルが主キーを持つ場合は省略不可能。
+省略時の初期値
+: なし。対象のテーブルが主キーを持つ場合、このパラメータは必須です。主キーがない場合、このパラメータは無視されます。
 
 既に同じ主キーを持つレコードが存在している場合は、レコードの各カラムの値を更新します。
 
@@ -168,9 +168,6 @@ Jobテーブル(主キー有り):
 値
 : カラム名をキー、カラムの値を値としたハッシュ。
 
-指定の省略
-: 可能。
-
 省略時の初期値
 : `null`
 

  Modified: ja/reference/commands/search/index.md (+4 -19)
===================================================================
--- ja/reference/commands/search/index.md    2013-12-19 15:14:08 +0900 (5b8ddb5)
+++ ja/reference/commands/search/index.md    2013-12-19 15:49:12 +0900 (7123cda)
@@ -578,9 +578,6 @@ Personテーブル:
 値
 : タイムアウトするまでの時間の数値(単位:ミリ秒)。
 
-指定の省略
-: 可能。
-
 省略時の初期値
 : 10000(10秒)
 
@@ -595,8 +592,8 @@ Personテーブル:
 値
 : 個々の検索クエリの名前をキー、[個々の検索クエリ](#query-parameters)の内容を値としたハッシュ。
 
-指定の省略
-: 不可能。
+省略時の初期値
+: なし。このパラメータは必須です。
 
 `search` は、複数の検索クエリを一度に受け取る事ができます。
 
@@ -612,8 +609,8 @@ Personテーブル:
 値
 : テーブル名の文字列、または結果を参照する別の検索クエリの名前の文字列。
 
-指定の省略
-: 不可能。
+省略時の初期値
+: なし。このパラメータは必須です。
 
 別の検索クエリの処理結果をデータソースとして指定する事により、ファセット検索などを行う事ができます。
 
@@ -633,9 +630,6 @@ Personテーブル:
   3. [クエリー構文](http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html)形式の文字列を含むハッシュ。
   4. 1〜3および演算子の文字列の配列。 
 
-指定の省略
-: 可能。
-
 省略時の既定値
 : なし(検索しない)。
 
@@ -754,9 +748,6 @@ Personテーブル:
   1. カラム名の文字列の配列。
   2. ソート条件と取り出すレコードの範囲を指定するハッシュ。 
 
-指定の省略
-: 可能。
-
 省略時の既定値
 : なし(ソートしない)。
 
@@ -824,9 +815,6 @@ Droongaはまず最初に指定したカラムの値でレコードをソート
   1. 基本的な集約条件(カラム名または式)の文字列。
   2. 複雑な集約条件を指定するハッシュ。 
 
-指定の省略
-: 可能。
-
 省略時の既定値
 : なし(集約しない)。
 
@@ -891,9 +879,6 @@ Droongaはそのカラムの値が同じであるレコードを集約し、カ
 値
 : 出力形式を指定するハッシュ。 
 
-指定の省略
-: 可能。
-
 省略時の既定値
 : なし(結果を出力しない)。
 

  Modified: reference/commands/add/index.md (+4 -7)
===================================================================
--- reference/commands/add/index.md    2013-12-19 15:14:08 +0900 (eebd084)
+++ reference/commands/add/index.md    2013-12-19 15:49:12 +0900 (a00c57b)
@@ -138,8 +138,8 @@ Abstract
 Value
 : A name string of an existing table.
 
-Required
-: Yes.
+Default value
+: Nothing. This is a required parameter.
 
 ### `key` {#parameter-key}
 
@@ -149,8 +149,8 @@ Abstract
 Value
 : A primary key string.
 
-Required
-: Yes, if the table has a primary key column. Otherwise no.
+Default value
+: Nothing. This is required if the table has a primary key column. Otherwise, this is ignored.
 
 Existing column values will be updated, if there is an existing record for the key.
 
@@ -164,9 +164,6 @@ Abstract
 Value
 : A hash. Keys of the hash are column names, values of the hash are new values for each column.
 
-Required
-: No. This is optional.
-
 Default value
 : `null`
 

  Modified: reference/commands/search/index.md (+1 -10)
===================================================================
--- reference/commands/search/index.md    2013-12-19 15:14:08 +0900 (026c3fd)
+++ reference/commands/search/index.md    2013-12-19 15:49:12 +0900 (95fb479)
@@ -748,9 +748,6 @@ Abstract
   1. カラム名の文字列の配列。
   2. ソート条件と取り出すレコードの範囲を指定するハッシュ。 
 
-指定の省略
-: 可能。
-
 省略時の既定値
 : なし(ソートしない)。
 
@@ -818,9 +815,6 @@ Abstract
   1. 基本的な集約条件(カラム名または式)の文字列。
   2. 複雑な集約条件を指定するハッシュ。 
 
-指定の省略
-: 可能。
-
 省略時の既定値
 : なし(集約しない)。
 
@@ -879,15 +873,12 @@ Droongaはそのカラムの値が同じであるレコードを集約し、カ
 
 #### `output` {#query-output}
 
-Abstract
+概要
 : 処理結果の出力形式を指定します。
 
 値
 : 出力形式を指定するハッシュ。 
 
-指定の省略
-: 可能。
-
 省略時の既定値
 : なし(結果を出力しない)。
 
-------------- next part --------------
HTML����������������������������...
Télécharger 



More information about the Groonga-commit mailing list
Back to archive index