Key-value commands

PUT [options] \ \

Options

Output

Examples

Remarks

GET [options] \ [rangeend]

Options

Output

Examples

Remarks

DEL [options] \ [rangeend]

Options

Output

Examples

TXN [options]

Options

Input Format

Output

Examples

Remarks

COMPACTION [options] \

Options

Output

Example

WATCH [options] [key or prefix] [rangeend] [--] [exec-command arg1 arg2 ...]

Options

Input format

Output

Examples

Non-interactive

Interactive

LEASE \

LEASE GRANT \

Output

Example

LEASE REVOKE \

Output

Example

LEASE TIMETOLIVE \ [options]

Options

Output

Example

LEASE LIST

Output

Example

LEASE KEEP-ALIVE \

Output

Example

Cluster maintenance commands

MEMBER \

MEMBER ADD \ [options]

Options

Output

Example

MEMBER UPDATE \ [options]

Options

Output

Example

MEMBER REMOVE \

Output

Example

MEMBER LIST

Options

Output

Examples

ENDPOINT \

Options

ENDPOINT HEALTH

Output

Example

ENDPOINT STATUS

Output

Simple format

JSON format

Examples

ENDPOINT HASHKV

Output

Simple format

JSON format

Examples

ALARM \

ALARM DISARM

Output

Examples

ALARM LIST

Output

Examples

DEFRAG [options]

Output

Example

Remarks

SNAPSHOT \

SNAPSHOT SAVE \

Output

Example

SNAPSHOT RESTORE [options] \

SNAPSHOT STATUS \

MOVE-LEADER \

Example

DOWNGRADE \

DOWNGRADE VALIDATE \

Example

DOWNGRADE ENABLE \

Example

DOWNGRADE CANCEL

Example

Concurrency commands

LOCK [options] \ [command arg1 arg2 ...]

Options

Output

Example

Remarks

ELECT [options] \ [proposal]

Options

Output

Example

Remarks

Authentication commands

AUTH \

Output

Examples

ROLE \

ROLE ADD \

Output

Examples

ROLE GET \

Output

Examples

ROLE DELETE \

Output

Examples

ROLE LIST \

Output

Examples

ROLE GRANT-PERMISSION [options] \ \ \ [endkey]

Options

Output

Examples

ROLE REVOKE-PERMISSION \ \ \ [endkey]

Options

Output

Examples

USER \

USER ADD \ [options]

Options

Output

Examples

USER GET \ [options]

Options

Output

Examples

USER DELETE \

Output

Examples

USER LIST

Output

Examples

USER PASSWD \ [options]

Options

Output

Examples

USER GRANT-ROLE \ \

Output

Examples

USER REVOKE-ROLE \ \

Output

Examples

Utility commands

MAKE-MIRROR [options] \

Options

Output

Examples

VERSION

Output

Examples

CHECK \

CHECK PERF [options]

Options

Output

Examples

CHECK DATASCALE [options]

Options

Output

Examples

Exit codes

Output formats

Simple

JSON

Protobuf

Fields

Compatibility Support

Input Compatibility

Output Compatibility

TODO: compatibility with etcd server