Skip to content

Latest commit

 

History

History
146 lines (115 loc) · 3.37 KB

readme.md

File metadata and controls

146 lines (115 loc) · 3.37 KB

Reindexer command line tool

Reindexer command line tool is an client utility to work with database.

Table of Content

Features

  • Backup whole database into text file or console.
  • Make queries to database
  • Modify documents and DB metadata
  • Both standalone and embeded(builtin) modes are supported

Usage

reindexer_tool {OPTIONS}

Options
  -d[DSN],      --dsn=[DSN]              DSN to 'reindexer', like 'cproto://127.0.0.1:6534/dbname' or 'builtin:///var/lib/reindexer/dbname'
  -f[FILENAME], --filename=[FILENAME]    Execute commands from file, then exit
  -c[COMMAND],  --command=[COMMAND]      Run only single command (SQL or internal) and exit
  -o[FILENAME], --output=[FILENAME]      Send query results to file
  -l[INT=1..5], --log=[INT=1..5]         Reindexer logging level
  -C[INT],      --connections=[INT]      Number of simulateonous connections to db
  -t[INT],      --threads=[INT]          Number of threads used by db connector (used only for bench)
  --createdb                             Enable created database if missed
  --dump-mode=[DUMP_MODE]                Dump mode for sharded databases: 'full_node' (default), 'sharded_only', 'local_only'

Commands

Upsert document to namespace

Syntax:

\upsert <namespace> <document>

Example:

\upsert books {"id":5,"name":"xx"}

Delete document from namespace

Syntax:

\delete <namespace> <document>

Example:

\delete books {"id":5}

Backup database into text dump format

Syntax:

\dump [namespace1 [namespace2]...]

Dump modes

There are few different dump modes to interract with sharded databases:

  1. full_node - Default mode. Dumps all data of chosen node, including sharded namespaces. However, does not dump data from other shards.
  2. sharded_only - Dumps data from sharded namespaces only (including the data from all other shards). May be usefull for resharding.
  3. local_only - Dumps data from local namespaces, excluding sharded namespaces.

Dump mode is saved in the output file and will be used during restoration process.

Manipulate namespaces

Syntax:

\namespaces add <name> <definition>

Add new namespace

\namespaces list

List available namespaces

\namespaces drop <namespace>

Drop namespace

Working with databases

List of available databases

\databases list

Switching to existing database

\databases use <namespace>

Manipulate metadata

Syntax:

\meta put <namespace> <key> <value>
Put metadata key value
\meta list
List all metadata in name

Set output format

Syntax:

\set output <format>

Format can be one of the following:

  • json Unformatted JSON
  • pretty Pretty printed JSON
  • table Table view (with lines and columns)

Run simple benchmark

Syntax:

\bench <time>
Run benchmark for `<time>` seconds

Examples

Backup whole database into single backup file:

reindexer_tool --dsn cproto://127.0.0.1:6534/mydb --command '\dump' --output mydb.rxdump

Restore database from backup file:

reindexer_tool --dsn cproto://127.0.0.1:6534/mydb --filename mydb.rxdump

Backup only sharded namespaces from all of the shards into single backup file:

reindexer_tool --dsn cproto://127.0.0.1:6534/mydb --command '\dump' --dump-mode=sharded_only --output mydb.rxdump