Improve Interactive CLI documentation #20013
Conversation
github-actions
bot
added
the
documentation
|
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully Build logsWarnings (2) |
|
🔄 New commits pushed — @ElenaAfina please take a look. |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully Build logsWarnings (4) |
|
🔄 New commits pushed — @ElenaAfina please take a look. |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
Hey @ElenaAfina, it has been 30 business-hours since the author's last update, could you please review? |
|
🔄 New commits pushed — @ElenaAfina please take a look. |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
🔄 New commits pushed — @ElenaAfina please take a look. |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
| * YQL keywords (SELECT, FROM, WHERE, INSERT, UPDATE and others) | ||
| * Table and column names | ||
| * String literals (text in quotes) | ||
| * Numeric literals | ||
| * Operators (=, <, >, +, - and others) | ||
| * Special characters (brackets, commas, dots) | ||
| * Comments |
There was a problem hiding this comment.
Change it to be a table that explains which color represents what.
There was a problem hiding this comment.
We don't want to specify colors yet, it's a subject to change
There was a problem hiding this comment.
Why? If they change, you'll be able to just update it.
There was a problem hiding this comment.
What's the point of specifying such thing? It's purpose is to distinguish one part of the script from another. No matter what colors are used. It has some default realisation and we don't want to sync it with the documentation if we decide to change it.
|
🔄 New commits pushed — @ElenaAfina please take a look. |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
|
Hey @ElenaAfina, it has been 31 business-hours since the author's last update, could you please review? |
Co-authored-by: Ivan Blinkov <ivan@blinkov.ru>
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
🔄 New commits pushed — @ElenaAfina please take a look. |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
|
🔄 New commits pushed — @ElenaAfina please take a look. |
|
⚪ Test history | Ya make output | Test bloat
🟢 |
✅ Documentation buildRevision built successfully |
|
Hey @ElenaAfina, it has been 28 business-hours since the author's last update, could you please review? |
|
Hey @ElenaAfina, it has been 58 business-hours since the author's last update, could you please review? |
|
Hey @ElenaAfina, it has been 82 business-hours since the author's last update, could you please review? |
| Выполнив команду `ydb` без подкоманд, запустится интерактивный режим выполнения запросов. Консоль или терминал будут переведены в интерактивный режим. После этого можно вводить запросы напрямую в консоль или терминал, при вводе символа перевода строки запрос считается законченным и он начинает исполняться. Текст запроса может представлять из себя как YQL запрос, так и [специальную команду](#spec-commands). Также между запусками сохраняется история запросов, доступны автодополнение команд и поиск по истории запросов. | ||
| ## Общее описание | ||
|
|
||
| После выполнения команды `{{ ydb-cli }}` без подкоманд запускается интерактивный режим выполнения запросов. После этого можно вводить запросы напрямую в консоль или терминал. При вводе символа перевода строки запрос считается законченным, и он начинает исполняться. Текст запроса может представлять из себя как YQL запрос, так и [специальную команду](#spec-commands). |
There was a problem hiding this comment.
| После выполнения команды `{{ ydb-cli }}` без подкоманд запускается интерактивный режим выполнения запросов. После этого можно вводить запросы напрямую в консоль или терминал. При вводе символа перевода строки запрос считается законченным, и он начинает исполняться. Текст запроса может представлять из себя как YQL запрос, так и [специальную команду](#spec-commands). | |
| Запуск команды `{{ ydb-cli }}` без подкоманд инициирует интерактивный режим выполнения запросов. После этого можно вводить запросы напрямую в консоль или терминал. При вводе символа перевода строки запрос считается законченным, и он начинает исполняться. Текст запроса может представлять из себя как YQL запрос, так и [специальную команду](#spec-commands). |
Changelog entry
Changelog category
Description for reviewers