[Groonga-commit] droonga/droonga.org at 1de723c [gh-pages] Fill parameters reference of droonga-engine-catalog-generate

Back to archive index

YUKI Hiroshi null+****@clear*****
Fri May 8 12:16:37 JST 2015


YUKI Hiroshi	2015-05-08 12:16:37 +0900 (Fri, 08 May 2015)

  New Revision: 1de723c8ddedb9e3b680dd4d2b1118a0fbe4badc
  https://github.com/droonga/droonga.org/commit/1de723c8ddedb9e3b680dd4d2b1118a0fbe4badc

  Message:
    Fill parameters reference of droonga-engine-catalog-generate

  Modified files:
    reference/1.1.1/command-line-tools/droonga-engine-catalog-generate/index.md

  Modified: reference/1.1.1/command-line-tools/droonga-engine-catalog-generate/index.md (+47 -1)
===================================================================
--- reference/1.1.1/command-line-tools/droonga-engine-catalog-generate/index.md    2015-05-08 11:48:22 +0900 (e6c302c)
+++ reference/1.1.1/command-line-tools/droonga-engine-catalog-generate/index.md    2015-05-08 12:16:37 +0900 (2d096be)
@@ -8,16 +8,62 @@ layout: en
 
 ## Abstract {#abstract}
 
+`droonga-engine-catalog-generate` generates new [`catalog.json` file](../../catalog/version2/) for a Droonga Engine node.
+
 (TBD)
 
 ## Parameters {#parameters}
 
-(TBD)
+`--output=PATH`
+: The output path of generated `catalog.json` to be saved as.
+  `-` means the standard output.
+  Any existing file at the specified path will be overwritten without confirmation.
+  It is the path to the `catalog.json` for the `droonga-engine` service on the computer (`/home/droonga-engine/droonga/catalog.json`), by default.
+
+`--dataset=NAME`
+: The name of a new dataset.
+  This can be specified multiple times to define multiple datasets.
+  `Default` by default.
+
+`--n-workers=N`
+: Number of workers for each volume in the dataset specified by the preceding `--dataset` option.
+  `4` by default.
+
+`--hosts=NAME1,NAME2,...`
+: Host names of engine nodes to be used as replicas in the dataset specified by the preceding `--dataset` option.
+  A single guessed host name of the computer you are running the command, by default.
+
+`--port=PORT`
+: Port number to communicate with engine nodes in the dataset specified by the preceding `--dataset` option.
+  `10031` by default.
+
+`--tag=TAG`
+: Tag name to communicate with engine nodes in the dataset specified by the preceding `--dataset` option.
+  `droonga` by default.
+
+`--n-slices=N`
+: Number of slices for each replica in the dataset specified by the preceding `--dataset` option.
+  `1` by default.
+
+`--plugins=PLUGIN1,PLUGIN2,...`
+: Plugin names activated for the dataset specified by the preceding `--dataset` option.
+  `groonga,search,crud,dump,system,catalog` (the list of all buit-in plugins) by default.
+
+`--schema=PATH`
+: The path to a JSON file including schema definition for the dataset specified by the preceding `--dataset` option.
+
+`--fact=TABLE`
+: Name of the fact table in the dataset specified by the preceding `--dataset` option.
+
+`--replicas=PATH`
+: The path to a JSON file including replicas definition for the dataset specified by the preceding `--dataset` option.
+  If this option is used, other options to define replicas in the dataset (`--hosts`, `--port`, `--tag` and `--n-slices`) are ignored.
 
 ## How to install {#install}
 
 This is installed as a part of a rubygems package `droonga-engine`.
 
+
 ~~~
 # gem install droonga-engine
 ~~~
-------------- next part --------------
HTML����������������������������...
Download 



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