--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://ydb.tech/docs/en/reference/ydb-cli/yql.md?version=v25.4 - https://ydb.tech/docs/ru/reference/ydb-cli/yql.md?version=v25.4 - href: ru/reference/ydb-cli/yql.md type: text/markdown title: Markdown version - href: ../../llms.txt type: text/markdown title: llms.txt sourcePath: ru/core/reference/ydb-cli/yql.md --- > **Documentation Index:** Fetch the complete configuration index at https://ydb.tech/docs/ru/llms.txt # Выполнение скрипта (с поддержкой стриминга) {% note warning %} Данная команда устарела. Рекомендуемый инструмент для выполнения запросов в YDB CLI — это команда [ydb sql](https://ydb.tech/docs/ru/reference/ydb-cli/sql.md?version=v25.4). {% endnote %} С помощью подкоманды `yql` вы можете выполнить YQL-скрипт. Скрипт может содержать запросы разных типов. В отличие от `scripting yql`, подкоманда `yql` устанавливает стрим и получает данные через него. Выполнение запроса в стриме позволяет снять ограничение на размер читаемых данных. Общий вид команды: ```bash ydb [global options...] yql [options...] ``` * `global options` — [глобальные параметры](https://ydb.tech/docs/ru/reference/ydb-cli/commands/global-options.md?version=v25.4). * `options` — [параметры подкоманды](#options). Посмотрите описание команды выполнения YQL-скрипта: ```bash ydb yql --help ``` ## Параметры подкоманды {#options} #| || Имя | Описание || || `--timeout` | Время, в течение которого должна быть выполнена операция на сервере. || || `--stats` | Режим сбора статистики. Возможные значения: * `none` (по умолчанию) — не собирать; * `basic` — собирать по основным событиям; * `full` — собирать по всем событиям. || || `-s`, `--script` | Текст YQL-скрипта для выполнения. || || `-f`, `--file` | Путь к файлу с текстом YQL-скрипта для выполнения. || || `--format` | Формат вывода. Возможные значения: * `pretty` (по умолчанию) — человекочитаемый формат; * `json-unicode` — вывод в формате [JSON](https://ru.wikipedia.org/wiki/JSON), бинарные строки закодированы в [юникод](https://ru.wikipedia.org/wiki/Юникод), каждая строка JSON выводится в отдельной строке; * `json-unicode-array` — вывод в формате JSON, бинарные строки закодированы в Юникод, результат выводится в виде массива строк JSON, каждая строка JSON выводится в отдельной строке; * `json-base64` — вывод в формате JSON, бинарные строки закодированы в [Base64](https://ru.wikipedia.org/wiki/Base64), каждая строка JSON выводится в отдельной строке; * `json-base64-array` — вывод в формате JSON, бинарные строки закодированы в Base64, результат выводится в виде массива строк JSON, каждая строка JSON выводится в отдельной строке; * `parquet`: вывод в формате [Apache Parquet](https://parquet.apache.org/docs/). * `csv` — вывод в формате [CSV](https://ru.wikipedia.org/wiki/CSV); * `tsv` — вывод в формате [TSV](https://ru.wikipedia.org/wiki/TSV). || |# ### Работа с параметризованными запросами {#parameterized-query} Ниже приведена краткая справка, расширенное описание с примерами смотрите в статье [Выполнение параметризованных YQL-запросов и скриптов](https://ydb.tech/docs/ru/reference/ydb-cli/parameterized-queries-cli.md?version=v25.4). Имя | Описание ---|--- `-p, --param` | Значение одного параметра YQL-запроса в формате `$name=value`, где `$name` — имя параметра, а `value` — его значение (корректный [JSON value](https://www.json.org/json-ru.html)). `--param-file` | Имя файла в формате [JSON](https://ru.wikipedia.org/wiki/JSON) в кодировке [UTF-8](https://ru.wikipedia.org/wiki/UTF-8), в котором заданы значения параметров, сопоставляемые с параметрами YQL-запроса по именам ключей. `--input-format` | Формат представления значений параметров. Действует на все способы их передачи (через параметр команды, файл или `stdin`).
Возможные значения: `--stdin-format` | Формат представления параметров и фрейминг для `stdin`. Чтобы задать оба значения, укажите параметр дважды.
**Формат представления параметров на `stdin`**
Возможные значения:Если формат представления параметров на `stdin` не задан, то применяется формат, заданный параметром `--input-format`.

**Разделение наборов параметров (фрейминг) для `stdin`**
Возможные значения: `--columns` | Строка с именами колонок, заменяющими header CSV/TSV документа, читаемого со stdin'а. Имена колонок должны быть в том же формате, что и сам документ. `--skip-rows` | Число строк с начала данных, читаемых со stdin'a, которые нужно пропустить, не включая строку header'a. `--stdin-par` | Имя параметра, значение которого будет передано через `stdin`, указывается без символа `$`. `--batch` | Режим пакетирования значений наборов параметров, получаемых через `stdin`.
Возможные значения: