Merge pull request #10513 from jutley/txn-newline-documentation

etcdctl: Update README to clarify newline syntax in TXN
This commit is contained in:
Xiang Li 2019-03-02 15:23:31 +08:00 committed by GitHub
commit 2c69559819
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -329,6 +329,27 @@ put key2 "some extra key"
# OK
```
#### Remarks
When using multi-line values within a TXN command, newlines must be represented as `\n`. Literal newlines will cause parsing failures. This differs from other commands (such as PUT) where the shell will convert literal newlines for us. For example:
```bash
./etcdctl txn <<<'mod("key1") > "0"
put key1 "overwrote-key1"
put key1 "created-key1"
put key2 "this is\na multi-line\nvalue"
'
# FAILURE
# OK
# OK
```
### COMPACTION [options] \<revision\>
COMPACTION discards all etcd event history prior to a given revision. Since etcd uses a multiversion concurrency control