Доработка документации PG

2025-11-29 22:27:42 +02:00 · 2025-02-16 12:52:26 +03:00
parent fbe12f42bc
commit bb99a80c6a
17 changed files with 52 additions and 342 deletions
--- a/docs/en/data/MongoDB/GetListOfBases.json
+++ b/docs/en/data/MongoDB/GetListOfBases.json
@@ -1,3 +0,0 @@
-{
-"ConnectionString": "mongodb://bayselonarrend:12We3456@93.125.42.204:27017"
-}
--- a/docs/en/examples/MongoDB/GetListOfBases.txt
+++ b/docs/en/examples/MongoDB/GetListOfBases.txt
@@ -1,3 +0,0 @@
-    ConnectionString = "mongodb://bayselonarrend:***@127.0.0.1:27017";
-
-    Result = OPI_MongoDB.GetListOfBases(ConnectionString);
--- a/docs/en/md/Instructions/PostgreSQL.md
+++ b/docs/en/md/Instructions/PostgreSQL.md
@@ -7,18 +7,56 @@ sidebar_class_name: PostgreSQL

 # PostgreSQL

-Этот раздел посвящен библиотеке для работы с базами данных PostgreSQL. На данной странице описаны все действия, необходимые для полноценного начала работы
+This section is dedicated to the PostgreSQL database library. On this page, all the steps necessary to start working are described

-## О реализованных методах
+## About implemented methods

-Данная библиотека состоит из двух частей: основных методов, вроде подключения и выполнения SQL-запросов, и небольшой ORM для часто встречающихся операций, вроде CREATE, SELECT, INSERT, DELETE и пр. Работа через ORM и через тексты запросов, выполняемые через функцию `ВыполнитьЗапросSQL()`, технически не отличается: ORM просто формирует текст SQL-запроса на основе макетов, но далее также вызывает их через эту функцию
+This library has two parts: basic methods, like connecting and executing SQL queries, and a small ORM for common operations like CREATE, SELECT, INSERT, DELETE, and so on. Working through the ORM and through the query texts executed through the `ExecuteSQLQuery()` function is technically the same: the ORM simply generates the SQL query text based on the layouts, but then also calls them through this function

-По умолчанию, все запросы SELECT возвращают массив выбранных данных, а остальные запросы - только `true` в поле `result` при успехе, либо `false` и текст ошибки в полях `result` и `error` соответственно. Для выполнения запросов, требующих возврата данных, но не являющихся запросами SELECT, в функции `ВыполнитьЗапросSQL()` есть параметр `ФорсироватьРезультат`
+By default, all SELECT queries return an array of selected data, while other queries return only `true` in the `result` field on success, or `false` and error text in the `result` and `error` fields, respectively. To execute queries that require data to be returned but are not SELECT queries, the `ExecuteSQLQuery()` function has a `ForceResult` parameter

-## Поля типа "BYTEA"
+## Query parameters

-Данная библиотека умеет обрабатывать поля типа BYTEA (Двоичные данные)
+The PostgreSQL connector supports the use of positional parameters. All values passed both when executing queries directly through the `ExecuteRequestSQL()` function and in ORM methods with value setting, such as `AddRecords` and `UpdateRecords`, must be a structure of the form `{'Data Type': 'Value'}`. The following data types are supported:

-## Совместимость
+:::TIP
+🟢 - Implemented, tested; 🟡 - Implemented, not tested
+:::

