open-consul/website/pages/docs/commands/kv/index.mdx

88 lines
2.1 KiB
Plaintext
Raw Normal View History

2016-09-26 15:12:53 +00:00
---
2020-04-07 18:55:19 +00:00
layout: docs
2020-04-06 20:27:35 +00:00
page_title: 'Commands: KV'
sidebar_title: kv
2016-09-26 15:12:53 +00:00
---
# Consul KV
Command: `consul kv`
2017-04-04 16:33:22 +00:00
The `kv` command is used to interact with Consul's KV store via the
2016-09-26 15:12:53 +00:00
command line. It exposes top-level commands for inserting, updating, reading,
and deleting from the store. This command is available in Consul 0.7.1 and
later.
2016-09-26 15:12:53 +00:00
2017-04-04 16:33:22 +00:00
The KV store is also accessible via the
2020-04-09 23:46:54 +00:00
[HTTP API](/api/kv).
2016-09-26 15:12:53 +00:00
## Usage
Usage: `consul kv <subcommand>`
For the exact documentation for your Consul version, run `consul kv -h` to view
the complete list of subcommands.
```text
Usage: consul kv <subcommand> [options] [args]
# ...
Subcommands:
delete Removes data from the KV store
export Exports part of the KV tree in JSON format
2016-09-26 15:12:53 +00:00
get Retrieves or lists data from the KV store
import Imports part of the KV tree in JSON format
2016-09-26 15:12:53 +00:00
put Sets or updates data in the KV store
```
For more information, examples, and usage about a subcommand, click on the name
of the subcommand in the sidebar or one of the links below:
2020-04-09 23:46:54 +00:00
- [delete](/docs/commands/kv/delete)
- [export](/docs/commands/kv/export)
- [get](/docs/commands/kv/get)
- [import](/docs/commands/kv/import)
- [put](/docs/commands/kv/put)
2016-09-26 15:12:53 +00:00
## Basic Examples
To create or update the key named "redis/config/connections" to the value "5" in
2017-04-04 16:33:22 +00:00
Consul's KV store:
2016-09-26 15:12:53 +00:00
2020-05-19 18:32:38 +00:00
```shell-session
2016-09-26 15:12:53 +00:00
$ consul kv put redis/config/connections 5
Success! Data written to: redis/config/connections
```
To read a value back from Consul:
2020-05-19 18:32:38 +00:00
```shell-session
2016-09-26 15:12:53 +00:00
$ consul kv get redis/config/connections
5
```
Or you can query for detailed information:
2020-05-19 18:32:38 +00:00
```shell-session
2016-09-26 15:12:53 +00:00
$ consul kv get -detailed redis/config/connections
CreateIndex 336
Flags 0
Key redis/config/connections
LockIndex 0
ModifyIndex 336
Session -
Value 5
```
Finally, deleting a key is just as easy:
2020-05-19 18:32:38 +00:00
```shell-session
2016-09-26 15:12:53 +00:00
$ consul kv delete redis/config/connections
Success! Data deleted at key: redis/config/connections
```
For more examples, ask for subcommand help or view the subcommand documentation
by clicking on one of the links in the sidebar.