add documentation for default command

This commit is contained in:
Paul Chavard 2019-12-01 17:39:09 +01:00 committed by Yehuda Katz
parent 3fb4a5d6e6
commit 9851317aeb

36
docs/commands/default.md Normal file
View File

@ -0,0 +1,36 @@
# default
This command sets a default row's column if missing. Other commands are capable of feeding `default` with their output through pipelines.
## Usage
```shell
> [input-command] | default [column-name] [column-value]
```
## Examples
Let's say we have a table like this:
```shell
> open contacts.json
━━━┯━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━
# │ name │ email
───┼──────────┼──────────────────
0 │ paul │ paul@example.com
1 │ andres │
2 │ jonathan │
━━━┷━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━
```
`default` allows us to fill `email` column with a default value:
```shell
> open contacts.json | default email "no-reply@example.com"
━━━┯━━━━━━━━━━┯━━━━━━━━━━━━━━━━━━━━━━
# │ name │ email
───┼──────────┼──────────────────────
0 │ paul │ paul@example.com
1 │ andres │ no-reply@example.com
2 │ jonathan │ no-reply@example.com
━━━┷━━━━━━━━━━┷━━━━━━━━━━━━━━━━━━━━━━
```