diff --git a/docs/en/md/Instructions/SQLite.md b/docs/en/md/Instructions/SQLite.md index 1a127d57aa..e94fb3956b 100644 --- a/docs/en/md/Instructions/SQLite.md +++ b/docs/en/md/Instructions/SQLite.md @@ -7,4 +7,18 @@ sidebar_class_name: SQLite # SQLite -This section is dedicated to the SQLite database library. На данной странице описаны все действия, необходимые для полноценного начала работы \ No newline at end of file +This section is dedicated to the SQLite database library. On this page, all the steps necessary to start working are described + +## About implemented methods + +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 + +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 + +## "BLOB" type fields + +This library can process fields of type BLOB (Binary Data). To place a value in a field of this type during INSERT or UPDATE, it can be passed either as a variable of type `BinaryData` (in 1C and OneScript) or as a structure of type `{"blob":File Path}` (in 1C, OneScript and CLI versions). Binary data is always returned as `{"blob":Base64 string}`. + +## 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 \ No newline at end of file diff --git a/docs/ru/md/Instructions/SQLite.md b/docs/ru/md/Instructions/SQLite.md index 9e49a5efc7..9342a4d9b7 100644 --- a/docs/ru/md/Instructions/SQLite.md +++ b/docs/ru/md/Instructions/SQLite.md @@ -7,4 +7,18 @@ sidebar_class_name: SQLite # SQLite -Этот раздел посвящен библиотеке для работы с базами данных SQLite. На данной странице описаны все действия, необходимые для полноценного начала работы \ No newline at end of file +Этот раздел посвящен библиотеке для работы с базами данных SQLite. На данной странице описаны все действия, необходимые для полноценного начала работы + +## О реализованных методах + +Данная библиотека состоит из двух частей: основных методов, вроде подключения и выполнения SQL-запросов, и небольшой ORM для часто встречающихся операций, вроде CREATE, SELECT, INSERT, DELETE и пр. Работа через ORM и через тексты запросов, выполняемые через функцию `ВыполнитьЗапросSQL()`, технически не отличается: ORM просто формирует текст SQL-запроса на основе макетов, но далее также вызывает их через эту функцию + +По умолчанию, все запросы SELECT возвращают массив выбранных данных, а остальные запросы - только `true` в поле `result` при успехе, либо `false` и текст ошибки в полях `result` и `error` соответственно. Для выполнения запросов, требующих возврата данных, но не являющихся запросами SELECT, в функции `ВыполнитьЗапросSQL()` есть параметр `ФорсироватьРезультат` + +## Поля типа "BLOB" + +Данная библиотека умеет обрабатывать поля типа BLOB (Двоичные данные). Для помещения значения в поле такого типа при INSERT или UPDATE оно может быть передано либо как переменная с типом `ДвоичныеДанные` (в 1С и OneScript), либо как структура вида `{"blob":Путь к файлу}` (в 1С, OneScript и CLI версиях). Возвращаются двоичные данные всегда в виде `{"blob":Base64 строка}` + +## Совместимость + +Технически, реализация коннектора представляет из себя Native компоненту на Rust. Она поставляется в формате zip-архива, и, теоретически, должна работать на всех доступных платформах: x86 и x64 Windows и Linux. Фактическое тестирование проводилось на Windows x64 и, косвенно (через OneScript), на Linux x64 \ No newline at end of file diff --git a/docs/ru/md/Instructions/TCP.md b/docs/ru/md/Instructions/TCP.md index 654c8525b3..b50633297a 100644 --- a/docs/ru/md/Instructions/TCP.md +++ b/docs/ru/md/Instructions/TCP.md @@ -22,4 +22,4 @@ sidebar_class_name: TCP ## Совместимость -Технически, реализация клиента представляет из себя Native компоненту на Rust. Она поставляется в формате zip-архива, и, теоретически, должна работать на всех доступных платформах: x86 и x64 Windows и Linux. Фактическое тестирование проводилось на Windows x64 и, коссвенно (через OneScript), на Linux x64 \ No newline at end of file +Технически, реализация клиента представляет из себя Native компоненту на Rust. Она поставляется в формате zip-архива, и, теоретически, должна работать на всех доступных платформах: x86 и x64 Windows и Linux. Фактическое тестирование проводилось на Windows x64 и, косвенно (через OneScript), на Linux x64 \ No newline at end of file