diff options
Diffstat (limited to 'src/third_party/wiredtiger/src/docs/command-line.dox')
| -rw-r--r-- | src/third_party/wiredtiger/src/docs/command-line.dox | 121 |
1 files changed, 60 insertions, 61 deletions
diff --git a/src/third_party/wiredtiger/src/docs/command-line.dox b/src/third_party/wiredtiger/src/docs/command-line.dox index 5c96796ed72..65858507b60 100644 --- a/src/third_party/wiredtiger/src/docs/command-line.dox +++ b/src/third_party/wiredtiger/src/docs/command-line.dox @@ -3,7 +3,7 @@ WiredTiger includes a command line utility, \c wt. @section util_global_synopsis SYNOPSIS -<code>wt [-BLRrVv] [-C config] [-E secretkey ] [-h directory] command [command-specific arguments]</code> +`wt [-BLRrVv] [-C config] [-E secretkey ] [-h directory] command [command-specific arguments]` @section util_global_description DESCRIPTION The \c wt tool is a command-line utility that provides access to @@ -12,25 +12,25 @@ various pieces of the WiredTiger functionality. @section util_global_options OPTIONS There are several global options: -@par <code>-B</code> +@par \c -B Maintain release 3.3 log file compatibility. -@par <code>-C config</code> +@par \c -C config Specify configuration strings for the ::wiredtiger_open function. -@par <code>-E secretkey</code> +@par \c -E secretkey Specify an encryption secret key for the ::wiredtiger_open function. -@par <code>-h directory</code> +@par \c -h directory Specify a database home directory. -@par <code>-L</code> +@par \c -L Forcibly turn off logging subsystem for debugging purposes. -@par <code>-m</code> +@par \c -m Verify the WiredTiger metadata as part of opening the database. -@par <code>-R</code> +@par \c -R Run recovery if the underlying database is configured to do so. -@par <code>-r</code> +@par \c -r Access the database via a readonly connection -@par <code>-V</code> +@par \c -V Display WiredTiger version and exit. -@par <code>-v</code> +@par \c -v Set verbose output. Unless otherwise described by a \c wt command, the \c wt tool exits zero @@ -51,7 +51,7 @@ any of the existing database objects. Alter a table. @subsection util_alter_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] alter uri configuration ...</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] alter uri configuration ...` The \c uri and \c configuration pairs may be specified to the \c alter command. These configuration pairs can be used to modify the @@ -89,12 +89,12 @@ opened as a WiredTiger database. See @ref backup for more information, and @ref file_permissions for specifics on the copied file permissions. @subsection util_backup_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] backup [-t uri] directory</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] backup [-t uri] directory` @subsection util_backup_options Options The following are command-specific options for the \c backup command: -@par <code>-t uri</code> +@par \c -t uri By default, the \c backup command does a backup of the entire database; the \c -t option changes the \c backup command to do a backup of only the named data sources. @@ -107,7 +107,7 @@ The \c compact command attempts to rewrite the specified table to consume less disk space. @subsection util_compact_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] compact uri</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] compact uri` @subsection util_compact_options Options The \c compact command has no command-specific options. @@ -121,12 +121,12 @@ configuration. It is equivalent to a call to WT_SESSION::create with the specified string arguments. @subsection util_create_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] create [-c config] uri</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] create [-c config] uri` @subsection util_create_options Options The following are command-specific options for the \c create command: -@par <code>-c</code> +@par \c -c Include a configuration string to be passed to WT_SESSION::create. <hr> @@ -136,12 +136,12 @@ Downgrade a database. The \c downgrade command downgrades the database to the specified compatibility version. @subsection util_downgrade_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] downgrade -V version</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] downgrade -V version` @subsection util_downgrade_options Options The following are command-specific options for the \c downgrade command: -@par <code>-V version</code> +@par \c -V version The \c -V option is required, and specifies the version to which the database is downgraded. <hr> @@ -152,7 +152,7 @@ The \c drop command drops the specified \c uri. It is equivalent to a call to WT_SESSION::drop with the "force" configuration argument. @subsection util_drop_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] drop uri</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] drop uri` @subsection util_drop_options Options The \c drop command has no command-specific options. @@ -167,38 +167,38 @@ which can be re-loaded into a new table using the \c load command. See @subpage dump_formats for details of the dump file formats. @subsection util_dump_synopsis Synopsis -<code>wt [-RrVv] [-C config] [-E secretkey ] [-h directory] dump [-jprx] [-c checkpoint] [-f output] [-t timestamp] uri</code> +`wt [-RrVv] [-C config] [-E secretkey ] [-h directory] dump [-jprx] [-c checkpoint] [-f output] [-t timestamp] uri` @subsection util_dump_options Options The following are command-specific options for the \c dump command: -@par <code>-c</code> +@par \c -c By default, the \c dump command opens the most recent version of the data source; the \c -c option changes the \c dump command to dump as of the named checkpoint. -@par <code>-f</code> +@par \c -f By default, the \c dump command output is written to the standard output; the \c -f option re-directs the output to the specified file. -@par <code>-j</code> +@par \c -j Dump in JSON (<a href="http://www.json.org">JavaScript Object Notation</a>) format. -@par <code>-p</code> +@par \c -p Dump in human-readable format (pretty-print). The \c -p flag is incompatible with the \c load command. The \c -p flag can be combined with \c -x. In this case, raw data elements will be formatted like \c -x with hexadecimal encoding. -@par <code>-r</code> +@par \c -r Dump in reverse order, from largest key to smallest. -@par <code>-t</code> +@par \c -t By default, the \c dump command opens the most recent version of the data source; the \c -t option changes the \c dump command to dump as of the specified timestamp. -@par <code>-x</code> +@par \c -x Dump all characters in a hexadecimal encoding (the default is to leave printable characters unencoded). The \c -x flag can be combined with \c -p. In this case, the dump will be formatted similar to \c -p except for raw data elements, which will look like \c -x with @@ -214,16 +214,16 @@ database. If a URI is specified as an argument, only information about that data source is printed. @subsection util_list_synopsis Synopsis -<code>wt [-RrVv] [-C config] [-E secretkey ] [-h directory] list [-cv] [uri]</code> +`wt [-RrVv] [-C config] [-E secretkey ] [-h directory] list [-cv] [uri]` @subsection util_list_options Options The following are command-specific options for the \c list command: -@par <code>-c</code> +@par \c -c If the \c -c option is specified, the data source's checkpoints are printed in a human-readable format. -@par <code>-v</code> +@par \c -v If the \c -v option is specified, the data source's complete schema table value is printed. @@ -242,32 +242,32 @@ to make an attempt to overwrite existing data return an error). Existing keys will not be removed. @subsection util_load_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] load [-ajn] [-f input] [-r name] [uri configuration ...]</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] load [-ajn] [-f input] [-r name] [uri configuration ...]` @subsection util_load_options Options The following are command-specific options for the \c load command: -@par <code>-a</code> +@par \c -a If the \c -a option is specified, record number keys in the input are ignored and the data is appended to the data source and assigned new record number keys. The \c -a option is only applicable when loading into a column store. -@par <code>-f</code> +@par \c -f By default, the \c load command reads from the standard input; the \c -f option reads the input from the specified file. -@par <code>-j</code> +@par \c -j Load input in the JSON (<a href="http://www.json.org">JavaScript Object -Notation</a>) format that was created by the <code>dump -j</code> command. +Notation</a>) format that was created by the \c dump -j command. -@par <code>-n</code> +@par \c -n By default, input data will overwrite existing data where the key/value pair already exists in the data source; the \c -n option causes the \c load command to fail if there's an attempt to overwrite already existing data. -@par <code>-r</code> +@par \c -r By default, the \c load command uses the table name taken from the input; the \c -r option renames the data source. @@ -317,12 +317,12 @@ with matching keys. For either column-store or row-store tables, existing keys will not be removed. @subsection util_loadtext_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] loadtext [-f input] uri</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] loadtext [-f input] uri` @subsection util_loadtext_options Options The following are command-specific options for the \c loadtext command: -@par <code>-f</code> +@par \c -f By default, the \c loadtext command reads from the standard input; the \c -f option reads the input from the specified file. @@ -334,22 +334,22 @@ data are redacted. The \c printlog command outputs the database log. @subsection util_printlog_synopsis Synopsis -<code>wt [-RrVv] [-C config] [-E secretkey ] [-h directory] printlog [-mux] [-f output]</code> +\c wt [-RrVv] [-C config] [-E secretkey ] [-h directory] printlog [-mux] [-f output] @subsection util_printlog_options Options The following are command-specific options for the \c printlog command: -@par <code>-f</code> +@par \c -f By default, the \c printlog command output is written to the standard output; the \c -f option re-directs the output to the specified file. -@par <code>-m</code> +@par \c -m Print only message-type log records. -@par <code>-u</code> +@par \c -u Display user data. -@par <code>-x</code> +@par \c -x Keys and value items in the log are printed in hex format in addition to the default string format. @@ -364,7 +364,7 @@ with string or record number keys and string values. The \c read command exits non-zero if a specified record is not found. @subsection util_read_synopsis Synopsis -<code>wt [-RrVv] [-C config] [-E secretkey ] [-h directory] read uri key ...</code> +`wt [-RrVv] [-C config] [-E secretkey ] [-h directory] read uri key ...` @subsection util_read_options Options The \c read command has no command-specific options. @@ -376,7 +376,7 @@ Rename a table. The \c rename command renames the specified table. @subsection util_rename_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] rename uri name</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] rename uri name` @subsection util_rename_options Options The \c rename command has no command-specific options. @@ -390,12 +390,12 @@ data that cannot be recovered. Underlying files are re-written in place, overwriting the original file contents. @subsection util_salvage_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] salvage [-F] uri</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] salvage [-F] uri` @subsection util_salvage_options Options The following are command-specific options for the \c salvage command: -@par <code>-F</code> +@par \c -F By default, salvage will refuse to salvage tables that fail basic tests (for example, tables that don't appear to be in a WiredTiger format). The \c -F option forces the salvage of the table, regardless. @@ -408,14 +408,14 @@ The \c stat command outputs run-time statistics for the WiredTiger engine, or, if specified, for the URI on the command-line. @subsection util_stat_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] stat [-f] [uri]</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] stat [-f] [uri]` @subsection util_stat_options Options The following are command-specific options for the \c stat command: -@par <code>-f</code> +@par \c -f Include only "fast" statistics in the output (equivalent to passing -<code>statistics=(fast)</code>) to WT_SESSION::open_cursor. +`statistics=(fast))` to WT_SESSION::open_cursor. <hr> @section util_truncate wt truncate @@ -425,7 +425,7 @@ The \c truncate command truncates the specified \c uri. It is equivalent to a call to WT_SESSION::truncate with no start or stop specified. @subsection util_truncate_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] truncate uri</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] truncate uri` @subsection util_truncate_options Options The \c truncate command has no command-specific options. @@ -439,7 +439,7 @@ the data source is up-to-date, and failure if the data source cannot be upgraded. @subsection util_upgrade_synopsis Synopsis -<code>wt [-RVv] [-C config] [-E secretkey ] [-h directory] upgrade uri</code> +`wt [-RVv] [-C config] [-E secretkey ] [-h directory] upgrade uri` @subsection util_upgrade_options Options The \c upgrade command has no command-specific options. @@ -452,16 +452,16 @@ The \c verify command verifies the specified table, exiting success if the data source is correct, and failure if the data source is corrupted. @subsection util_verify_synopsis Synopsis -<code>wt [-RrVv] [-C config] [-E secretkey ] [-h directory] verify [-s] [-d dump_address | dump_blocks | dump_layout | dump_offsets=#,# | dump_pages ] [uri]</code> +`wt [-RrVv] [-C config] [-E secretkey ] [-h directory] verify [-s] [-d dump_address | dump_blocks | dump_layout | dump_offsets=#,# | dump_pages ] [uri]` @subsection util_verify_options Options The following are command-specific options for the \c verify command: -<code>-d [config]</code> +\c -d [config] This option allows you to specify values which you want to be displayed when verification is run. See the WT_SESSION::verify configuration options. -<code>-s</code> +\c -s This option allows you to verify against the stable timestamp, valid only after a rollback-to-stable operation. See the WT_SESSION::verify configuration options. @@ -481,19 +481,18 @@ the \c -a option, the command-line arguments are key/value pairs. Attempting to overwrite an already existing record will fail. @subsection util_write_synopsis Synopsis -<code> +\c wt [-RVv] [-C config] [-E secretkey ] [-h directory] write -a uri value ... <br> wt [-RVv] [-C config] [-E secretkey ] [-h directory] write [-o] uri key value ... -</code> @subsection util_write_options Options The following are command-specific options for the \c write command: -@par <code>-a</code> +@par \c -a Append each value as a new record in the data source. -@par <code>-o</code> +@par \c -o By default, attempting to overwrite an already existing record will fail. The \c -o option changes \c write to overwrite previously existing records. |