From ce388b9826c394559a62ed243c6f2012d41411c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tonon=20Gr=C3=A9gory?= Date: Wed, 11 Dec 2024 10:31:26 +0100 Subject: [PATCH] #10 Update documention --- docs/reference/tasks/01-FileFetchTask.md | 14 ++++++++++---- docs/reference/tasks/02-ListContentTask.md | 9 ++++----- docs/reference/tasks/03-RemoveFileTask.md | 6 ++++-- 3 files changed, 18 insertions(+), 11 deletions(-) diff --git a/docs/reference/tasks/01-FileFetchTask.md b/docs/reference/tasks/01-FileFetchTask.md index 87481a0..a5dca8a 100644 --- a/docs/reference/tasks/01-FileFetchTask.md +++ b/docs/reference/tasks/01-FileFetchTask.md @@ -38,13 +38,15 @@ Options Examples -------- +* Simple fetch task configuration + - See config/packages/flysystem.yaml to see configured flysystems/storages. + - copy all .csv files from 'storage.source' to 'storage.destination' + - remove .csv from 'storage.source' after copy + - output will be filename of copied files ```yaml # Task configuration level code: service: '@CleverAge\FlysystemProcessBundle\Task\FileFetchTask' - description: > - Download all .csv files from storage.source to storage.destination. - See config/packages/flysystem.yaml to see configured flysystem/storages. options: source_filesystem: 'storage.source' destination_filesystem: 'storage.destination' @@ -52,9 +54,13 @@ code: remove_source: true ``` +* Simple fetch process configuration to cipy a specific file from --input option via
```bin/console cleverage:process:execute my_custom_process --input=foobar.csv -vv``` + - See config/packages/flysystem.yaml to see configured flysystems/storages. + - copy input file from 'storage.source' to 'storage.destination' + - remove .csv from 'storage.source' after copy + - output will be filename of copied file ```yaml # Full process configuration to use input as filename with the following call -# bin/console cleverage:process:execute my_custom_process --input=foobar.csv -vv my_custom_process: entry_point: copy_from_input tasks: diff --git a/docs/reference/tasks/02-ListContentTask.md b/docs/reference/tasks/02-ListContentTask.md index ca9238e..036c0c3 100644 --- a/docs/reference/tasks/02-ListContentTask.md +++ b/docs/reference/tasks/02-ListContentTask.md @@ -28,15 +28,14 @@ Options Examples -------- - +* Simple list task configuration from a filesystem + - see config/packages/flysystem.yaml to see configured flysystems/storages. + - list all .csv files from 'storage.source' + - output will be League\Flysystem\StorageAttributes representation of copied files ```yaml # Task configuration level code: service: '@CleverAge\FlysystemProcessBundle\Task\ListContentTask' - description: > - List .csv files from storage.source. - See config/packages/flysystem.yaml to see configured flysystem/storages. - outputs: get_file_path options: filesystem: 'storage.source' file_pattern: '/.csv$/' diff --git a/docs/reference/tasks/03-RemoveFileTask.md b/docs/reference/tasks/03-RemoveFileTask.md index 79f7b99..4928f33 100644 --- a/docs/reference/tasks/03-RemoveFileTask.md +++ b/docs/reference/tasks/03-RemoveFileTask.md @@ -31,9 +31,11 @@ Options Examples -------- - +* Simple process to remove a file on 'storage.source' via
```bin/console cleverage:process:execute my_custom_process --input=foobar.csv -vv``` + - see config/packages/flysystem.yaml to see configured flysystems/storages. + - remove file with name passed as input ```yaml -# bin/console cleverage:process:execute my_custom_process --input=foobar.csv -vv +# my_custom_process: entry_point: remove_from_input tasks: