Browse Source

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

etcdctl: Update README to clarify newline syntax in TXN
Xiang Li 6 years ago
parent
commit
2c69559819
1 changed files with 21 additions and 0 deletions
  1. 21 0
      etcdctl/README.md

+ 21 - 0
etcdctl/README.md

@@ -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