-Технически, реализация коннектора представляет из себя Native компоненту на Rust. Она поставляется в формате zip-архива, и, теоретически, должна работать на всех доступных платформах: x86 и x64 Windows и Linux. Фактическое тестирование проводилось на Windows x64 и, косвенно (через OneScript), на Linux x64
+  | Type | Support | Synonym | Native types|
+  |-|-|-|-|
+  | BOOL | 🟢 | - | Bool |
+  | "char" | 🟢 | OLDCHAR | Number |
+  | SMALLINT | 🟢 | - | Number |
+  | SMALLSERIAL | 🟢 | - | Number |
+  | INT | 🟢 | - | Number |
+  | SERIAL | 🟢 | - | Number |
+  | BIGINT | 🟢 | - | Number |
+  | BIGSERIAL | 🟢 | - | Number |
+  | OID | 🟢 | - | Number |
+  | REAL | 🟢 | - | Number |
+  | DOUBLE PRECISION | 🟢 | DOUBLE_PRECISION | Number |
+  | VARCHAR | 🟢 | - | String |
+  | TEXT | 🟢 | - | String |
+  | CHAR | 🟢 | - | String |
+  | CITEXT | 🟢 | - | String |
+  | NAME | 🟢 | - | String |
+  | INET | 🟢 | - | String |
+  | UUID | 🟢 | - | String, УникальныйИдентификатор |
+  | TIMESTAMP | 🟢 | - | Date, String (ISO 8601, RFC 3339) |
+  | TIMESTAMP WITH TIME ZONE | 🟢 | TIMESTAMP_WITH_TIME_ZONE | Date (the time zone will be specified as UTC), String (RFC 3339) |
+  | DATE | 🟢 | - | Date (any time part), String (ISO 8601, RFC 3339) |
+  | TIME | 🟢 | - | Date (any date part), String (ISO 8601, RFC 3339) |
+  | BYTEA | 🟢 | - | BinaryData, File path, Base64 String (all converted to a Base64 string) |
+  | JSON | 🟢 | - | Array, Structure, Map |
+  | JSONB | 🟢 | - | Array, Structure, Map |
+  | LTREE | 🟡 | - | String |
+  | LQUERY | 🟡 | - | String |
+  | LTXTQUERY | 🟡 | - | String |
+  | HSTORE | 🟡 | - | Structure, Map |
+
+A similar list of types is also available to retrieve as query results from PostgreSQL
+
+## Compatibility
+
+Technically, the client implementation is a Native component in Rust. It comes in a zip archive format, and, in theory, should work on all available platforms: x86 and x64 Windows and Linux. The actual testing was done on Windows x64 and, cossentially (via OneScript), on Linux x64
--- a/docs/en/md/MongoDB/Database-management/Get-list-of-bases.mdx
+++ b/docs/en/md/MongoDB/Database-management/Get-list-of-bases.mdx
@@ -1,40 +0,0 @@
---
-sidebar_position: 1
---
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-# Get list of bases
- Gets a list of bases
-
-
-
-`Function GetListOfBases(Val ConnectionString) Export`
-
-  | Parameter | CLI option | Type | Required | Description |
-  |-|-|-|-|-|
-  | ConnectionString | --connect | String | &#x2714; | Connection string to MongoDB server |
-
-  
-  Returns:  Structure Of KeyAndValue - serialized JSON response from MongoDB server
-
-<br/>
-
-:::tip
-Method in MongoDB documentation: [listDatabases](https://mongodb.com/docs/manual/reference/command/listDatabases/)
-:::
-<br/>
-
-
-
-```bsl title="1C:Enterprise/OneScript code example"
-    ConnectionString = "mongodb://bayselonarrend:***@127.0.0.1:27017";
-
-    Result = OPI_MongoDB.GetListOfBases(ConnectionString);
-```
- 
-
-
-
-
--- a/docs/en/md/MongoDB/Database-management/_category_.json
+++ b/docs/en/md/MongoDB/Database-management/_category_.json
@@ -1,4 +0,0 @@
-{
-"label": "Database management",
-"position": "2"
-}
--- a/docs/ru/data/MongoDB/ПолучитьСписокБаз.json
+++ b/docs/ru/data/MongoDB/ПолучитьСписокБаз.json
@@ -1,3 +0,0 @@
-{
-"СтрокаПодключения": "mongodb://bayselonarrend:12We3456@93.125.42.204:27017"
-}
--- a/docs/ru/examples/MongoDB/ПолучитьСписокБаз.txt
+++ b/docs/ru/examples/MongoDB/ПолучитьСписокБаз.txt
@@ -1,3 +0,0 @@
-    СтрокаПодключения = "mongodb://bayselonarrend:***@127.0.0.1:27017";
-
-    Результат = OPI_MongoDB.ПолучитьСписокБаз(СтрокаПодключения);
--- a/docs/ru/md/Instructions/PostgreSQL.md
+++ b/docs/ru/md/Instructions/PostgreSQL.md
@@ -11,7 +11,7 @@ sidebar_class_name: PostgreSQL

 ## О реализованных методах

-Данная библиотека состоит из двух частей: основных методов, вроде подключения и выполнения SQL-запросов, и небольшой ORM для часто встречающихся операций, вроде CREATE, SELECT, INSERT, DELETE и пр. Работа через ORM и через тексты запросов, выполняемые через функцию `ВыполнитьЗапросSQL()`, технически не отличается: ORM просто формирует текст SQL-запроса на основе макетов, но далее также вызывает их через эту функцию
+Данная библиотека состоит из двух частей: основных методов, вроде подключения и выполнения SQL-запросов, и небольшой ORM для часто встречающихся операций, вроде CREATE, SELECT, INSERT, DELETE и пр. Работа через ORM и через тексты запросов, выполняемые функцией `ВыполнитьЗапросSQL()`, технически не отличается: ORM просто формирует текст SQL-запроса на основе макетов, но далее также выполняет их этой функцией

 По умолчанию, все запросы SELECT возвращают массив выбранных данных, а остальные запросы - только `true` в поле `result` при успехе, либо `false` и текст ошибки в полях `result` и `error` соответственно. Для выполнения запросов, требующих возврата данных, но не являющихся запросами SELECT, в функции `ВыполнитьЗапросSQL()` есть параметр `ФорсироватьРезультат`

@@ -23,7 +23,7 @@ sidebar_class_name: PostgreSQL
 🟢 - Реализовано, проверено; 🟡 - Реализовано, не проверено
 :::

-  | Тип | Поддержка | Синонимы | Допустимые типы 1С |
+  | Тип | Поддержка | Синонимы | Допустимые нативные типы |
  |-|-|-|-|
  | BOOL | 🟢 | - | Булево |
  | "char" | 🟢 | OLDCHAR | Число |
@@ -55,8 +55,8 @@ sidebar_class_name: PostgreSQL
  | LTXTQUERY | 🟡 | - | Строка |
  | HSTORE | 🟡 | - | Структура, Соответствие |

-
+Аналогичный список типов доступен и для получения в качестве результатов запросов из PostgreSQL

 ## Совместимость

-Технически, реализация коннектора представляет из себя Native компоненту на Rust. Она поставляется в формате zip-архива, и, теоретически, должна работать на всех доступных платформах: x86 и x64 Windows и Linux. Фактическое тестирование проводилось на Windows x64 и, косвенно (через OneScript), на Linux x64
+Технически, реализация коннектора представляет из себя Native компоненту на Rust. Она поставляется в формате zip-архива со сборками для всех основных платформ: x86 и x64 Windows и Linux. Фактическое тестирование проводилось на Windows x64 и, косвенно (через OneScript), на Linux x64
--- a/docs/ru/md/Instructions/SQLite.md
+++ b/docs/ru/md/Instructions/SQLite.md
@@ -11,7 +11,7 @@ sidebar_class_name: SQLite

 ## О реализованных методах

-Данная библиотека состоит из двух частей: основных методов, вроде подключения и выполнения SQL-запросов, и небольшой ORM для часто встречающихся операций, вроде CREATE, SELECT, INSERT, DELETE и пр. Работа через ORM и через тексты запросов, выполняемые через функцию `ВыполнитьЗапросSQL()`, технически не отличается: ORM просто формирует текст SQL-запроса на основе макетов, но далее также вызывает их через эту функцию
+Данная библиотека состоит из двух частей: основных методов, вроде подключения и выполнения SQL-запросов, и небольшой ORM для часто встречающихся операций, вроде CREATE, SELECT, INSERT, DELETE и пр. Работа через ORM и через тексты запросов, выполняемые функцией `ВыполнитьЗапросSQL()`, технически не отличается: ORM просто формирует текст SQL-запроса на основе макетов, но далее также выполняет их этой функцией

 По умолчанию, все запросы SELECT возвращают массив выбранных данных, а остальные запросы - только `true` в поле `result` при успехе, либо `false` и текст ошибки в полях `result` и `error` соответственно. Для выполнения запросов, требующих возврата данных, но не являющихся запросами SELECT, в функции `ВыполнитьЗапросSQL()` есть параметр `ФорсироватьРезультат`

@@ -21,4 +21,4 @@ sidebar_class_name: SQLite

 ## Совместимость

-Технически, реализация коннектора представляет из себя Native компоненту на Rust. Она поставляется в формате zip-архива, и, теоретически, должна работать на всех доступных платформах: x86 и x64 Windows и Linux. Фактическое тестирование проводилось на Windows x64 и, косвенно (через OneScript), на Linux x64
+Технически, реализация коннектора представляет из себя Native компоненту на Rust. Она поставляется в формате zip-архива со сборками для всех основных платформ: x86 и x64 Windows и Linux. Фактическое тестирование проводилось на Windows x64 и, косвенно (через OneScript), на Linux x64
--- a/docs/ru/md/MongoDB/Database-management/Get-list-of-bases.mdx
+++ b/docs/ru/md/MongoDB/Database-management/Get-list-of-bases.mdx
@@ -1,40 +0,0 @@
---
-sidebar_position: 1
---
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-# Получить список баз
- Получает список баз
-
-
-
-`Функция ПолучитьСписокБаз(Знач СтрокаПодключения) Экспорт`
-
-  | Параметр | CLI опция | Тип | Обяз. | Назначение |
-  |-|-|-|-|-|
-  | СтрокаПодключения | --connect | Строка | &#x2714; | Строка подключения к серверу MongoDB |
-
-  
-  Возвращаемое значение:   Структура Из КлючИЗначение - сериализованный JSON ответа от сервера MongoDB
-
-<br/>
-
-:::tip
-Метод в документации MongoDB: [listDatabases](https://mongodb.com/docs/manual/reference/command/listDatabases/)
-:::
-<br/>
-
-
-
-```bsl title="Пример использования для 1С:Предприятие/OneScript"
-    СтрокаПодключения = "mongodb://bayselonarrend:***@127.0.0.1:27017";
-
-    Результат = OPI_MongoDB.ПолучитьСписокБаз(СтрокаПодключения);
-```
-    
-
-
-
-
--- a/docs/ru/md/MongoDB/Database-management/_category_.json
+++ b/docs/ru/md/MongoDB/Database-management/_category_.json
@@ -1,4 +0,0 @@
-{
-"label": "Управление базами данных",
-"position": "2"
-}