From 0bde52cd4c144f5224391bc043667fcc3749b827 Mon Sep 17 00:00:00 2001 From: "a.tolstoy" <a.tolstoy@picodata.io> Date: Mon, 13 Nov 2023 14:52:06 +0300 Subject: [PATCH] large url renaming --- docs/architecture/clustering.md | 2 +- docs/architecture/discovery.md | 2 +- ...{broadcasted_sql.md => distributed_sql.md} | 14 +++--- docs/architecture/raft_failover.md | 2 +- docs/index.md | 44 +++++++++---------- docs/{general => overview}/benefits.md | 2 +- docs/{general => overview}/description.md | 18 ++++---- docs/{general => overview}/feedback.md | 2 +- docs/{general => overview}/glossary.md | 2 +- .../reference.md => reference/ansi_sql.md} | 4 +- docs/{references => reference}/api.md | 26 +++++------ docs/{references => reference}/cli.md | 4 +- .../queries.md => reference/sql_queries.md} | 22 +++++----- .../datatypes.md => reference/sql_types.md} | 4 +- .../connecting.md} | 17 ++++--- .../deploy_on_hosts.md => tutorial/deploy.md} | 8 ++-- docs/{tutorials => tutorial}/install.md | 6 +-- .../auth_ldap.md => tutorial/ldap.md} | 4 +- docs/{tutorials => tutorial}/monitoring.md | 6 +-- .../sql_examples.md} | 22 +++++----- .../{tutorials => tutorial}/tutorial_users.md | 20 ++++----- .../tutorial_webui.md => tutorial/webui.md} | 12 ++--- mkdocs.yml | 36 +++++++-------- 23 files changed, 139 insertions(+), 140 deletions(-) rename docs/architecture/{broadcasted_sql.md => distributed_sql.md} (91%) rename docs/{general => overview}/benefits.md (98%) rename docs/{general => overview}/description.md (62%) rename docs/{general => overview}/feedback.md (92%) rename docs/{general => overview}/glossary.md (99%) rename docs/{references/reference.md => reference/ansi_sql.md} (98%) rename docs/{references => reference}/api.md (97%) rename docs/{references => reference}/cli.md (99%) rename docs/{references/queries.md => reference/sql_queries.md} (98%) rename docs/{references/datatypes.md => reference/sql_types.md} (94%) rename docs/{tutorials/tutorial_first_steps.md => tutorial/connecting.md} (87%) rename docs/{tutorials/deploy_on_hosts.md => tutorial/deploy.md} (98%) rename docs/{tutorials => tutorial}/install.md (98%) rename docs/{tutorials/auth_ldap.md => tutorial/ldap.md} (98%) rename docs/{tutorials => tutorial}/monitoring.md (95%) rename docs/{tutorials/tutorial_data.md => tutorial/sql_examples.md} (83%) rename docs/{tutorials => tutorial}/tutorial_users.md (88%) rename docs/{tutorials/tutorial_webui.md => tutorial/webui.md} (88%) diff --git a/docs/architecture/clustering.md b/docs/architecture/clustering.md index c8554388..48c8dd97 100644 --- a/docs/architecture/clustering.md +++ b/docs/architecture/clustering.md @@ -134,7 +134,7 @@ discovery не будет, инÑÑ‚Ð°Ð½Ñ Ñразу перейдет к Ñта Ð”Ð»Ñ Ð¿ÐµÑ€Ð²Ð¸Ñ‡Ð½Ð¾Ð³Ð¾ вызова `box.cfg()`: - идентификаторы `instance_uuid`, `replicaset_uuid`, -- `box.cfg.replication` — ÑпиÑок [адреÑов](../general/glossary.md#address) Ð´Ð»Ñ Ñ€ÐµÐ¿Ð»Ð¸ÐºÐ°Ñ†Ð¸Ð¸. +- `box.cfg.replication` — ÑпиÑок [адреÑов](../overview/glossary.md#address) Ð´Ð»Ñ Ñ€ÐµÐ¿Ð»Ð¸ÐºÐ°Ñ†Ð¸Ð¸. Получив вÑе наÑтройки, инÑÑ‚Ð°Ð½Ñ Ð¸Ñпользует их в `box.cfg()` (Ñм. [`init_common()`](#fn-init_common)), и затем Ñоздает в БД группу diff --git a/docs/architecture/discovery.md b/docs/architecture/discovery.md index 1320842a..88cbf9a4 100644 --- a/docs/architecture/discovery.md +++ b/docs/architecture/discovery.md @@ -1,6 +1,6 @@ # Ðлгоритм discovery Ð’ данном разделе опиÑаны подробноÑти работы алгоритма -[discovery](../general/glossary.md#discovery), который отвечает за обнаружение +[discovery](../overview/glossary.md#discovery), который отвечает за обнаружение инÑтанÑами друг друга при инициализации клаÑтера. ## Входные данные {: #initial-state } diff --git a/docs/architecture/broadcasted_sql.md b/docs/architecture/distributed_sql.md similarity index 91% rename from docs/architecture/broadcasted_sql.md rename to docs/architecture/distributed_sql.md index 587564e0..ba569d13 100644 --- a/docs/architecture/broadcasted_sql.md +++ b/docs/architecture/distributed_sql.md @@ -4,7 +4,7 @@ Picodata включает в ÑÐµÐ±Ñ Ð±Ð¾Ð³Ð°Ñ‚ÑƒÑŽ функционально ## Принципы работы {: #sql-essentials } -Принципы работы раÑпределенного SQL ÑоглаÑуютÑÑ Ñ Ñ‚Ñ€ÐµÐ±Ð¾Ð²Ð°Ð½Ð¸Ñми [Ñтандарта SQL](../references/reference) (_Structured Query Language_, Ñзык Ñтруктурированных запроÑов) Ð´Ð»Ñ Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð¸ ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ в виде таблиц: +Принципы работы раÑпределенного SQL ÑоглаÑуютÑÑ Ñ Ñ‚Ñ€ÐµÐ±Ð¾Ð²Ð°Ð½Ð¸Ñми [Ñтандарта SQL](../reference/ansi_sql) (_Structured Query Language_, Ñзык Ñтруктурированных запроÑов) Ð´Ð»Ñ Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð¸ ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ в виде таблиц: * Ð›ÑŽÐ±Ð°Ñ Ñ‚Ð°Ð±Ð»Ð¸Ñ†Ð° предÑтавлÑет Ñобой именованный набор Ñтрок; * Ð’Ñе Ñтроки таблицы имеют одинаковый набор именованных Ñтолбцов; @@ -36,14 +36,14 @@ style="color:#39cb00ff">_зеленым_</span> — Ñобранные фраг ### РаÑпределение данных {: #data-distribution } РаÑпределенный SQL требует ÑобÑтвенно раÑÐ¿Ñ€ÐµÐ´ÐµÐ»ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ… между различными репликаÑетами (шардами) клаÑтера. Ðто доÑтигаетÑÑ Ð·Ð° Ñчет -иÑÐ¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ð½Ð¸Ñ Ð²Ñтроенной библиотеки [Vshard](../general/glossary.md#vshard). +иÑÐ¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ð½Ð¸Ñ Ð²Ñтроенной библиотеки [Vshard](../overview/glossary.md#vshard). ВзаимодейÑтвие Picodata SQL и Vshard заключаетÑÑ Ð² разделении функций: -- Picodata SQL работает Ñ ÑˆÐ°Ñ€Ð´Ð¸Ñ€Ð¾Ð²Ð°Ð½Ð½Ñ‹Ð¼Ð¸ [таблицами](../general/glossary.md#table) +- Picodata SQL работает Ñ ÑˆÐ°Ñ€Ð´Ð¸Ñ€Ð¾Ð²Ð°Ð½Ð½Ñ‹Ð¼Ð¸ [таблицами](../overview/glossary.md#table) (таблицами), отдельные Ñтроки (кортежи) которых раÑпределÑÑŽÑ‚ÑÑ Ð¿Ð¾ - разным [бакетам](../general/glossary.md#bucket); + разным [бакетам](../overview/glossary.md#bucket); - Vshard работает Ñ Ñ€Ð°Ñпределением бакетов по - [репликаÑетам](../general/glossary.md#replicaset). + [репликаÑетам](../overview/glossary.md#replicaset). У каждой раÑпределенной таблицы в Ñхеме данных вÑегда еÑть два признака: @@ -65,7 +65,7 @@ Picodata SQL включает внутреннюю функцию по вычи `sharding_key`, попадут в один бакет. ОпиÑание поддерживаемых запроÑов и их ÑинтакÑиÑа приведены в разделе: -[Команды SQL](../references/queries.md) +[Команды SQL](../reference/sql_queries.md) --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/architecture/broadcasted_sql.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/architecture/distributed_sql.md) diff --git a/docs/architecture/raft_failover.md b/docs/architecture/raft_failover.md index 02c25c9c..dcf2f96c 100644 --- a/docs/architecture/raft_failover.md +++ b/docs/architecture/raft_failover.md @@ -61,7 +61,7 @@ Raft предполагает, что в клаÑтере вÑегда Ñуще См. также: -- [Ð ÐµÐ¿Ð»Ð¸ÐºÐ°Ñ†Ð¸Ñ Ð¸ зоны доÑтупноÑти](../tutorials/deploy_on_hosts.md#failure-domains) +- [Ð ÐµÐ¿Ð»Ð¸ÐºÐ°Ñ†Ð¸Ñ Ð¸ зоны доÑтупноÑти](../tutorial/deploy.md#failure-domains) --- [ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/architecture/raft_failover.md) diff --git a/docs/index.md b/docs/index.md index df5fe47c..89f9c6dd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,31 +10,31 @@ Picodata — Ñто раÑÐ¿Ñ€ÐµÐ´ÐµÐ»ÐµÐ½Ð½Ð°Ñ ÑиÑтема промышле Ðа Ñтом портале предÑтавлена Ð´Ð¾ÐºÑƒÐ¼ÐµÐ½Ñ‚Ð°Ñ†Ð¸Ñ Ð¿Ð¾ Picodata: -### Ознакомление Ñ ÐŸÐž Picodata {: #getting-started } -* [Общее опиÑание продукта](general/description) -* [ПреимущеÑтва иÑÐ¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ð½Ð¸Ñ Picodata](general/benefits) -* [ГлоÑÑарий](general/glossary) -* [ÐžÐ±Ñ€Ð°Ñ‚Ð½Ð°Ñ ÑвÑзь и получение помощи](general/feedback) +### Ознакомление Ñ ÐŸÐž Picodata {: #overview } +* [Общее опиÑание продукта](overview/description) +* [ПреимущеÑтва иÑÐ¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ð½Ð¸Ñ Picodata](overview/benefits) +* [ГлоÑÑарий](overview/glossary) +* [ÐžÐ±Ñ€Ð°Ñ‚Ð½Ð°Ñ ÑвÑзь и получение помощи](overview/feedback) -### ИнÑтрукции и руководÑтва {: #manuals-and-howtos } -* [УÑтановка Picodata](tutorials/install) -* [ЗапуÑк клаÑтера](tutorials/deploy_on_hosts) -* [Мониторинг клаÑтера](tutorials/monitoring) -* [Подключение и работа в конÑоли](tutorials/tutorial_first_steps) -* [Работа в веб-интерфейÑе](tutorials/tutorial_webui) -* [ÐÐ²Ñ‚Ð¾Ñ€Ð¸Ð·Ð°Ñ†Ð¸Ñ Ñ Ð¿Ð¾Ð¼Ð¾Ñ‰ÑŒÑŽ LDAP](tutorials/auth_ldap) -* [Пользователи, привилегии и роли](tutorials/tutorial_users) -* [Работа Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ SQL](tutorials/tutorial_data) +### ИнÑтрукции и руководÑтва {: #tutorial } +* [УÑтановка Picodata](tutorial/install) +* [ЗапуÑк клаÑтера](tutorial/deploy) +* [Мониторинг клаÑтера](tutorial/monitoring) +* [Подключение и работа в конÑоли](tutorial/connecting) +* [Работа в веб-интерфейÑе](tutorial/webui) +* [ÐÐ²Ñ‚Ð¾Ñ€Ð¸Ð·Ð°Ñ†Ð¸Ñ Ñ Ð¿Ð¾Ð¼Ð¾Ñ‰ÑŒÑŽ LDAP](tutorial/ldap) +* [Управление доÑтупом](tutorial/tutorial_users) +* [Работа Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ SQL](tutorial/sql_examples) -### Справочные материалы {: #references } -* [Ðргументы командной Ñтроки](references/cli) -* [Типы данных SQL](references/datatypes) -* [Команды SQL](references/queries) -* [Публичный API](references/api) -* [СовмеÑтимоÑть Ñ ANSI SQL](references/reference) +### Справочные материалы {: #reference } +* [Ðргументы командной Ñтроки](reference/cli) +* [Типы данных SQL](reference/sql_types) +* [Команды SQL](reference/sql_queries) +* [Публичный API](reference/api) +* [СовмеÑтимоÑть Ñ ANSI SQL](reference/ansi_sql) -### Ðрхитектура {: #arch } -* [РаÑпределенный SQL](architecture/broadcasted_sql) +### Ðрхитектура {: #architecture } +* [РаÑпределенный SQL](architecture/distributed_sql) * [Ðлгоритм discovery](architecture/discovery) * [Raft и отказоуÑтойчивоÑть](architecture/raft_failover) * [Жизненный цикл клаÑтера](architecture/clustering) diff --git a/docs/general/benefits.md b/docs/overview/benefits.md similarity index 98% rename from docs/general/benefits.md rename to docs/overview/benefits.md index 5f537bfb..f5c68820 100644 --- a/docs/general/benefits.md +++ b/docs/overview/benefits.md @@ -32,4 +32,4 @@ Picodata — Ñто не только программное обеÑпечен * Выполнение запроÑов на изменение наÑтроек клаÑтера. --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/general/benefits.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/overview/benefits.md) diff --git a/docs/general/description.md b/docs/overview/description.md similarity index 62% rename from docs/general/description.md rename to docs/overview/description.md index cc73c692..b691e01d 100644 --- a/docs/general/description.md +++ b/docs/overview/description.md @@ -5,7 +5,7 @@ Picodata — Ñто раÑÐ¿Ñ€ÐµÐ´ÐµÐ»ÐµÐ½Ð½Ð°Ñ ÑиÑтема промышленного ÑƒÑ€Ð¾Ð²Ð½Ñ Ð´Ð»Ñ ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð±Ð°Ð·Ð°Ð¼Ð¸ данных Ñ Ð²Ð¾Ð·Ð¼Ð¾Ð¶Ð½Ð¾Ñтью раÑÑˆÐ¸Ñ€ÐµÐ½Ð¸Ñ Ñ„ÑƒÐ½ÐºÑ†Ð¸Ð¾Ð½Ð°Ð»ÑŒÐ½Ð¾Ñти за Ñчет плагинов. ИÑходный код Picodata [открыт](https://git.picodata.io/picodata/picodata){:target="_blank"}. Программное обеÑпечение Picodata реализует хранение Ñтруктурированных и неÑтруктурированных данных, транзакционное управление данными, Ñзыки запроÑов SQL и GraphQL, а также поддержку плагинов на Ñзыках Rust и Lua. ## Ðазначение {: #purpose } -ОÑновным назначением продукта Picodata ÑвлÑетÑÑ Ð³Ð¾Ñ€Ð¸Ð·Ð¾Ð½Ñ‚Ð°Ð»ÑŒÐ½Ð¾ маÑштабируемое хранение Ñтруктурированных и неÑтруктурированных данных, управление ими, предоÑтавление Ñреды вычиÑлений внутри клаÑтера, ÑоÑтоÑщего из [реплицированных](../general/glossary.md#replication) отдельных узлов (*[инÑтанÑов](../general/glossary.md#instance)*). Ð”Ð°Ð½Ð½Ð°Ñ ÐºÐ¾Ð¼Ð±Ð¸Ð½Ð°Ñ†Ð¸Ñ Ð²Ð¾Ð·Ð¼Ð¾Ð¶Ð½Ð¾Ñтей позволÑет Ñффективно реализовать Ñценарии ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð½Ð°Ð¸Ð±Ð¾Ð»ÐµÐµ воÑтребованными, чаÑто изменÑющимиÑÑ, *горÑчими* данными. Ð’ традиционных корпоративных архитектурах Ð´Ð»Ñ ÑƒÑÐºÐ¾Ñ€ÐµÐ½Ð¸Ñ Ð¸ Ð¿Ð¾Ð²Ñ‹ÑˆÐµÐ½Ð¸Ñ Ð½Ð°Ð´Ñ‘Ð¶Ð½Ð¾Ñти доÑтупа к данным клаÑÑичеÑких, универÑальных СУБД иÑпользуютÑÑ ÐºÑши и шины данных. Цель Ñ€Ð°Ð·Ð²Ð¸Ñ‚Ð¸Ñ Picodata: заменить три компонента корпоративной архитектуры — кÑш, шина и витрина доÑтупа к данным — единым, выÑокопроизводительным и Ñтрого конÑиÑтентным решением. +ОÑновным назначением продукта Picodata ÑвлÑетÑÑ Ð³Ð¾Ñ€Ð¸Ð·Ð¾Ð½Ñ‚Ð°Ð»ÑŒÐ½Ð¾ маÑштабируемое хранение Ñтруктурированных и неÑтруктурированных данных, управление ими, предоÑтавление Ñреды вычиÑлений внутри клаÑтера, ÑоÑтоÑщего из [реплицированных](../overview/glossary.md#replication) отдельных узлов (*[инÑтанÑов](../overview/glossary.md#instance)*). Ð”Ð°Ð½Ð½Ð°Ñ ÐºÐ¾Ð¼Ð±Ð¸Ð½Ð°Ñ†Ð¸Ñ Ð²Ð¾Ð·Ð¼Ð¾Ð¶Ð½Ð¾Ñтей позволÑет Ñффективно реализовать Ñценарии ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð½Ð°Ð¸Ð±Ð¾Ð»ÐµÐµ воÑтребованными, чаÑто изменÑющимиÑÑ, *горÑчими* данными. Ð’ традиционных корпоративных архитектурах Ð´Ð»Ñ ÑƒÑÐºÐ¾Ñ€ÐµÐ½Ð¸Ñ Ð¸ Ð¿Ð¾Ð²Ñ‹ÑˆÐµÐ½Ð¸Ñ Ð½Ð°Ð´Ñ‘Ð¶Ð½Ð¾Ñти доÑтупа к данным клаÑÑичеÑких, универÑальных СУБД иÑпользуютÑÑ ÐºÑши и шины данных. Цель Ñ€Ð°Ð·Ð²Ð¸Ñ‚Ð¸Ñ Picodata: заменить три компонента корпоративной архитектуры — кÑш, шина и витрина доÑтупа к данным — единым, выÑокопроизводительным и Ñтрого конÑиÑтентным решением. ## Роль в платформе данных {: #platform } С точки Ð·Ñ€ÐµÐ½Ð¸Ñ Ð¸ÑÐ¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ð½Ð¸Ñ Ð½Ð°ÑˆÐµÐ³Ð¾ ПО в ÑоÑтаве корпоративной платформы, Picodata предоÑтавлÑет операционный Ñлой ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ Ð´Ð»Ñ Ñ€ÐµÑˆÐµÐ½Ð¸Ð¹ клаÑÑа In-memory data grid (IMDG). Ðто Ñ€ÐµÐ·Ð¸Ð´ÐµÐ½Ñ‚Ð½Ð°Ñ Ð±Ð°Ð·Ð° данных Ð´Ð»Ñ Ð¾Ñ‡ÐµÐ½ÑŒ быÑтрой обработки Ñреднего по объёму маÑÑива данных. Ð’Ñе данные хранÑÑ‚ÑÑ Ð² оперативной памÑти, но при Ñтом они перÑиÑтентны за Ñчёт периодичеÑкого Ð¾Ð±Ð½Ð¾Ð²Ð»ÐµÐ½Ð¸Ñ Ñнимков БД (snapshots) на диÑке. Ðиже показана уÑÐ»Ð¾Ð²Ð½Ð°Ñ Ð¿Ð¸Ñ€Ð°Ð¼Ð¸Ð´Ð° ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ Ñ Ñ‚Ð¾Ñ‡ÐºÐ¸ Ð·Ñ€ÐµÐ½Ð¸Ñ Ð¸Ñ… объёма. @@ -17,7 +17,7 @@ Picodata занимает верхнюю чаÑть пирамиды, Ñ‚.к. о ## Задачи {: #features } Программное обеÑпечение Picodata решает Ñледующие задачи: -* Ñ€ÐµÐ°Ð»Ð¸Ð·Ð°Ñ†Ð¸Ñ Ð¾Ð±Ñ‰ÐµÐ³Ð¾ [линеаризованного](../general/glossary.md#linearizability) хранилища конфигурации, Ñхемы данных и топологии клаÑтера, вÑтроенного в раÑпределенную ÑиÑтему ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð±Ð°Ð·Ð°Ð¼Ð¸ данных; +* Ñ€ÐµÐ°Ð»Ð¸Ð·Ð°Ñ†Ð¸Ñ Ð¾Ð±Ñ‰ÐµÐ³Ð¾ [линеаризованного](../overview/glossary.md#linearizability) хранилища конфигурации, Ñхемы данных и топологии клаÑтера, вÑтроенного в раÑпределенную ÑиÑтему ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð±Ð°Ð·Ð°Ð¼Ð¸ данных; * предоÑтавление интерфейÑа командной Ñтроки по управлению топологией клаÑтера; * Ñ€ÐµÐ°Ð»Ð¸Ð·Ð°Ñ†Ð¸Ñ runtime-библиотек по работе Ñ Ñетью, файловому вводу-выводу, Ñ€ÐµÐ°Ð»Ð¸Ð·Ð°Ñ†Ð¸Ñ ÐºÐ¾Ð¾Ð¿ÐµÑ€Ð°Ñ‚Ð¸Ð²Ð½Ð¾Ð¹ многозадачноÑти и ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð¿Ð¾Ñ‚Ð¾ÐºÐ°Ð¼Ð¸, работа Ñо вÑтроенной СУБД ÑредÑтвами Ñзыка Rust; * поддержка Ñзыка SQL Ð´Ð»Ñ Ñ€Ð°Ð±Ð¾Ñ‚Ñ‹ как Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ отдельного инÑтанÑа, так и Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ вÑего клаÑтера; @@ -51,7 +51,7 @@ Picodata занимает верхнюю чаÑть пирамиды, Ñ‚.к. о * проÑÑ‚Ð°Ñ Ð½Ð°Ñтройка Ð´Ð»Ñ Ð·Ð°Ð¿ÑƒÑка шардированного клаÑтера. Ðе требуетÑÑ Ð¼Ð½Ð¾Ð³Ð¾ файлов конфигурации; * ÑовмеÑтимоÑть Ñ Ð»ÑŽÐ±Ñ‹Ð¼Ð¸ инÑтрументами Ñ€Ð°Ð·Ð²ÐµÑ€Ñ‚Ñ‹Ð²Ð°Ð½Ð¸Ñ Ð¸Ð½ÑтанÑов (Ansible, Chef, Puppet и др.); * обеÑпечение выÑокой доÑтупноÑти данных без необходимоÑти в клаÑтере Etcd и дополнительных наÑтройках; -* автоматичеÑкое определение активного инÑтанÑа в [репликаÑетах](../general/glossary.md#replicaset) любого размера; +* автоматичеÑкое определение активного инÑтанÑа в [репликаÑетах](../overview/glossary.md#replicaset) любого размера; * ÐµÐ´Ð¸Ð½Ð°Ñ Ñхема данных во вÑех репликаÑетах клаÑтера; * возможноÑть обновлÑть Ñхему данных и менÑть топологию работающего клаÑтера, например, добавлÑть новые инÑтанÑÑ‹. Picodata автоматичеÑки управлÑет верÑиÑми Ñхемы; * вÑтроенные инÑтрументы Ð´Ð»Ñ ÑÐ¾Ð·Ð´Ð°Ð½Ð¸Ñ Ð¸ запуÑка приложений; @@ -60,9 +60,9 @@ Picodata занимает верхнюю чаÑть пирамиды, Ñ‚.к. о ## Ðрхитектура клаÑтера {: #architecture } ### СоÑтавные чаÑти клаÑтера {: #cluster-internals } -Ðрхитектура клаÑтера Picodata предполагает ÑиÑтему отдельных *[инÑтанÑов](../general/glossary.md#instance)* — программных узлов, входÑщих в ÑоÑтав клаÑтера. Каждый такой узел может выполнÑть различные роли, например роль Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ…, роль Ñервера приложениÑ, или Ñлужебную роль координатора клаÑтера. +Ðрхитектура клаÑтера Picodata предполагает ÑиÑтему отдельных *[инÑтанÑов](../overview/glossary.md#instance)* — программных узлов, входÑщих в ÑоÑтав клаÑтера. Каждый такой узел может выполнÑть различные роли, например роль Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ…, роль Ñервера приложениÑ, или Ñлужебную роль координатора клаÑтера. Ð’Ñе инÑтанÑÑ‹ работают Ñ ÐµÐ´Ð¸Ð½Ð¾Ð¹ Ñхемой данных и кодом приложениÑ. Каждый процеÑÑ Ð±Ð°Ð·Ñ‹ данных выполнÑетÑÑ Ð½Ð° одном процеÑÑорном Ñдре и хранит иÑпользуемый набор данных в оперативной памÑти. -Любой отдельный инÑÑ‚Ð°Ð½Ñ ÑвлÑетÑÑ Ñ‡Ð°Ñтью набора реплик, который также называют *[репликаÑетом](../general/glossary.md#replicaset)*. РепликаÑет может ÑоÑтоÑть из одного или неÑкольких инÑтанÑов — дубликатов одного и того же набора данных. Внутри репликаÑета вÑегда еÑть *активный* инÑÑ‚Ð°Ð½Ñ Ð¸ — еÑли реплик больше 1 — то некоторое чиÑло *резервных* инÑтанÑов, обеÑпечивающих отказоуÑтойчивоÑть ÑиÑтемы в Ñлучае выхода из ÑÑ‚Ñ€Ð¾Ñ Ð¸Ð»Ð¸ недоÑтупноÑти активного инÑтанÑа. ЧиÑло реплик определÑетÑÑ *фактором репликации*, заданным в глобальных наÑтройках Picodata. +Любой отдельный инÑÑ‚Ð°Ð½Ñ ÑвлÑетÑÑ Ñ‡Ð°Ñтью набора реплик, который также называют *[репликаÑетом](../overview/glossary.md#replicaset)*. РепликаÑет может ÑоÑтоÑть из одного или неÑкольких инÑтанÑов — дубликатов одного и того же набора данных. Внутри репликаÑета вÑегда еÑть *активный* инÑÑ‚Ð°Ð½Ñ Ð¸ — еÑли реплик больше 1 — то некоторое чиÑло *резервных* инÑтанÑов, обеÑпечивающих отказоуÑтойчивоÑть ÑиÑтемы в Ñлучае выхода из ÑÑ‚Ñ€Ð¾Ñ Ð¸Ð»Ð¸ недоÑтупноÑти активного инÑтанÑа. ЧиÑло реплик определÑетÑÑ *фактором репликации*, заданным в глобальных наÑтройках Picodata. Ðа риÑунке ниже показана Ñхема проÑтого клаÑтера из двух репликаÑетов, каждый из которых ÑоÑтоит из двух инÑтанÑов (активного и резервного). @@ -71,21 +71,21 @@ Picodata занимает верхнюю чаÑть пирамиды, Ñ‚.к. о РепликаÑеты ÑвлÑÑŽÑ‚ÑÑ ÐµÐ´Ð¸Ð½Ð¸Ñ†Ð°Ð¼Ð¸ горизонтального маÑÑˆÑ‚Ð°Ð±Ð¸Ñ€Ð¾Ð²Ð°Ð½Ð¸Ñ ÐºÐ»Ð°Ñтера. Данные баланÑируютÑÑ Ð¼ÐµÐ¶Ð´Ñƒ ними автоматичеÑки. ### Хранение данных {: #data-storage } -Внутри каждого репликаÑета еÑть *бакет* ([bucket](../general/glossary.md#bucket)) — Ð²Ð¸Ñ€Ñ‚ÑƒÐ°Ð»Ð¸Ð·Ð¸Ñ€Ð¾Ð²Ð°Ð½Ð½Ð°Ñ Ð½ÐµÐ´ÐµÐ»Ð¸Ð¼Ð°Ñ ÐµÐ´Ð¸Ð½Ð¸Ñ†Ð° хранениÑ, обеÑÐ¿ÐµÑ‡Ð¸Ð²Ð°ÑŽÑ‰Ð°Ñ Ð»Ð¾ÐºÐ°Ð»ÑŒÐ½Ð¾Ñть данных (например, хранение неÑкольких ÑвÑзанных Ñ ÐºÐ»Ð¸ÐµÐ½Ñ‚Ð¾Ð¼ запиÑей на одном физичеÑком узле Ñети). Сам по Ñебе бакет не имеет ограничений по емкоÑти и может Ñодержать любой объем данных. Горизонтальное маÑштабирование позволÑет раÑпределить бакеты по разным шардам, Ð¾Ð¿Ñ‚Ð¸Ð¼Ð¸Ð·Ð¸Ñ€ÑƒÑ Ð¿Ñ€Ð¾Ð¸Ð·Ð²Ð¾Ð´Ð¸Ñ‚ÐµÐ»ÑŒÐ½Ð¾Ñть клаÑтера путем Ð´Ð¾Ð±Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð½Ð¾Ð²Ñ‹Ñ… реплицированных инÑтанÑов. Чем больше репликаÑетов входит в ÑоÑтав клаÑтера, тем меньше нагрузка на каждый из них. Бакет хранитÑÑ Ñ„Ð¸Ð·Ð¸Ñ‡ÐµÑки на одном репликаÑете и ÑвлÑетÑÑ Ð¿Ñ€Ð¾Ð¼ÐµÐ¶ÑƒÑ‚Ð¾Ñ‡Ð½Ñ‹Ð¼ звеном между данными и уÑтройÑтвом хранениÑ. Ð’ каждом репликаÑете может быть много бакетов (или не быть ни одного). Внутри бакета данные задублированы по вÑем инÑтанÑам в рамках репликаÑета в ÑоответÑтвии Ñ Ñ„Ð°ÐºÑ‚Ð¾Ñ€Ð¾Ð¼ репликации. КоличеÑтво бакетов может быть задано при первоначальной наÑтройке клаÑтера. По умолчанию клаÑтер Picodata иÑпользует 3000 бакетов. +Внутри каждого репликаÑета еÑть *бакет* ([bucket](../overview/glossary.md#bucket)) — Ð²Ð¸Ñ€Ñ‚ÑƒÐ°Ð»Ð¸Ð·Ð¸Ñ€Ð¾Ð²Ð°Ð½Ð½Ð°Ñ Ð½ÐµÐ´ÐµÐ»Ð¸Ð¼Ð°Ñ ÐµÐ´Ð¸Ð½Ð¸Ñ†Ð° хранениÑ, обеÑÐ¿ÐµÑ‡Ð¸Ð²Ð°ÑŽÑ‰Ð°Ñ Ð»Ð¾ÐºÐ°Ð»ÑŒÐ½Ð¾Ñть данных (например, хранение неÑкольких ÑвÑзанных Ñ ÐºÐ»Ð¸ÐµÐ½Ñ‚Ð¾Ð¼ запиÑей на одном физичеÑком узле Ñети). Сам по Ñебе бакет не имеет ограничений по емкоÑти и может Ñодержать любой объем данных. Горизонтальное маÑштабирование позволÑет раÑпределить бакеты по разным шардам, Ð¾Ð¿Ñ‚Ð¸Ð¼Ð¸Ð·Ð¸Ñ€ÑƒÑ Ð¿Ñ€Ð¾Ð¸Ð·Ð²Ð¾Ð´Ð¸Ñ‚ÐµÐ»ÑŒÐ½Ð¾Ñть клаÑтера путем Ð´Ð¾Ð±Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð½Ð¾Ð²Ñ‹Ñ… реплицированных инÑтанÑов. Чем больше репликаÑетов входит в ÑоÑтав клаÑтера, тем меньше нагрузка на каждый из них. Бакет хранитÑÑ Ñ„Ð¸Ð·Ð¸Ñ‡ÐµÑки на одном репликаÑете и ÑвлÑетÑÑ Ð¿Ñ€Ð¾Ð¼ÐµÐ¶ÑƒÑ‚Ð¾Ñ‡Ð½Ñ‹Ð¼ звеном между данными и уÑтройÑтвом хранениÑ. Ð’ каждом репликаÑете может быть много бакетов (или не быть ни одного). Внутри бакета данные задублированы по вÑем инÑтанÑам в рамках репликаÑета в ÑоответÑтвии Ñ Ñ„Ð°ÐºÑ‚Ð¾Ñ€Ð¾Ð¼ репликации. КоличеÑтво бакетов может быть задано при первоначальной наÑтройке клаÑтера. По умолчанию клаÑтер Picodata иÑпользует 3000 бакетов. Ðиже показан пример Ñхемы Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ… внутри репликаÑета.  ### ОтказоуÑтойчивоÑть {: #failover } -Ðаличие неÑкольких реплик внутри репликаÑета обеÑпечивают его [отказоуÑтойчивоÑть](../general/glossary.md#failsoft). Дополнительно Ð´Ð»Ñ Ð¿Ð¾Ð²Ñ‹ÑˆÐµÐ½Ð¸Ñ Ð½Ð°Ð´ÐµÐ¶Ð½Ð¾Ñти каждый инÑÑ‚Ð°Ð½Ñ ÐºÐ»Ð°Ñтера внутри репликаÑета находитÑÑ Ð½Ð° разных физичеÑких Ñерверах, а в некоторых ÑлучаÑÑ… — в удаленных друг от друга датацентрах. Таким образом, в Ñлучае недоÑтупноÑти датацентра в репликаÑете проиÑходит переключение на резервную реплику/инÑÑ‚Ð°Ð½Ñ Ð±ÐµÐ· Ð¿Ñ€ÐµÑ€Ñ‹Ð²Ð°Ð½Ð¸Ñ Ñ€Ð°Ð±Ð¾Ñ‚Ñ‹. +Ðаличие неÑкольких реплик внутри репликаÑета обеÑпечивают его [отказоуÑтойчивоÑть](../overview/glossary.md#failsoft). Дополнительно Ð´Ð»Ñ Ð¿Ð¾Ð²Ñ‹ÑˆÐµÐ½Ð¸Ñ Ð½Ð°Ð´ÐµÐ¶Ð½Ð¾Ñти каждый инÑÑ‚Ð°Ð½Ñ ÐºÐ»Ð°Ñтера внутри репликаÑета находитÑÑ Ð½Ð° разных физичеÑких Ñерверах, а в некоторых ÑлучаÑÑ… — в удаленных друг от друга датацентрах. Таким образом, в Ñлучае недоÑтупноÑти датацентра в репликаÑете проиÑходит переключение на резервную реплику/инÑÑ‚Ð°Ð½Ñ Ð±ÐµÐ· Ð¿Ñ€ÐµÑ€Ñ‹Ð²Ð°Ð½Ð¸Ñ Ñ€Ð°Ð±Ð¾Ñ‚Ñ‹. Пример географичеÑкого раÑÐ¿Ñ€ÐµÐ´ÐµÐ»ÐµÐ½Ð¸Ñ Ñ€ÐµÐ¿Ð»Ð¸ÐºÐ°Ñета показан на Ñхеме ниже.  ### Шардирование {: #sharding } -[Шардирование](../general/glossary.md#sharding) — Ñто раÑпределение бакетов между различными репликаÑетами. Ð’ Picodata иÑпользуетÑÑ Ð¾Ñнованное на Ñ…Ñшах шардирование Ñ Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸ÐµÐ¼ данных в виртуальных бакетах. Каждый репликаÑет ÑвлÑетÑÑ *шардом*, и чем больше репликаÑетов имеетÑÑ Ð² клаÑтере, тем Ñффективнее Ð´Ð°Ð½Ð½Ð°Ñ Ñ„ÑƒÐ½ÐºÑ†Ð¸Ñ Ð¼Ð¾Ð¶ÐµÑ‚ разделить маÑÑив данных на отдельные наборы данных меньшего размера. При добавлении новых инÑтанÑов в клаÑтер и/или формировании новых репликаÑетов Picodata автоматичеÑки равномерно раÑпределит бакеты Ñ ÑƒÑ‡ÐµÑ‚Ð¾Ð¼ новой конфигурации. +[Шардирование](../overview/glossary.md#sharding) — Ñто раÑпределение бакетов между различными репликаÑетами. Ð’ Picodata иÑпользуетÑÑ Ð¾Ñнованное на Ñ…Ñшах шардирование Ñ Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸ÐµÐ¼ данных в виртуальных бакетах. Каждый репликаÑет ÑвлÑетÑÑ *шардом*, и чем больше репликаÑетов имеетÑÑ Ð² клаÑтере, тем Ñффективнее Ð´Ð°Ð½Ð½Ð°Ñ Ñ„ÑƒÐ½ÐºÑ†Ð¸Ñ Ð¼Ð¾Ð¶ÐµÑ‚ разделить маÑÑив данных на отдельные наборы данных меньшего размера. При добавлении новых инÑтанÑов в клаÑтер и/или формировании новых репликаÑетов Picodata автоматичеÑки равномерно раÑпределит бакеты Ñ ÑƒÑ‡ÐµÑ‚Ð¾Ð¼ новой конфигурации. Пример автоматичеÑкого ÑˆÐ°Ñ€Ð´Ð¸Ñ€Ð¾Ð²Ð°Ð½Ð¸Ñ Ð¿Ñ€Ð¸ добавлении в клаÑтер новых инÑтанÑов показан на Ñхеме ниже. @@ -95,4 +95,4 @@ Picodata занимает верхнюю чаÑть пирамиды, Ñ‚.к. о --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/general/description.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/overview/description.md) diff --git a/docs/general/feedback.md b/docs/overview/feedback.md similarity index 92% rename from docs/general/feedback.md rename to docs/overview/feedback.md index 5ef77924..2522b5cc 100644 --- a/docs/general/feedback.md +++ b/docs/overview/feedback.md @@ -10,4 +10,4 @@ Telegram-канале [@picodataru](https://t.me/picodataru){:target="_blank"}. --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/general/feedback.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/overview/feedback.md) diff --git a/docs/general/glossary.md b/docs/overview/glossary.md similarity index 99% rename from docs/general/glossary.md rename to docs/overview/glossary.md index 8ec6fb83..a322ab10 100644 --- a/docs/general/glossary.md +++ b/docs/overview/glossary.md @@ -335,4 +335,4 @@ sharding_key: **ÐœÐ°Ñ‚ÐµÑ€Ð¸Ð°Ð»Ð¸Ð·Ð°Ñ†Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ…**. Один из Ñтапов иÑÐ¿Ð¾Ð»Ð½ÐµÐ½Ð¸Ñ Ñ€Ð°Ñпределенного SQL-запроÑа, при котором на отдельном узле промежуточные данные ÑохранÑÑŽÑ‚ÑÑ Ð² его памÑти. --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/general/glossary.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/overview/glossary.md) diff --git a/docs/references/reference.md b/docs/reference/ansi_sql.md similarity index 98% rename from docs/references/reference.md rename to docs/reference/ansi_sql.md index 4e4e3322..57593354 100644 --- a/docs/references/reference.md +++ b/docs/reference/ansi_sql.md @@ -96,7 +96,7 @@ Picodata SQL требованиÑм Ñтандарта SQL:2016, а именно ### E071-03. Табличный оператор EXCEPT DISTINCT ### F041-03. LEFT OUTER JOIN. -См. также: [Пример работы Ñ SQL Broadcaster в Picodata](../tutorials/tutorial_data.md). +См. также: [Работа Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ SQL](../tutorial/sql_examples.md). --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/sql/reference.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/sql/ansi_sql.md) diff --git a/docs/references/api.md b/docs/reference/api.md similarity index 97% rename from docs/references/api.md rename to docs/reference/api.md index b6070c2a..f0cb0e17 100644 --- a/docs/references/api.md +++ b/docs/reference/api.md @@ -32,7 +32,7 @@ picodata> pico.help("help") | [pico.PICODATA_VERSION](#picopicodata_version) | ВерÑÐ¸Ñ Picodata. | [pico.abort_ddl](#picoabort_ddl) | Отмена ожидающей операции по изменению Ñхемы данных. | [pico.args](#picoargs) | Вывод аргументов запуÑка `picodata run`. -| [pico.cas()](#picocas) | Ð—Ð°Ð¿Ñ€Ð¾Ñ Ð½Ð° изменение параметров методом [Compare and Swap](../general/glossary.md#as-compare-and-swap). +| [pico.cas()](#picocas) | Ð—Ð°Ð¿Ñ€Ð¾Ñ Ð½Ð° изменение параметров методом [Compare and Swap](../overview/glossary.md#cas). | [pico.change_password()](#picochange_password) | Изменение Ð¿Ð°Ñ€Ð¾Ð»Ñ Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ. | [pico.create_role()](#picocreate_role) | Создание роли. | [pico.create_table()](#picocreate_table) | Создание таблицы. @@ -44,20 +44,20 @@ picodata> pico.help("help") | [pico.expel()](#picoexpel) | [Контролируемый вывод](cli.md#expel) инÑтанÑа из клаÑтера. | [pico.grant_privilege()](#picogrant_privilege) | Ðазначение привилегии пользователю или роли. | [pico.help()](#picohelp) | ДоÑтуп к вÑтроенной Ñправочной ÑиÑтеме. -| [pico.instance_info()](#picoinstance_info) | Получение информации об инÑтанÑе (идентификаторы, уровни ([grade](../general/glossary.md#grade)) и прочее). -| [pico.raft_compact_log()](#picoraft_compact_log) | [КомпактизациÑ](../general/glossary.md#raft-raft-log-compaction) raft-журнала c удалением указанного чиÑла наиболее Ñтарых запиÑей. +| [pico.instance_info()](#picoinstance_info) | Получение информации об инÑтанÑе (идентификаторы, уровни ([grade](../overview/glossary.md#grade)) и прочее). +| [pico.raft_compact_log()](#picoraft_compact_log) | [КомпактизациÑ](../overview/glossary.md#raft-raft-log-compaction) raft-журнала c удалением указанного чиÑла наиболее Ñтарых запиÑей. | [pico.raft_get_index()](#picoraft_get_index) | Получение текущего примененного индекÑа raft-журнала. | [pico.raft_log()](#picoraft_log) | Чтение Ñодержимого raft-журнала. | [pico.raft_propose_nop()](#picoraft_propose_nop) | Добавление в raft-журнал запиÑÑŒ `Nop` (no operation). | [pico.raft_read_index()](#picoraft_read_index) | Кворумное чтение индекÑа raft-журнала. -| [pico.raft_status()](#picoraft_status) | Получение данных о текущем ÑоÑтоÑнии raft ([терм](../general/glossary.md#term), [лидер](../general/glossary.md#leader) и Ñ‚.д.). +| [pico.raft_status()](#picoraft_status) | Получение данных о текущем ÑоÑтоÑнии raft ([терм](../overview/glossary.md#term), [лидер](../overview/glossary.md#leader) и Ñ‚.д.). | [pico.raft_term()](#picoraft_term) | Получение номера терма (текущего или Ð´Ð»Ñ ÑƒÐºÐ°Ð·Ð°Ð½Ð½Ð¾Ð¹ запиÑи). | [pico.raft_timeout_now()](#picoraft_timeout_now) | Ðемедленное объÑвление новых выборов в raft-группе. | [pico.raft_wait_index()](#picoraft_wait_index) | Ожидание локального Ð¿Ñ€Ð¸Ð¼ÐµÐ½ÐµÐ½Ð¸Ñ ÑƒÐºÐ°Ð·Ð°Ð½Ð½Ð¾Ð³Ð¾ raft-индекÑа. | [pico.revoke_privilege()](#picorevoke_privilege) | Удаление привилегии у Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ Ð¸Ð»Ð¸ роли. | [pico.sql()](#picosql) | Выполнение клаÑтерных SQL-запроÑов. | [pico.wait_ddl_finalize()](#picowait_ddl_finalize) | Ожидание Ð¿Ñ€Ð¸Ð¼ÐµÐ½ÐµÐ½Ð¸Ñ (финализации) DDL-операции. -| [pico.wait_vclock()](#picowait_vclock) | Ожидание момента, когда значение [Vclock](../general/glossary.md#vclock-vector-clock) доÑтигнет целевого. +| [pico.wait_vclock()](#picowait_vclock) | Ожидание момента, когда значение [Vclock](../overview/glossary.md#vclock-vector-clock) доÑтигнет целевого. | [pico.whoami()](#picowhoami) | Отображение данных о текущем инÑтанÑе. @@ -310,7 +310,7 @@ function create_table(opts) - `sharding_fn` (optional _string_), поддерживаетÑÑ Ð¿Ð¾ÐºÐ° только Ñ„ÑƒÐ½ÐºÑ†Ð¸Ñ `murmur3` - `engine` (optional _string_), движок Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ… в БД; варианты: `'memtx'` | `'vinyl'`. По умолчанию иÑпользуетÑÑ - `'memtx'`. См [подробнее](../general/glossary.md#db-engine). + `'memtx'`. См [подробнее](../overview/glossary.md#db-engine). - `timeout` (optional _number_), чиÑло в Ñекундах. По умолчанию иÑпользуетÑÑ Ð±ÐµÑконечное значение. @@ -807,7 +807,7 @@ picodata> pico.raft_read_index(1) ### pico.raft_status Получает данные о текущем ÑоÑтоÑнии raft-узла -([терм](../general/glossary.md#term), [лидер](../general/glossary.md#leader) и Ñ‚.д.). Ð¤ÑƒÐ½ÐºÑ†Ð¸Ñ +([терм](../overview/glossary.md#term), [лидер](../overview/glossary.md#leader) и Ñ‚.д.). Ð¤ÑƒÐ½ÐºÑ†Ð¸Ñ Ð½Ðµ имеет передаваемых параметров. Возвращаемые полÑ: @@ -1044,8 +1044,8 @@ pico.sql([[ ... ``` -См. также [пример работы Ñ SQL в Picodata](../tutorials/tutorial_data.md) и [опиÑание -команд SQL](../references/queries.md). +См. также [пример работы Ñ SQL в Picodata](../tutorial/sql_examples.md) и [опиÑание +команд SQL](../reference/sql_queries.md). ### pico.wait_ddl_finalize Ожидает Ð¿Ñ€Ð¸Ð¼ÐµÐ½ÐµÐ½Ð¸Ñ (финализации) DDL-операции Ð´Ð»Ñ ÑƒÐºÐ°Ð·Ð°Ð½Ð½Ð¾Ð³Ð¾ @@ -1068,7 +1068,7 @@ function wait_ddl_finalize(index, opts) ### pico.wait_vclock Ожидает момента, когда значение -[Vclock](../general/glossary.md#vclock-vector-clock) в Tarantool доÑтигнет +[Vclock](../overview/glossary.md#vclock-vector-clock) в Tarantool доÑтигнет целевого. ```lua @@ -1182,15 +1182,15 @@ Lua-таблица, опиÑÑ‹Ð²Ð°ÑŽÑ‰Ð°Ñ Ð¿Ð¾Ð»Ðµ в ÑоÑтаве табли ### table Vclock {: #vclock_table } Lua-таблица, Ð¾Ñ‚Ñ€Ð°Ð¶Ð°ÑŽÑ‰Ð°Ñ ÑоответÑтвие `id` инÑтанÑа его -[LSN-номеру](../general/glossary.md#lsn). +[LSN-номеру](../overview/glossary.md#lsn). Пример: ```lua {[0] = 2, [1] = 101} {[0] = 148, [1] = 9086, [3] = 2} ``` -См. подробнее опиÑание [Vclock](../general/glossary.md#vclock). Ðулевое значение Vclock зарезервировано +См. подробнее опиÑание [Vclock](../overview/glossary.md#vclock). Ðулевое значение Vclock зарезервировано Ð´Ð»Ñ Ð¾Ñ‚ÑÐ»ÐµÐ¶Ð¸Ð²Ð°Ð½Ð¸Ñ Ð»Ð¾ÐºÐ°Ð»ÑŒÐ½Ñ‹Ñ… изменений, которые не реплицируютÑÑ. --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/references/api.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/reference/api.md) diff --git a/docs/references/cli.md b/docs/reference/cli.md similarity index 99% rename from docs/references/cli.md rename to docs/reference/cli.md index 1bd3e419..4071d457 100644 --- a/docs/references/cli.md +++ b/docs/reference/cli.md @@ -247,7 +247,7 @@ picodata expel [Параметры] — Ñервер можно выключать. -Подробнее об уÑтройÑтве клаÑтера и репликаÑетов Picodata Ñм. в разделе [ЗапуÑк клаÑтера](../tutorials/deploy_on_hosts.md). +Подробнее об уÑтройÑтве клаÑтера и репликаÑетов Picodata Ñм. в разделе [ЗапуÑк клаÑтера](../tutorial/deploy.md). --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/references/cli.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/reference/cli.md) diff --git a/docs/references/queries.md b/docs/reference/sql_queries.md similarity index 98% rename from docs/references/queries.md rename to docs/reference/sql_queries.md index 3f1b591e..85f48f85 100644 --- a/docs/references/queries.md +++ b/docs/reference/sql_queries.md @@ -7,7 +7,7 @@ Picodata при работе Ñ Ñ€Ð°Ñпределенной СУБД. - Data Definition Language (`DDL`): команды Ð´Ð»Ñ [ÑозданиÑ](#create_table) и [удалениÑ](#drop_table) - [таблиц](../general/glossary.md#table); + [таблиц](../overview/glossary.md#table); - Data Modification Language (`DML`): команды [`INSERT`](#insert) Ð´Ð»Ñ Ð´Ð¾Ð±Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ… в таблицы и [`DELETE`](#delete) Ð´Ð»Ñ ÑƒÐ´Ð°Ð»ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ…; - Data Query Language (`DQL`): команда [`SELECT`](#select) Ð´Ð»Ñ Ð¿Ð¾Ð»ÑƒÑ‡ÐµÐ½Ð¸Ñ @@ -35,8 +35,8 @@ Picodata при работе Ñ Ñ€Ð°Ñпределенной СУБД. ## Ðачало работы {: #getting-started } Ð”Ð»Ñ Ð²Ð²Ð¾Ð´Ð° команд SQL требуетÑÑ Ð¸Ð½Ñ‚ÐµÑ€Ð°ÐºÑ‚Ð¸Ð²Ð½Ð°Ñ ÐºÐ¾Ð½Ñоль Picodata. Она -доÑтупна поÑле [запуÑка](../references/cli.md#run-command) инÑтанÑа Ñ ÐºÐ»ÑŽÑ‡Ð¾Ð¼ `-i` -или Ñвного [подключениÑ](../references/cli.md#connect-command) к нему из отдельного +доÑтупна поÑле [запуÑка](../reference/cli.md#run-command) инÑтанÑа Ñ ÐºÐ»ÑŽÑ‡Ð¾Ð¼ `-i` +или Ñвного [подключениÑ](../reference/cli.md#connect-command) к нему из отдельного терминала. ### ДоÑтупные Ñзыки конÑоли {: #available_langs } @@ -119,7 +119,7 @@ create user andy with password 'P@ssw0rd' using md5 option (timeout = 3.0) ```sql drop user andy ``` -См. [подробнее](../tutorials/tutorial_users.md) об управлении пользователÑми. +См. [подробнее](../tutorial/tutorial_users.md) об управлении пользователÑми. ## Создание таблицы {: #create_table } @@ -155,7 +155,7 @@ drop user andy - _шардированными_, Ñ‚.е. раÑпределенные по шардам клаÑтера. Ð”Ð»Ñ ÑÐ¾Ð·Ð´Ð°Ð½Ð¸Ñ ÑˆÐ°Ñ€Ð´Ð¸Ñ€Ð¾Ð²Ð°Ð½Ð½Ð¾Ð¹ таблицы Ñледует иÑпользовать параметр `distributed by ()`, указав в Ñкобках название колонки, по которой Ñ‚Ð°ÐºÐ°Ñ Ñ‚Ð°Ð±Ð»Ð¸Ñ†Ð° будет - раÑпределена. См. [подробнее](../general/glossary.md#table). + раÑпределена. См. [подробнее](../overview/glossary.md#table). Ð”Ð»Ñ Ð´ÐµÐ¼Ð¾Ð½Ñтрации работы раÑпределенного SQL будем Ñоздавать шардированные таблицы. Создадим первую таблицу Ñледующей командой: @@ -175,7 +175,7 @@ option (timeout = 3.0) ; При Ñоздании таблицы также можно выбрать один из доÑтупных движков Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ…: - - `memtx` — [движок Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ…](../general/glossary.md#db-engine) в ОЗУ (in-memory); + - `memtx` — [движок Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ…](../overview/glossary.md#db-engine) в ОЗУ (in-memory); - `vinyl` — диÑковый движок Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ…, иÑпользующий LSM-Ð´ÐµÑ€ÐµÐ²ÑŒÑ (Log Structured Merge Tree). @@ -610,7 +610,7 @@ on "characters"."id" = stock."number" ; SELECT-запроÑах. С ее помощью можно преобразовать чиÑла в текÑÑ‚, дробные чиÑла в целые и так далее ÑоглаÑно приведенной [выше](#type) Ñхеме. Поддерживаемые в Picodata типы данных приведены в [отдельном -документе](../datatypes). +документе](../sql_types). ### Пример запроÑа {: #cast-example } Ð’ качеÑтве примера покажем преобразование дробных чиÑел в целые Ñ @@ -756,7 +756,7 @@ insert into "assets" values (1, 'Woody', 2561) ; фикÑированной запÑтой (например, `values(2.5)` в `decimal 2.5`). Ð’ параметризированном виде дробнному чиÑлу будет назначен типа Ñ Ð¿Ð»Ð°Ð²Ð°ÑŽÑ‰ÐµÐ¹ запÑтой (например, `values(?), {2.5}` в `double 2.5`). См. -[подробнее](datatypes) о типах данных. +[подробнее](sql_types) о типах данных. При иÑпользовании `INSERT` вмеÑте Ñ Ð¿Ð¾Ð´Ð·Ð°Ð¿Ñ€Ð¾Ñом (`SELECT`) проиÑходит кеширование подзапроÑа, поÑтому его тоже имеет ÑмыÑл параметризировать, @@ -1092,7 +1092,7 @@ explain insert into "assets" values (1, 'Woody', 2561) ; **Ð›Ð¾ÐºÐ°Ð»ÑŒÐ½Ð°Ñ Ð¼Ð°Ñ‚ÐµÑ€Ð¸Ð°Ð»Ð¸Ð·Ð°Ñ†Ð¸Ñ** отноÑитÑÑ Ðº тем ÑлучаÑм, когда требуетÑÑ Ð¿Ð¾Ð»Ð¾Ð¶Ð¸Ñ‚ÑŒ в памÑть прочитанные данные из локального запроÑа Ð´Ð»Ñ Ð¸Ñ… дальнейшей обработки. ÐŸÐµÑ€ÐµÐ¼ÐµÑ‰ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ… нет и вычиÑление `bucket_id` не -требуетÑÑ (Ñм. [подробнее](../architecture/broadcasted_sql.md#data-distribution)). +требуетÑÑ (Ñм. [подробнее](../architecture/distributed_sql.md#data-distribution)). Примером может Ñлужить удаление данных из таблицы: ```sql @@ -1271,8 +1271,8 @@ explain select count("id") from "characters" ; ... ``` -Читать далее: [Типы данных SQL](datatypes.md) +Читать далее: [Типы данных SQL](sql_types.md) <!-- ebnf source: https://git.picodata.io/picodata/picodata/sbroad/-/blob/main/doc/sql/query.ebnf --> --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/references/queries.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/reference/sql_queries.md) diff --git a/docs/references/datatypes.md b/docs/reference/sql_types.md similarity index 94% rename from docs/references/datatypes.md rename to docs/reference/sql_types.md index f3203c93..dfc07e51 100644 --- a/docs/references/datatypes.md +++ b/docs/reference/sql_types.md @@ -28,7 +28,7 @@ - `VARCHAR`. ТекÑтовый тип данных Ñ Ñвно заданной длиной Ñтроки. -См. также: [СовмеÑтимоÑть Ñ ANSI SQL](reference.md) +См. также: [СовмеÑтимоÑть Ñ ANSI SQL](ansi_sql.md) --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/references/datatypes.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/reference/sql_types.md) diff --git a/docs/tutorials/tutorial_first_steps.md b/docs/tutorial/connecting.md similarity index 87% rename from docs/tutorials/tutorial_first_steps.md rename to docs/tutorial/connecting.md index 0d38e00c..787c2e21 100644 --- a/docs/tutorials/tutorial_first_steps.md +++ b/docs/tutorial/connecting.md @@ -13,8 +13,7 @@ админиÑтратора СУБД (`admin`) и разрешает вÑе дейÑÑ‚Ð²Ð¸Ñ Ð² рамках локальной конÑоли. При Ñтом, Ð¿Ñ€Ð¸Ð²Ð¸Ð»ÐµÐ³Ð¸Ñ `SESSION`, позволÑÑŽÑ‰Ð°Ñ Ð¿Ð¾Ð´ÐºÐ»ÑŽÑ‡Ð°Ñ‚ÑŒÑÑ Ðº удаленным инÑтанÑам по Ñети, у локального админиÑтратора -отÑутÑтвует. Подробнее Ñм. в разделе [Пользователи, привилегии и -роли](tutorial_users.md). +отÑутÑтвует. Подробнее Ñм. в разделе [Управление доÑтупом](tutorial_users.md). ## Подключение к ранее запущенному ÑкземплÑру {: #accessing-running-instace } ### Подключение Ñ Ð¿Ð¾Ð¼Ð¾Ñ‰ÑŒÑŽ адреÑа ÑкземплÑра {: #picodata-connect } @@ -22,7 +21,7 @@ ``` picodata connect localhost:3301 ``` -По умолчанию, [подключение](../references/cli.md#connect-command) производитÑÑ Ð¿Ð¾Ð´ +По умолчанию, [подключение](../reference/cli.md#connect-command) производитÑÑ Ð¿Ð¾Ð´ пользователем `guest` без паролÑ. У такого Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ Ð¸Ð¼ÐµÐµÑ‚ÑÑ ÐµÐ´Ð¸Ð½ÑÑ‚Ð²ÐµÐ½Ð½Ð°Ñ Ð¿Ñ€Ð¸Ð²Ð¸Ð»ÐµÐ³Ð¸Ñ [`SESSION`](tutorial_users.md#available-privileges). @@ -58,16 +57,16 @@ picodata connect --unix /tmp/file.socket ``` ## Рабочие файлы инÑтанÑа -Ð’ [директории Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ инÑтанÑа](../references/cli.md#data-dir) автоматичеÑки поÑвлÑÑŽÑ‚ÑÑ Ñледующие файлы: +Ð’ [директории Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ инÑтанÑа](../reference/cli.md#data-dir) автоматичеÑки поÑвлÑÑŽÑ‚ÑÑ Ñледующие файлы: -- `*.snap` — файлы [Ñнапшотов](../general/glossary.md#snapshot) БД +- `*.snap` — файлы [Ñнапшотов](../overview/glossary.md#snapshot) БД - `*.xlog` — файлы журнала упреждающей запиÑи (Write-ahead log, WAL) c инкрементными изменениÑми БД - `*.vylog` — также файлы Ñ Ð¸Ð½ÐºÑ€ÐµÐ¼ÐµÐ½Ñ‚Ð½Ñ‹Ð¼Ð¸ изменениÑми БД, но Ð´Ð»Ñ Ñ‚Ð°Ð±Ð»Ð¸Ñ†, - иÑпользующих движок Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ [`vinyl`](../general/glossary.md#db-engine). + иÑпользующих движок Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ [`vinyl`](../overview/glossary.md#db-engine). При перезапуÑке инÑтанÑа Ñти файлы необходимы Ð´Ð»Ñ Ð²Ð¾ÑÑÑ‚Ð°Ð½Ð¾Ð²Ð»ÐµÐ½Ð¸Ñ ÐµÐ³Ð¾ -ÑоÑтоÑниÑ, обеÑÐ¿ÐµÑ‡Ð¸Ð²Ð°Ñ [перÑиÑтентное](../general/glossary.md#persistence) хранение +ÑоÑтоÑниÑ, обеÑÐ¿ÐµÑ‡Ð¸Ð²Ð°Ñ [перÑиÑтентное](../overview/glossary.md#persistence) хранение данных. Файлы Ñнапшотов (`*.snap`) и журнала WAL (`*.xlog`/`*.vylog`) не @@ -77,8 +76,8 @@ picodata connect --unix /tmp/file.socket данных нужен будет и поÑледний Ñнапшот, и один или неÑколько файлов журнала. -Параметры запуÑка из командной Ñтроки опиÑаны в разделе [Ðргументы командной Ñтроки Picodata](../references/cli.md). +Параметры запуÑка из командной Ñтроки опиÑаны в разделе [Ðргументы командной Ñтроки](../reference/cli.md). --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorials/tutorial_first_steps.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorial/connecting.md) diff --git a/docs/tutorials/deploy_on_hosts.md b/docs/tutorial/deploy.md similarity index 98% rename from docs/tutorials/deploy_on_hosts.md rename to docs/tutorial/deploy.md index 14e60d20..4728d6c4 100644 --- a/docs/tutorials/deploy_on_hosts.md +++ b/docs/tutorial/deploy.md @@ -10,8 +10,8 @@ ЗапуÑк клаÑтера ÑводитÑÑ Ðº выполнению команды `picodata run` Ñ Ð½ÑƒÐ¶Ð½Ñ‹Ð¼ набором параметров Ð´Ð»Ñ ÐºÐ°Ð¶Ð´Ð¾Ð³Ð¾ инÑтанÑа (узла). Полный перечень возможных параметров запуÑка и их опиÑание ÑодержатÑÑ Ð² разделе -[Ðргументы командной Ñтроки Picodata](../../references/cli), а также в выводе команды -`picodata run --help`. С точки Ð·Ñ€ÐµÐ½Ð¸Ñ Ð²Ð½ÑƒÑ‚Ñ€ÐµÐ½Ð½ÐµÐ¹ архитектуры, [_клаÑтер_](../general/glossary.md#cluster) +[Ðргументы командной Ñтроки Picodata](../../reference/cli), а также в выводе команды +`picodata run --help`. С точки Ð·Ñ€ÐµÐ½Ð¸Ñ Ð²Ð½ÑƒÑ‚Ñ€ÐµÐ½Ð½ÐµÐ¹ архитектуры, [_клаÑтер_](../overview/glossary.md#cluster) корректно называть _raft-группой_ — в дальнейшем при мониторинге и управлении конфигурацией будет умеÑтнее иÑпользовать именно Ñтот термин. @@ -45,7 +45,7 @@ picodata run --data-dir i3 --listen :3303 предоÑтавлÑет доÑтуп к управлению им в конÑоли. Ð”Ð»Ñ Ð¿Ð¾Ð´ÐºÐ»ÑŽÑ‡ÐµÐ½Ð¸Ñ Ðº интерактивной конÑоли Ñледует либо запуÑкать инÑÑ‚Ð°Ð½Ñ Ñ ÐºÐ»ÑŽÑ‡Ð¾Ð¼ `-i` (`picodata run -i`), либо отдельно подключатьÑÑ Ðº инÑтанÑу командой -`picodata connect` (Ñм. [подробнее](../references/cli.md#connect-command)). +`picodata connect` (Ñм. [подробнее](../reference/cli.md#connect-command)). ## КлаÑтер на неÑкольких Ñерверах {: #distributed-cluster } @@ -243,4 +243,4 @@ pico.expel("i3") См. [отдельный подраздел](../../architecture/raft_failover) Ñ Ð¾Ð¿Ð¸Ñанием работы алгоритма Raft Ð´Ð»Ñ Ð¾Ð±ÐµÑÐ¿ÐµÑ‡ÐµÐ½Ð¸Ñ Ð¾Ñ‚ÐºÐ°Ð·Ð¾ÑƒÑтойчивоÑти клаÑтера. --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorials/deploy_on_hosts.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorial/deploy.md) diff --git a/docs/tutorials/install.md b/docs/tutorial/install.md similarity index 98% rename from docs/tutorials/install.md rename to docs/tutorial/install.md index 50dffaa1..657e2844 100644 --- a/docs/tutorials/install.md +++ b/docs/tutorial/install.md @@ -213,8 +213,8 @@ picodata run --listen 0.0.0.0:3301 --advertise 192.168.0.1:3301 Значение параметра `--advertise` анонÑируетÑÑ ÐºÐ»Ð°Ñтеру при запуÑке инÑтанÑа. Его можно поменÑть при перезапуÑке инÑтанÑа или в процеÑÑе его работы командой `picodata set-advertise`. --> Подробнее о запуÑке Picodata и работе Ñ ÐºÐ»Ð°Ñтером Ñм. в разделе -[ЗапуÑк клаÑтера](../deploy_on_hosts). Параметры запуÑка из командной -Ñтроки опиÑаны в разделе [Ðргументы командной Ñтроки Picodata](../../references/cli). +[ЗапуÑк клаÑтера](../deploy). Параметры запуÑка из командной +Ñтроки опиÑаны в разделе [Ðргументы командной Ñтроки Picodata](../../reference/cli). --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorials/install.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorial/install.md) diff --git a/docs/tutorials/auth_ldap.md b/docs/tutorial/ldap.md similarity index 98% rename from docs/tutorials/auth_ldap.md rename to docs/tutorial/ldap.md index b23913c7..3f5804f0 100644 --- a/docs/tutorials/auth_ldap.md +++ b/docs/tutorial/ldap.md @@ -70,7 +70,7 @@ pico.change_password('username', '', {auth_type = 'ldap'}) полученный пароль при взаимодейÑтвии Ñ Ñервером LDAP. Подробнее о работе Ñ Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñми и привилегиÑми и Ñм. разделе -[Публичный API Picodata](../references/api.md). +[Публичный API Picodata](../reference/api.md). ### ÐаÑтройка клаÑтера Picodata {: #cluster-setup } @@ -108,4 +108,4 @@ pico.change_password('username', 'new_password', { auth_type = 'chap-sha1' }) ``` --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorials/auth_ldap.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorial/ldap.md) diff --git a/docs/tutorials/monitoring.md b/docs/tutorial/monitoring.md similarity index 95% rename from docs/tutorials/monitoring.md rename to docs/tutorial/monitoring.md index 6663427b..b9c4c6f3 100644 --- a/docs/tutorials/monitoring.md +++ b/docs/tutorial/monitoring.md @@ -64,7 +64,7 @@ box.space._pico_replicaset:fselect() ... ``` -Таблицы выше позволÑÑŽÑ‚ узнать текущий и целевой уровень ([grade](../general/glossary.md#грейд-grade)) +Таблицы выше позволÑÑŽÑ‚ узнать текущий и целевой уровень ([grade](../overview/glossary.md#грейд-grade)) каждого инÑтанÑа, а также Ð²ÐµÑ (`weight`) репликаÑета. Уровни отражают конфигурацию оÑтальных инÑтанÑов отноÑительно текущего, а Ð²ÐµÑ Ñ€ÐµÐ¿Ð»Ð¸ÐºÐ°Ñета — его наполненноÑть репликами ÑоглаÑно фактору репликации @@ -84,7 +84,7 @@ box.space._pico_property:get("current_schema_version") увеличению Ñтого номера. Подробнее о работе Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ в Picodata Ñм. в разделе -[Работа Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ SQL](../tutorial_data). +[Работа Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ SQL](../sql_examples). --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorials/monitoring.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorial/monitoring.md) diff --git a/docs/tutorials/tutorial_data.md b/docs/tutorial/sql_examples.md similarity index 83% rename from docs/tutorials/tutorial_data.md rename to docs/tutorial/sql_examples.md index ff3f9c56..03bf9037 100644 --- a/docs/tutorials/tutorial_data.md +++ b/docs/tutorial/sql_examples.md @@ -1,19 +1,19 @@ # Работа Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ SQL Ð’ данном разделе приведены примеры команд Ð´Ð»Ñ Ñ€Ð°Ð±Ð¾Ñ‚Ñ‹ Ñ Ð´Ð°Ð½Ð½Ñ‹Ð¼Ð¸ в -Picodata Ñ Ð¿Ð¾Ð¼Ð¾Ñ‰ÑŒÑŽ Ñзыка [SQL-запроÑов](../references/queries.md). +Picodata Ñ Ð¿Ð¾Ð¼Ð¾Ñ‰ÑŒÑŽ Ñзыка [SQL-запроÑов](../reference/sql_queries.md). ## Создание таблицы {: #creating-table } Ð”Ð»Ñ ÑÐ¾Ð·Ð´Ð°Ð½Ð¸Ñ Ñ‚Ð°Ð±Ð»Ð¸Ñ†Ñ‹ в Picodata Ñледует Ñначала -[подключитьÑÑ](tutorial_first_steps.md#accessing-console) к +[подключитьÑÑ](connecting.md#accessing-console) к интерактивной конÑоли инÑтанÑа. Ð”Ð»Ñ Ð²Ð²Ð¾Ð´Ð° команд можно иÑпользовать как формат Lua, так и Ñзык SQL напрÑмую, в завиÑимоÑти от -[выбранного](../references/queries.md#available_langs) Ñзыка конÑоли. Ð’ примерах +[выбранного](../reference/sql_queries.md#available_langs) Ñзыка конÑоли. Ð’ примерах ниже иÑпользован формат Lua. ПользователÑм доÑтупны функции Ð´Ð»Ñ Ñ€Ð°Ð±Ð¾Ñ‚Ñ‹ как Ñ Ð³Ð»Ð¾Ð±Ð°Ð»ÑŒÐ½Ñ‹Ð¼Ð¸, так и шардированными таблицами (в поÑледнем Ñлучае реализованы возможноÑти -[раÑпределенного SQL](../architecture/broadcasted_sql.md)). +[раÑпределенного SQL](../architecture/distributed_sql.md)). Ð”Ð»Ñ Ð¿Ñ€Ð¸Ð¼ÐµÑ€Ð° Ñоздадим шаблон ÑпиÑка друзей Свинки Пеппы, котором будет два полÑ: идентификатор запиÑи и Ð¸Ð¼Ñ Ð´Ñ€ÑƒÐ³Ð°: @@ -32,7 +32,7 @@ pico.sql([[ Помимо двух колонок, в примере указаны: - первичный ключ таблицы (колонка `"id"`); -- [движок Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ…](../general/glossary.md#db-engine) in-memory (`memtx`); +- [движок Ñ…Ñ€Ð°Ð½ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ…](../overview/glossary.md#db-engine) in-memory (`memtx`); - тип таблицы (шардированный, `distributed by`); - ключ ÑˆÐ°Ñ€Ð´Ð¸Ñ€Ð¾Ð²Ð°Ð½Ð¸Ñ Ñ‚Ð°Ð±Ð»Ð¸Ñ†Ñ‹ (колонка `"id"`); - таймаут перед возвращением ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»ÑŽ. @@ -51,8 +51,8 @@ pico.sql([[ ]]) ``` -Подробнее о типах таблиц Ñм. в [глоÑÑарии](../general/glossary.md#table). -ОпиÑание команд SQL приведено в разделе [Команды SQL](../references/queries.md). +Подробнее о типах таблиц Ñм. в [глоÑÑарии](../overview/glossary.md#table). +ОпиÑание команд SQL приведено в разделе [Команды SQL](../reference/sql_queries.md). ## ЗапиÑÑŒ данных в таблицу {: #writing-to-table } ЗапиÑÑŒ данных, Ñ‚.е. вÑтавка Ñтрок, в таблицу проиÑходит Ñ Ð¿Ð¾Ð¼Ð¾Ñ‰ÑŒÑŽ @@ -74,7 +74,7 @@ pico.sql( [[insert into "friends_of_peppa" ("id", "name") values (1, "Suzy")]],{} ) ``` -См. [подробнее](../references/queries.md#insert) о различиÑÑ… в `INSERT`-запроÑах. +См. [подробнее](../reference/sql_queries.md#insert) о различиÑÑ… в `INSERT`-запроÑах. ## Чтение данных из таблицы {: #reading-from-table } Ð”Ð»Ñ Ñ‡Ñ‚ÐµÐ½Ð¸Ñ Ð²Ñех данных из таблицы подойдёт команда: @@ -89,7 +89,7 @@ pico.sql([[select * from "friends_of_peppa"]], {}) pico.sql([[select * from "friends_of_peppa" where "id" = 1]], {}) ``` -См. [подробнее](../references/queries.md#select) о вариантах Ñ‡Ñ‚ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ… в SQL. +См. [подробнее](../reference/sql_queries.md#select) о вариантах Ñ‡Ñ‚ÐµÐ½Ð¸Ñ Ð´Ð°Ð½Ð½Ñ‹Ñ… в SQL. ## Удаление данных {: #deleting-from-table } @@ -105,7 +105,7 @@ picodata> pico.sql([[delete from "friends_of_peppa" where "id" = 1]], {}) Подробнее о внутренней архитектуре клаÑтера Picodata Ñм. в разделе [Жизненный цикл клаÑтера](../architecture/clustering.md). -Параметры запуÑка из командной Ñтроки опиÑаны в разделе [Ðргументы командной Ñтроки Picodata](../references/cli.md). +Параметры запуÑка из командной Ñтроки опиÑаны в разделе [Ðргументы командной Ñтроки Picodata](../reference/cli.md). --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorials/tutorial_data.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorial/sql_examples.md) diff --git a/docs/tutorials/tutorial_users.md b/docs/tutorial/tutorial_users.md similarity index 88% rename from docs/tutorials/tutorial_users.md rename to docs/tutorial/tutorial_users.md index 48909313..53948a89 100644 --- a/docs/tutorials/tutorial_users.md +++ b/docs/tutorial/tutorial_users.md @@ -1,12 +1,12 @@ -# Пользователи, привилегии и роли -Ð’ данном разделе опиÑаны [SQL-команды](../references/queries.md) Ð´Ð»Ñ ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ +# Управление доÑтупом +Ð’ данном разделе опиÑаны [SQL-команды](../reference/sql_queries.md) Ð´Ð»Ñ ÑƒÐ¿Ñ€Ð°Ð²Ð»ÐµÐ½Ð¸Ñ Ð´Ð¾Ñтупом Ñ Ð¿Ð¾Ð¼Ð¾Ñ‰ÑŒÑŽ ролевой модели в Picodata. ## Ð Ð¾Ð»ÐµÐ²Ð°Ñ Ð¼Ð¾Ð´ÐµÐ»ÑŒ {: #role-model } Ð Ð¾Ð»ÐµÐ²Ð°Ñ Ð¼Ð¾Ð´ÐµÐ»ÑŒ Picodata позволÑет гибко разграничивать возможноÑти пользователей раÑпределенной ÑиÑтемы. Разграничение ÑтроитÑÑ Ð½Ð° базе -трех оÑновных понÑтий: [пользователей](../general/glossary.md#user), -[привилегий](../general/glossary.md#privilege) и [ролей](../general/glossary.md#role). +трех оÑновных понÑтий: [пользователей](../overview/glossary.md#user), +[привилегий](../overview/glossary.md#privilege) и [ролей](../overview/glossary.md#role). Привилегии можно назначать напрÑмую пользователÑм:  @@ -22,16 +22,16 @@ ## Ðачало работы {: #getting-started } Ð”Ð»Ñ Ð½Ð°Ñ‡Ð°Ð»Ð° работы Ñ Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñми, привилегиÑми и ролÑми иÑледует -[подключитьÑÑ](tutorial_first_steps.md#accessing-console) к +[подключитьÑÑ](connecting.md#accessing-console) к интерактивной конÑоли инÑтанÑа Picodata. Ð”Ð»Ñ Ð²Ð²Ð¾Ð´Ð° команд можно иÑпользовать как формат Lua, так и Ñзык SQL напрÑмую, в завиÑимоÑти от -[выбранного](../references/queries.md#available_langs) Ñзыка конÑоли. Ð’ примерах +[выбранного](../reference/sql_queries.md#available_langs) Ñзыка конÑоли. Ð’ примерах ниже иÑпользован Ñзык SQL. ## Создание Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ {: #creating-user } Создание нового Ð¿Ð¾Ð»ÑŒÐ·Ð¾Ð²Ð°Ñ‚ÐµÐ»Ñ Ð¿Ñ€Ð¾Ð¸Ñходит Ñ Ð¿Ð¾Ð¼Ð¾Ñ‰ÑŒÑŽ SQL-команды `create user`, функциональноÑть которой аналогична Lua-функции -[`pico.create_user()`](../references/api.md#picocreate_user). +[`pico.create_user()`](../reference/api.md#picocreate_user). Приведем пример ÑÐ¾Ð·Ð´Ð°Ð½Ð¸Ñ Ð½Ð¾Ð²Ð¾Ð³Ð¾ пользователÑ: @@ -66,7 +66,7 @@ pico.sql([[ Создание новой роли проиÑходит Ñ Ð¿Ð¾Ð¼Ð¾Ñ‰ÑŒÑŽ SQL-команды `create role`, функциональноÑть которой аналогична Lua-функции -[`pico.create_role()`](../references/api.md#picocreate_role). +[`pico.create_role()`](../reference/api.md#picocreate_role). Приведем пример ÑÐ¾Ð·Ð´Ð°Ð½Ð¸Ñ Ð½Ð¾Ð²Ð¾Ð¹ роли: @@ -150,7 +150,7 @@ pico.sql([[ ``` --> -См. также [`pico.grant_privilege`](../references/api.md#picogrant_privilege) и [`pico.revoke_privilege`](../references/api.md#picorevoke_privilege) +См. также [`pico.grant_privilege`](../reference/api.md#picogrant_privilege) и [`pico.revoke_privilege`](../reference/api.md#picorevoke_privilege) --- -[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorials/tutorial_users.md) +[ИÑходный код Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorial/tutorial_users.md) diff --git a/docs/tutorials/tutorial_webui.md b/docs/tutorial/webui.md similarity index 88% rename from docs/tutorials/tutorial_webui.md rename to docs/tutorial/webui.md index 22ac2ccd..30899faf 100644 --- a/docs/tutorials/tutorial_webui.md +++ b/docs/tutorial/webui.md @@ -16,13 +16,13 @@ Picodata](install.md). ## Подключение функции веб-интерфейÑа Веб-Ð¸Ð½Ñ‚ÐµÑ€Ñ„ÐµÐ¹Ñ Ð¿Ñ€ÐµÐ´ÑтавлÑет Ñобой веб-Ñервер, запуÑкаемый вмеÑте Ñ -[инÑтанÑом](../general/glossary.md#instance) Picodata. Ðе имеет значениÑ, на каком +[инÑтанÑом](../overview/glossary.md#instance) Picodata. Ðе имеет значениÑ, на каком именно инÑтанÑе клаÑтера запущен Ñтот веб-Ñервер; в любом Ñлучае, веб-Ñервер будет отображать данные обо вÑем клаÑтере. Ð”Ð»Ñ Ð·Ð°Ð¿ÑƒÑка инÑтанÑа Ñ Ð²ÐµÐ±-Ñервером Ñледует иÑпользовать дополнительный параметр `--http-listen` Ñ ÑƒÐºÐ°Ð·Ð°Ð½Ð¸ÐµÐ¼ [хоÑта и -порта](../references/cli.md#http-listen)). Пример команды: +порта](../reference/cli.md#http-listen)). Пример команды: ```bash picodata run --http-listen localhost:8080 @@ -46,7 +46,7 @@ Picodata: позволÑющее вывеÑти ÑпиÑок вÑех инÑтанÑов (узлов) клаÑтера;<br> <span style="color:red;font-size:150%">â·</span> — панель оÑновной информации о клаÑтере: показателÑÑ… памÑти, количеÑтве -[репликаÑетов](../general/glossary.md#replicaset), [инÑтанÑов](../general/glossary.md#instance) и их [грейдов](../general/glossary.md#grade), верÑии +[репликаÑетов](../overview/glossary.md#replicaset), [инÑтанÑов](../overview/glossary.md#instance) и их [грейдов](../overview/glossary.md#grade), верÑии Picodata;<br> <span style="color:red;font-size:150%">â¸</span> — кнопка выбора группировки предÑÑ‚Ð°Ð²Ð»ÐµÐ½Ð¸Ñ (по инÑтанÑам или репликаÑетам);<br> @@ -68,7 +68,7 @@ style="color:red;font-size:150%">â¸</span>), то можно Ñразу уви инÑтанÑов по имени (нажатие переключает Ñортировку по возраÑтанию/убыванию);<br> <span style="color:blue;font-size:150%">â·</span> — кнопку фильтрации по -[домену отказа](../general/glossary.md#failure_domain) (позволÑет оÑтавить в ÑпиÑке +[домену отказа](../overview/glossary.md#failure_domain) (позволÑет оÑтавить в ÑпиÑке только те инÑтанÑÑ‹, которые удовлетворÑÑŽÑ‚ заданному уÑловию);<br> <span style="color:blue;font-size:150%">â¸</span> — текущий и целевой грейды инÑтанÑа);<br> @@ -76,8 +76,8 @@ style="color:red;font-size:150%">â¸</span>), то можно Ñразу уви отказа инÑтанÑа;<br> ПодробноÑти о запуÑке клаÑтера Picodata приведены в разделе [ЗапуÑк -клаÑтера](deploy_on_hosts.md). +клаÑтера](deploy.md). --- [ИÑходный код -Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorials/tutorial_webui.md) +Ñтраницы](https://git.picodata.io/picodata/picodata/docs/-/blob/main/docs/tutorial/webui.md) diff --git a/mkdocs.yml b/mkdocs.yml index 3dcf343e..c875238f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,27 +5,27 @@ repo_url: https://git.picodata.io/picodata/picodata/docs nav: - Ознакомление Ñ ÐŸÐž Picodata: - - general/description.md - - general/benefits.md - - general/glossary.md - - general/feedback.md + - overview/description.md + - overview/benefits.md + - overview/glossary.md + - overview/feedback.md - ИнÑтрукции и руководÑтва: - - tutorials/install.md - - tutorials/deploy_on_hosts.md - - tutorials/monitoring.md - - tutorials/tutorial_first_steps.md - - tutorials/tutorial_webui.md - - tutorials/auth_ldap.md - - tutorials/tutorial_users.md - - tutorials/tutorial_data.md + - tutorial/install.md + - tutorial/deploy.md + - tutorial/monitoring.md + - tutorial/connecting.md + - tutorial/webui.md + - tutorial/ldap.md + - tutorial/tutorial_users.md + - tutorial/sql_examples.md - Справочные материалы: - - references/cli.md - - references/datatypes.md - - references/queries.md - - references/api.md - - references/reference.md + - reference/cli.md + - reference/sql_types.md + - reference/sql_queries.md + - reference/api.md + - reference/ansi_sql.md - Ðрхитектура: - - architecture/broadcasted_sql.md + - architecture/distributed_sql.md - architecture/discovery.md - architecture/raft_failover.md - architecture/clustering.md -- GitLab