Skip to content

Commit e5d215e

Browse files
committed
[+] add CopyToProgram and CopyFromProgram tasks description
1 parent 8cc5cbc commit e5d215e

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/components.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Internal Command. A prebuilt functionality included in **pg_timetable**. These i
3131
* *Download*
3232
* *CopyFromFile*
3333
* *CopyToFile*
34+
* *CopyFromProgram*
35+
* *CopyToProgram*
3436
* *Shutdown*
3537

3638
## Task
@@ -185,6 +187,34 @@ Example:
185187
}'::jsonb
186188
```
187189

190+
#### `BUILTIN: CopyToProgram`
191+
192+
Schema: `object`
193+
194+
Example:
195+
196+
```sql
197+
'{
198+
"sql": "COPY location TO STDOUT",
199+
"cmd": "sh",
200+
"args": ["gzip", "-c", ">", "/tmp/output.gz"]
201+
}'::jsonb
202+
```
203+
204+
#### `BUILTIN: CopyFromProgram`
205+
206+
Schema: `object`
207+
208+
Example:
209+
210+
```sql
211+
'{
212+
"sql": "COPY location FROM STDIN",
213+
"cmd": "gunzip",
214+
"args": ["-c", "/tmp/data.gz"]
215+
}'::jsonb
216+
```
217+
188218
#### `BUILTIN: Shutdown`
189219

190220
value ignored

0 commit comments

Comments
 (0)