Skip to content

Commit eba6b41

Browse files
iddqdexiddqdex
authored
YDBDOCS-559 add parquet format to docs (#761)
* YDBDOCS-559 Refactoring. Lists now formated by markdown instead html. Use include for deduplicate text. * YDBDOCS-559 add parquet format to docs * YDBDOCS-559 Добавил описание формата parquet в документацию * fix typo
1 parent 59dd959 commit eba6b41

File tree

10 files changed

+155
-55
lines changed

10 files changed

+155
-55
lines changed

‎ydb/docs/en/core/reference/ydb-cli/_includes/result_format_common.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
* `pretty` (default): Human-readable format.
2+
* `json-unicode`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} output with binary strings [Unicode]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Юникод){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Unicode){% endif %}-encoded and each JSON string in a separate line.
3+
* `json-unicode-array`: JSON output with binary strings Unicode-encoded and the result output as an array of JSON strings with each JSON string in a separate line.<li>`json-base64`: JSON output with binary strings [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}-encoded and each JSON string in a separate line.
4+
* `json-base64-array`: JSON output with binary strings Base64-encoded and the result output as an array of JSON strings with each JSON string in a separate line;
5+
* `parquet`: Output in [Apache Parquet](https://parquet.apache.org/docs/) format.

‎ydb/docs/en/core/reference/ydb-cli/_includes/result_format_csv_tsv.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* `csv`: Output in [CSV](https://ru.wikipedia.org/wiki/CSV) format.
2+
* `tsv`: Output in [TSV](https://ru.wikipedia.org/wiki/TSV) format.

‎ydb/docs/en/core/reference/ydb-cli/scripting-yql.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,27 @@ ydb scripting yql --help
1919

2020
## Parameters of the subcommand {#options}
2121

22-
| Name | Description |
23-
---|---
24-
| `--timeout` | The time within which the operation should be completed on the server. |
25-
| `--stats` | Statistics mode.<br>Acceptable values:<ul><li>`none`: Do not collect statistics.</li><li>`basic`: Collect statistics for basic events.</li><li>`full`: Collect statistics for all events.</li></ul>Defaults to `none`. |
26-
| `-s`, `--script` | Text of the YQL query to be executed. |
27-
| `-f`, `--file` | Path to the text of the YQL query to be executed. |
28-
| `--explain` | Show the query execution plan. |
29-
| `--show-response-metadata` | Show the response metadata. |
30-
| `--format` | Input format.<br>Default value: `pretty`.<br>Acceptable values:<ul><li>`pretty`: A human-readable format.</li><li>`json-unicode`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} output with binary strings [Unicode]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Юникод){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Unicode){% endif %}-encoded and each JSON string in a separate line.</li><li>`json-unicode-array`: JSON output with binary strings Unicode-encoded and the result output as an array of JSON strings with each JSON string in a separate line.</li><li>`json-base64`: JSON output with binary strings [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}-encoded and each JSON string in a separate line.</li><li>`json-base64-array`: JSON output with binary strings Base64-encoded and the result output as an array of JSON strings with each JSON string in a separate line.</li></ul> |
22+
#|
23+
|| **Name** | **Description** ||
24+
|| `--timeout` | The time within which the operation should be completed on the server. ||
25+
|| `--stats` | Statistics mode.
26+
Acceptable values:
27+
* `none`: Do not collect statistics.
28+
* `basic`: Collect statistics for basic events.
29+
* `full`: Collect statistics for all events.
30+
Defaults to `none`. ||
31+
|| `-s`, `--script` | Text of the YQL query to be executed. ||
32+
|| `-f`, `--file` | Path to the text of the YQL query to be executed. ||
33+
|| `--explain` | Show the query execution plan. ||
34+
|| `--show-response-metadata` | Show the response metadata. ||
35+
|| `--format` | Result format.
36+
Default value: `pretty`.
37+
Acceptable values:
38+
39+
{% include notitle [format](./_includes/result_format_common.md) %}
40+
41+
||
42+
|#
3143

3244
### Working with parameterized queries {#parameterized-query}
3345

‎ydb/docs/en/core/reference/ydb-cli/table-query-execute.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,35 @@ View the description of the YQL query command:
1919

2020
## Parameters of the subcommand {#options}
2121

22-
| Name | Description |
23-
---|---
24-
| `--timeout` | The time within which the operation should be completed on the server. |
25-
| `-t`, `--type` | Query type.<br>Acceptable values:<ul><li>`data`: A YQL query that includes [DML]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Data_Manipulation_Language){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Data_Manipulation_Language){% endif %} operations; it can be used both to update data in the database and fetch several selections limited to 1,000 rows per selection.</li><li>`scan`: A YQL query of the [scan](../../concepts/scan_query.md) type. It can only be used to read data from the database. It returns a single selection, but without a limit on the number of records in it. The algorithm of executing a `scan` query on the server is more sophisticated compared to a `data` query. Hence, if you don't need to return more than 1,000 rows, `data` queries are more effective.</li><li>`scheme`: A YQL query that includes [DDL]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Data_Definition_Language){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Data_Definition_Language){% endif %} operations.</li></ul>The default value is `data`. |
26-
| `--stats` | Statistics mode.<br>Acceptable values:<ul><li>`none`: Do not collect statistics.</li><li>`basic`: Collect statistics for basic events.</li><li>`full`: Collect statistics for all events.</li></ul>Defaults to `none`. |
27-
| `-s` | Enable statistics collection in the `basic` mode. |
28-
| `--tx-mode` | [Transaction mode](../../concepts/transactions.md#modes) (for `data` queries).<br>Acceptable values:<ul><li>`serializable-rw`: The result of parallel transactions is equivalent to their serial execution.</li><li>`online-ro`: Each of the reads in the transaction reads data that is most recent at the time of its execution.</li><li>`stale-ro`: Data reads in a transaction return results with a possible delay (fractions of a second).</li></ul>Default value: `serializable-rw`. |
29-
| `-q`, `--query` | Text of the YQL query to be executed. |
30-
| `-f,` `--file` | Path to the text of the YQL query to be executed. |
31-
| `--format` | Result format.<br>Possible values:<ul><li>`pretty` (default): Human-readable format.</li><li>`json-unicode`: [Newline-delimited JSON stream](https://en.wikipedia.org/wiki/JSON_streaming). For each selected row, a separate line is added in the output. Each such line is formatted as a single-line JSON. If your query includes multiple selections, their records are output one-by-one, without additional separators.</li><li>`json-unicode-array`: A single JSON document that includes an array of selected rows.</li><li>`json-base64`: This format is similar to `json-unicode`, but columns containing binary strings (with the `String` type) are [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64)-encoded{% endif %}.</li><li>`json-base64-array`: This format is similar to `json-unicode-array`, but columns with binary strings (with the `String` type) are [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64)-encoded{% endif %}.</li><li>`csv`: Output in [CSV](https://ru.wikipedia.org/wiki/CSV) format.</li><li>`tsv`: Output in [TSV](https://ru.wikipedia.org/wiki/TSV) format.</li></ul> |
32-
22+
#|
23+
|| **Name** | **Description** ||
24+
|| `--timeout` | The time within which the operation should be completed on the server. ||
25+
|| `-t`, `--type` | Query type.
26+
Acceptable values:
27+
* `data`: A YQL query that includes [DML]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Data_Manipulation_Language){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Data_Manipulation_Language){% endif %} operations; it can be used both to update data in the database and fetch several selections limited to 1,000 rows per selection.
28+
* `scan`: A YQL query of the [scan](../../concepts/scan_query.md) type. It can only be used to read data from the database. It returns a single selection, but without a limit on the number of records in it. The algorithm of executing a `scan` query on the server is more sophisticated compared to a `data` query. Hence, if you don't need to return more than 1,000 rows, `data` queries are more effective.
29+
* `scheme`: A YQL query that includes [DDL]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Data_Definition_Language){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Data_Definition_Language){% endif %} operations.
30+
The default value is `data`. ||
31+
|| `--stats` | Statistics mode.
32+
Acceptable values:
33+
* `none`: Do not collect statistics.
34+
* `basic`: Collect statistics for basic events.
35+
* `full`: Collect statistics for all events.
36+
Defaults to `none`. ||
37+
|| `-s` | Enable statistics collection in the `basic` mode. ||
38+
|| `--tx-mode` | [Transaction mode](../../concepts/transactions.md#modes) (for `data` queries).
39+
Acceptable values:<li>`serializable-rw`: The result of parallel transactions is equivalent to their serial execution.<li>`online-ro`: Each of the reads in the transaction reads data that is most recent at the time of its execution.<li>`stale-ro`: Data reads in a transaction return results with a possible delay (fractions of a second).Default value: `serializable-rw`. ||
40+
|| `-q`, `--query` | Text of the YQL query to be executed. ||
41+
|| `-f,` `--file` | Path to the text of the YQL query to be executed. ||
42+
|| `--format` | Result format.
43+
Possible values:
44+
45+
{% include notitle [format](./_includes/result_format_common.md) %}
46+
47+
{% include notitle [format](./_includes/result_format_csv_tsv.md) %}
48+
49+
||
50+
|#
3351
### Working with parameterized queries {#parameterized-query}
3452

3553
{% include [parameterized-query](../../_includes/parameterized-query.md) %}

‎ydb/docs/en/core/reference/ydb-cli/yql.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,26 @@ View the description of the YQL script command:
1919

2020
## Parameters of the subcommand {#options}
2121

22-
| Name | Description |
23-
---|---
24-
| `--timeout` | The time within which the operation should be completed on the server. |
25-
| `--stats` | Statistics mode.<br>Acceptable values:<ul><li>`none` (default): Do not collect.</li><li>`basic`: Collect statistics for basic events.</li><li>`full`: Collect statistics for all events.</li></ul> |
26-
| `-s`, `--script` | Text of the YQL query to be executed. |
27-
| `-f`, `--file` | Path to the text of the YQL query to be executed. |
28-
| `--format` | Result format.<br>Possible values:<ul><li>`pretty` (default): Human-readable format.</li><li>`json-unicode`: [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %} output with binary strings [Unicode]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Юникод){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Unicode){% endif %}-encoded and each JSON string in a separate line.</li><li>`json-unicode-array`: JSON output with binary strings Unicode-encoded and the result output as an array of JSON strings with each JSON string in a separate line.</li><li>`json-base64`: JSON output with binary strings [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}-encoded and each JSON string in a separate line.</li><li>`json-base64-array`: JSON output with binary strings Base64-encoded and the result output as an array of JSON strings with each JSON string in a separate line.</li><li>`csv`: Output in [CSV](https://ru.wikipedia.org/wiki/CSV) format.</li><li>`tsv`: Output in [TSV](https://ru.wikipedia.org/wiki/TSV) format.</li></ul> |
29-
22+
#|
23+
|| **Name** | **Description** ||
24+
|| `--timeout` | The time within which the operation should be completed on the server. ||
25+
|| `--stats` | Statistics mode.
26+
Acceptable values:
27+
* `none` (default): Do not collect.
28+
* `basic`: Collect statistics for basic events.
29+
* `full`: Collect statistics for all events.
30+
||
31+
|| `-s`, `--script` | Text of the YQL query to be executed. ||
32+
|| `-f`, `--file` | Path to the text of the YQL query to be executed. ||
33+
|| `--format` | Result format.
34+
Possible values:
35+
36+
{% include notitle [format](./_includes/result_format_common.md) %}
37+
38+
{% include notitle [format](./_includes/result_format_csv_tsv.md) %}
39+
40+
||
41+
|#
3042
### Working with parameterized queries {#parameterized-query}
3143

3244
{% include [parameterized-query](../../_includes/parameterized-query.md) %}

‎ydb/docs/ru/core/reference/ydb-cli/_includes/result_format_common.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
* `pretty` (по умолчанию) — человекочитаемый формат;
2+
* `json-unicode` — вывод в формате [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}, бинарные строки закодированы в [Юникод]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Юникод){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Unicode){% endif %}, каждая строка JSON выводится в отдельной строке;
3+
* `json-unicode-array` — вывод в формате JSON, бинарные строки закодированы в Юникод, результат выводится в виде массива строк JSON, каждая строка JSON выводится в отдельной строке;
4+
* `json-base64` — вывод в формате JSON, бинарные строки закодированы в [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}, каждая строка JSON выводится в отдельной строке;
5+
* `json-base64-array` — вывод в формате JSON, бинарные строки закодированы в Base64, результат выводится в виде массива строк JSON, каждая строка JSON выводится в отдельной строке;
6+
* `parquet`: вывод в формате [Apache Parquet](https://parquet.apache.org/docs/).

‎ydb/docs/ru/core/reference/ydb-cli/_includes/result_format_csv_tsv.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* `csv` — вывод в формате [CSV](https://ru.wikipedia.org/wiki/CSV);
2+
* `tsv` — вывод в формате [TSV](https://ru.wikipedia.org/wiki/TSV).

‎ydb/docs/ru/core/reference/ydb-cli/scripting-yql.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,27 @@ ydb scripting yql --help
1919

2020
## Параметры подкоманды {#options}
2121

22-
Имя | Описание
23-
---|---
24-
`--timeout` | Время, в течение которого должна быть выполнена операция на сервере.
25-
`--stats` | Режим сбора статистики.<br>Возможные значения:<ul><li>`none` — не собирать;</li><li>`basic` — собирать по основным событиям;</li><li>`full` — собирать по всем событиям.</li></ul>Значение по умолчанию — `none`.
26-
`-s`, `--script` | Текст YQL-скрипта для выполнения.
27-
`-f`, `--file` | Путь к файлу с текстом YQL-скрипта для выполнения.
28-
`--explain` | Показать план выполнения запроса.
29-
`--show-response-metadata` | Показать метаданные ответа.
30-
`--format` | Формат вывода.<br>Значение по умолчанию — `pretty`.<br>Возможные значения:<ul><li>`pretty` — человекочитаемый формат;</li><li>`json-unicode` — вывод в формате [JSON]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/JSON){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/JSON){% endif %}, бинарные строки закодированы в [Юникод]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Юникод){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Unicode){% endif %}, каждая строка JSON выводится в отдельной строке;</li><li>`json-unicode-array` — вывод в формате JSON, бинарные строки закодированы в Юникод, результат выводится в виде массива строк JSON, каждая строка JSON выводится в отдельной строке;</li><li>`json-base64` — вывод в формате JSON, бинарные строки закодированы в [Base64]{% if lang == "ru" %}(https://ru.wikipedia.org/wiki/Base64){% endif %}{% if lang == "en" %}(https://en.wikipedia.org/wiki/Base64){% endif %}, каждая строка JSON выводится в отдельной строке;</li><li>`json-base64-array` — вывод в формате JSON, бинарные строки закодированы в Base64, результат выводится в виде массива строк JSON, каждая строка JSON выводится в отдельной строке.</li></ul>
31-
22+
#|
23+
|| **Имя** | **Описание** ||
24+
||`--timeout` | Время, в течение которого должна быть выполнена операция на сервере.||
25+
||`--stats` | Режим сбора статистики.
26+
Возможные значения:
27+
* `none` — не собирать;
28+
* `basic` — собирать по основным событиям;
29+
* `full` — собирать по всем событиям.
30+
Значение по умолчанию — `none`.||
31+
||`-s`, `--script` | Текст YQL-скрипта для выполнения.||
32+
||`-f`, `--file` | Путь к файлу с текстом YQL-скрипта для выполнения.||
33+
||`--explain` | Показать план выполнения запроса.||
34+
||`--show-response-metadata` | Показать метаданные ответа.||
35+
||`--format` | Формат вывода.
36+
Значение по умолчанию — `pretty`.
37+
Возможные значения:
38+
39+
{% include notitle [format](./_includes/result_format_common.md) %}
40+
41+
||
42+
|#
3243
### Работа с параметризованными запросами {#parameterized-query}
3344

3445
{% include [parameterized-query](../../_includes/parameterized-query.md) %}

0 commit comments

Comments
 (0)