Skip to content

Commit c9501d3

Browse files
author
xmarchegay
committed
#11 tweak doc
1 parent 8927ce7 commit c9501d3

10 files changed

+42
-29
lines changed

docs/reference/tasks/database_reader_task.md

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Task reference
1212
Accepted inputs
1313
---------------
1414

15-
Input can be used as the query params if needed
15+
`array` Input can be used as the query params if needed
1616

1717
Possible outputs
1818
----------------
@@ -22,28 +22,32 @@ Iterate on an entity list returned by a sql query.
2222
Options
2323
-------
2424

25-
| Code | Type | Required | Default | Description |
26-
|-------------------|--------------------|:--------:|-----------|-------------------------------------------------------------------------|
27-
| `connection` | `string` | | `null` | Doctrine connection (default if not specified) |
28-
| `table` | `string` | **X** | `[]` | Table of the query |
29-
| `sql` | `string` | | `null` | Query to execute (if not specified then: "select tbl.* from table tbl") |
30-
| `limit` | `int` or `null` | | `null` | Result max count |
31-
| `offset` | `int` or `null` | | `null` | Result first item offset |
32-
| `paginate` | `int` or `null` | | `null` | Paginate the results |
33-
| `input_as_params` | `bool` | | `false` | Use the input as params |
34-
| `params` | `array` | | `[]` | Query params |
35-
| `types` | `array` | | `[]` | Query params types |
36-
| `empty_log_level` | `string` or `null` | | `warning` | Log level if the result set is empty |
25+
| Code | Type | Required | Default | Description |
26+
|-------------------|--------------------|:--------:|-----------|---------------------------------------------------------------------------|
27+
| `connection` | `string` | | `null` | Doctrine connection (default if not specified) |
28+
| `table` | `string` | **X** | `[]` | Table of the query |
29+
| `sql` | `string` | | `null` | Query to execute (if not specified then: "select tbl.* from `table` tbl") |
30+
| `limit` | `int` or `null` | | `null` | Result max count |
31+
| `offset` | `int` or `null` | | `null` | Result first item offset |
32+
| `paginate` | `int` or `null` | | `null` | Paginate the results |
33+
| `input_as_params` | `bool` | | `false` | Use the input as params |
34+
| `params` | `array` | | `[]` | Query params |
35+
| `types` | `array` | | `[]` | Query params types |
36+
| `empty_log_level` | `string` or `null` | | `warning` | Log level if the result set is empty |
37+
3738

3839
Example
3940
-------
4041

4142
```yaml
42-
entry:
43-
service: '@CleverAge\DoctrineProcessBundle\Task\Database\DatabaseReaderTask'
44-
options:
45-
table: 'book'
46-
limit: 10
47-
offset: 3
48-
empty_log_level: debug
43+
# Task configuration level
44+
code:
45+
service: '@CleverAge\DoctrineProcessBundle\Task\Database\DatabaseReaderTask'
46+
options:
47+
table: 'book'
48+
limit: 10
49+
offset: 3
50+
params:
51+
title: "IT"
52+
empty_log_level: debug
4953
```

docs/reference/tasks/database_updater_task.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ Example
3333
-------
3434

3535
```yaml
36-
entry:
36+
# Task configuration level
37+
code:
3738
service: '@CleverAge\DoctrineProcessBundle\Task\Database\DatabaseUpdaterTask'
3839
options:
3940
sql: 'update author set firstname = :firstname, lastname = :lastname'

docs/reference/tasks/doctrine_batchwriter_task.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ Example
2929
-------
3030

3131
```yaml
32-
batch_write:
32+
# Task configuration level
33+
code:
3334
service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineBatchWriterTask'
3435
options:
3536
batch_count: 2

docs/reference/tasks/doctrine_cleaner_task.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Example
2727
-------
2828

2929
```yaml
30-
clean:
30+
# Task configuration level
31+
code:
3132
service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineCleanerTask'
3233
```

docs/reference/tasks/doctrine_clear_task.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ Example
3131
-------
3232

3333
```yaml
34-
clear:
34+
# Task configuration level
35+
code:
3536
service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\ClearEntityManagerTask'
3637
```

docs/reference/tasks/doctrine_detacher_task.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Example
2727
-------
2828

2929
```yaml
30-
detach:
30+
# Task configuration level
31+
code:
3132
service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineDetacherTask'
3233
```

docs/reference/tasks/doctrine_reader_task.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ Example
3636
-------
3737

3838
```yaml
39-
entry:
39+
# Task configuration level
40+
code:
4041
service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineReaderTask'
4142
options:
4243
class_name: 'App\Entity\Author'

docs/reference/tasks/doctrine_refresher_task.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Example
2727
-------
2828

2929
```yaml
30-
refresh:
30+
# Task configuration level
31+
code:
3132
service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineRefresherTask'
3233
```

docs/reference/tasks/doctrine_remover_task.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Example
2727
-------
2828

2929
```yaml
30-
remover:
30+
# Task configuration level
31+
code:
3132
service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineRemoverTask'
3233
```

docs/reference/tasks/doctrine_writer_task.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ Example
2727
-------
2828

2929
```yaml
30-
write:
30+
# Task configuration level
31+
code:
3132
service: '@CleverAge\DoctrineProcessBundle\Task\EntityManager\DoctrineWriterTask'
3233
```

0 commit comments

Comments
 (0)