summaryrefslogtreecommitdiff
path: root/docs/content/functions/data.md
diff options
context:
space:
mode:
authorDave Henderson <dhenderson@gmail.com>2017-11-18 10:10:27 -0500
committerGitHub <noreply@github.com>2017-11-18 10:10:27 -0500
commit99b5cec8b37e25418bbfe2fc251f2adfd57603a2 (patch)
treef48a5a55cb82db2ef29fceab1b99e6d0df2f8f47 /docs/content/functions/data.md
parent59068e64a201941984630478dd26fc9e583222d7 (diff)
parent01b39ee0955b59abdf1895b18435f1731226fcac (diff)
Merge pull request #233 from hairyhenderson/stdin-datasource-230
Adding support for stdin: scheme for datasources
Diffstat (limited to 'docs/content/functions/data.md')
-rw-r--r--docs/content/functions/data.md21
1 files changed, 20 insertions, 1 deletions
diff --git a/docs/content/functions/data.md b/docs/content/functions/data.md
index 18bb4f7c..0243b25b 100644
--- a/docs/content/functions/data.md
+++ b/docs/content/functions/data.md
@@ -11,7 +11,7 @@ A collection of functions that retrieve, parse, and convert structured data.
Parses a given datasource (provided by the [`--datasource/-d`](#--datasource-d) argument).
-Currently, `file://`, `http://`, `https://`, and `vault://` URLs are supported.
+Currently, `file://`, `stdin://`, `http://`, `https://`, and `vault://` URLs are supported.
Currently-supported formats are JSON, YAML, TOML, and CSV.
@@ -34,6 +34,25 @@ $ gomplate -d person.json < input.tmpl
Hello Dave
```
+### Providing datasources on standard input (`stdin`)
+
+Normally `stdin` is used as the input for the template, but it can also be used
+to provide datasources. To do this, specify a URL with the `stdin:` scheme:
+
+```console
+$ echo 'foo: bar' | gomplate -i '{{(ds "data").foo}}' -d data=stdin:///foo.yaml
+bar
+```
+
+Note that the URL must have a file name with a supported extension in order for
+the input to be correctly parsed. If no parsing is required (i.e. if the data
+is being included verbatim with the include function), just `stdin:` is enough:
+
+```console
+$ echo 'foo' | gomplate -i '{{ include "data" }}' -d data=stdin:
+foo
+```
+
### Usage with HTTP data
```console