YUKI Hiroshi
null+****@clear*****
Wed Dec 25 18:40:40 JST 2013
YUKI Hiroshi 2013-12-25 18:40:40 +0900 (Wed, 25 Dec 2013) New Revision: 46eb0ff76ca530974e7d9862c1742d387c49b979 https://github.com/droonga/droonga.org/commit/46eb0ff76ca530974e7d9862c1742d387c49b979 Message: Change heading of command references to more meaningful Syntax => Parameter syntax Parameters => Parameter details Modified files: reference/commands/add/index.md reference/commands/column-create/index.md reference/commands/search/index.md reference/commands/select/index.md reference/commands/table-create/index.md Modified: reference/commands/add/index.md (+24 -16) =================================================================== --- reference/commands/add/index.md 2013-12-25 18:32:44 +0900 (3d4999e) +++ reference/commands/add/index.md 2013-12-25 18:40:40 +0900 (5c548fc) @@ -19,7 +19,7 @@ Style `body` : A hash of parameters. -## Syntax {#syntax} +## Parameter syntax {#syntax} If the table has a primary key column: @@ -103,39 +103,47 @@ By the command above, a new record will be automatically added to the Job table Specify all parameters `table`, `values` and `key`, if the table has a primary key column. - add { - "table" : "Job", - "key" : "writer", - "values" : { - "label" : "writer" + "type" : "add", + "body" : { + "table" : "Job", + "key" : "writer", + "values" : { + "label" : "writer" + } } } - => add.result - true + => { + "type" : "add.result", + "body" : [true] + } ### Updating column values of an existing record {#updating} This command works as "updating" operation, if the table has a primary key column and there is an existing record for the specified key. - add { - "table" : "Job", - "key" : "doctor", - "values" : { - "label" : "doctor" + "type" : "add", + "body" : { + "table" : "Job", + "key" : "doctor", + "values" : { + "label" : "doctor" + } } } - => add.result - true + => { + "type" : "add.result", + "body" : [true] + } You cannot update column values of existing records, if the table has no primary key column. Then this command will always work as "adding" operation for the table. -## Parameters {#parameters} +## Parameter details {#parameters} ### `table` {#parameter-table} Modified: reference/commands/column-create/index.md (+2 -2) =================================================================== --- reference/commands/column-create/index.md 2013-12-25 18:32:44 +0900 (e8e412f) +++ reference/commands/column-create/index.md 2013-12-25 18:40:40 +0900 (ab47811) @@ -21,7 +21,7 @@ Style `body` : A hash of parameters. -## Syntax {#syntax} +## Parameter syntax {#syntax} { "table" : "<Name of the table>", @@ -31,7 +31,7 @@ Style "source" : "<Name of a column to be indexed>" } -## Parameters {#parameters} +## Parameter details {#parameters} All parameters except `table` and `name` are optional. Modified: reference/commands/search/index.md (+2 -2) =================================================================== --- reference/commands/search/index.md 2013-12-25 18:32:44 +0900 (09a0181) +++ reference/commands/search/index.md 2013-12-25 18:40:40 +0900 (10e3223) @@ -21,7 +21,7 @@ Style `body` : A hash of parameters. -## Syntax {#syntax} +## Parameter syntax {#syntax} { "timeout" : <Seconds to be timed out>, @@ -565,7 +565,7 @@ You can use search queries just internally, without output. For example, the fol } -## Parameters {#parameters} +## Parameter details {#parameters} ### Container parameters {#container-parameters} Modified: reference/commands/select/index.md (+2 -2) =================================================================== --- reference/commands/select/index.md 2013-12-25 18:32:44 +0900 (a93d66e) +++ reference/commands/select/index.md 2013-12-25 18:40:40 +0900 (f3185be) @@ -21,7 +21,7 @@ Style `body` : A hash of parameters. -## Syntax {#syntax} +## Parameter syntax {#syntax} { "table" : "<Name of the table>", @@ -46,7 +46,7 @@ Style "query_expander" : "<Arguments to expanding queries>" } -## Parameters {#parameters} +## Parameter details {#parameters} All parameters except `table` are optional. Modified: reference/commands/table-create/index.md (+2 -2) =================================================================== --- reference/commands/table-create/index.md 2013-12-25 18:32:44 +0900 (1110782) +++ reference/commands/table-create/index.md 2013-12-25 18:40:40 +0900 (e7eb406) @@ -21,7 +21,7 @@ Style `body` : A hash of parameters. -## Syntax {#syntax} +## Parameter syntax {#syntax} { "name" : "<Name of the table>", @@ -32,7 +32,7 @@ Style "normalizer" : "<Normalizer>" } -## Parameters {#parameters} +## Parameter details {#parameters} All parameters except `name` are optional. -------------- next part -------------- HTML����������������������������...Download
