Skip to content

Commit

Permalink
etcdctl: Update README to clarify newline syntax in TXN
Browse files Browse the repository at this point in the history
Add documentation to clarify that when writing TXN commands, multi-line values should be written using "\n" and not a literal newline (as in other commands).

Fixes etcd-io#10169
  • Loading branch information
jutley authored Mar 1, 2019
1 parent a943ad0 commit a532b60
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions etcdctl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a532b60

Please sign in to comment.