1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-23 22:05:15 +02:00

Правка доков

This commit is contained in:
Anton Titovets
2025-04-06 22:15:16 +03:00
parent bda35739c9
commit a1b0f62bfc
4 changed files with 49 additions and 6 deletions

View File

@@ -26,6 +26,28 @@ Learn more: <a href="/docs/Start/Component-requirements#openssl" class="orangeli
## About implemented methods ## 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
## Query parameters
The MySQL 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\*:
> \* The MySQL type list lists only a few suitable types
| Type name (key) | 1C type | Suitable MySQL types |
|-|-|-|
| BYTES | String (filepath), BinaryData ||
| UINT | Number (integer, unsigned) | TINYINT UNSIGNED, SMALLINT UNSIGNED, MEDIUMINT UNSIGNED, INT UNSIGNED, BIGINT UNSIGNED |
| INT | Number (integer) | TINYINT, SMALLINT, MEDIUMINT, INT, BIGINT |
| FLOAT | Number | FLOAT |
| DOUBLE | Number | DOUBLE (REAL, DOUBLE PRECISION) |
| DATE | Date, String (RFC 3339) | DATE, DATETIME, TIMESTAMP |
| TIME | Дата, String (RFC 3339) | TIME |
| TEXT | String | CHAR, VARCHAR, TINYTEXT, TEXT, MEDIUMTEXT, LONGTEXT |
## TLS ## TLS

View File

@@ -8,10 +8,10 @@ Some tools in the OPI toolkit utilize **external components (AddIns)** — dynam
## Compatibility ## Compatibility
All external components added to OPI are compiled for x64 and x32 versions of Windows and Linux. They are stored in special ZIP archives containing four library files—one for each platform. However, while there are no issues with their usage on Windows, on Linux these components depend on three things being present in the system: `glibc`, `gcc` и `OpenSSL`⃰⃰ All external components added to OPI are compiled for x64 and x32 versions of Windows and Linux. They are stored in special ZIP archives containing four library files—one for each platform. However, while there are no issues with their usage on Windows, on Linux these components depend on three things being present in the system: `glibc`, `gcc`\* и `OpenSSL`\*\*
> Relevant for CLI and OneScript versions > \* Relevant for CLI and OneScript versions
> ⃰⃰ Relevant for libraries that use TLS functionality > \*\* Relevant for libraries that use TLS functionality
### glibc ### glibc

View File

@@ -26,6 +26,27 @@ sidebar_class_name: MySQL
## О реализованных методах ## О реализованных методах
Данная библиотека состоит из двух частей: основных методов, вроде подключения и выполнения SQL-запросов, и небольшой ORM для часто встречающихся операций, вроде CREATE, SELECT, INSERT, DELETE и пр. Работа через ORM и через тексты запросов, выполняемые функцией `ВыполнитьЗапросSQL()`, технически не отличается: ORM просто формирует текст SQL-запроса на основе макетов, но далее также выполняет их этой функцией
По умолчанию, все запросы SELECT возвращают массив выбранных данных, а остальные запросы - только `true` в поле `result` при успехе, либо `false` и текст ошибки в полях `result` и `error` соответственно. Для выполнения запросов, требующих возврата данных, но не являющихся запросами SELECT, в функции `ВыполнитьЗапросSQL()` есть параметр `ФорсироватьРезультат`
## Параметры запросов
Коннектор MySQL поддерживает использование позиционных параметров. Все значения, передаваемые как при прямом выполнении запросов через функцию `ВыполнитьЗапросSQL()`, так и в ORM методах с установкой значений, вроде `ДобавитьЗаписи` и `ОбновитьЗаписи`, должный представлять из себя структуру вида `{'Тип данных': 'Значение'}`. Поддерживаются следующие типы данных\*:
> \* В перечне типов MySQL перечислены только некоторые подходящие типы
| Имя типа (ключ) | Тип значения 1С | Подходит для типов MySQL |
|-|-|-|
| BYTES | Строка (путь к файлу), ДвоичныеДанные||
| UINT | Число (целое, без знака) | TINYINT UNSIGNED, SMALLINT UNSIGNED, MEDIUMINT UNSIGNED, INT UNSIGNED, BIGINT UNSIGNED |
| INT | Число (целое) | TINYINT, SMALLINT, MEDIUMINT, INT, BIGINT |
| FLOAT | Число | FLOAT |
| DOUBLE | Число | DOUBLE (REAL, DOUBLE PRECISION) |
| DATE | Дата, Строка (дата в формате RFC 3339) | DATE, DATETIME, TIMESTAMP |
| TIME | Дата, Строка (дата в формате RFC 3339) | TIME |
| TEXT | Строка | CHAR, VARCHAR, TINYTEXT, TEXT, MEDIUMTEXT, LONGTEXT |
## TLS ## TLS

View File

@@ -8,10 +8,10 @@ sidebar_position: 3
## Совместимость ## Совместимость
Все внешние компоненты, добавляемые в ОПИ, собираются под x64 и x32 версии Windows и Linux. Они хранятся в специальных zip-архивах, состоящих из четырех файлов библиотек - по одному для каждой из платформ соответственно. Однако, в то время как на Windows с их использованием не возникает проблем, на Linux эти компоненты зависимы от наличия в системе трех вещей: `glibc`, `gcc` и `OpenSSL`⃰⃰ Все внешние компоненты, добавляемые в ОПИ, собираются под x64 и x32 версии Windows и Linux. Они хранятся в специальных zip-архивах, состоящих из четырех файлов библиотек - по одному для каждой из платформ соответственно. Однако, в то время как на Windows с их использованием не возникает проблем, на Linux эти компоненты зависимы от наличия в системе трех вещей: `glibc`, `gcc`\* и `OpenSSL`\*\*
> Касается CLI и OneScript версий > \* Касается CLI и OneScript версий <br/>
> ⃰⃰ Касается библиотек, использующих функционал TLS > \*\* Касается библиотек, использующих функционал TLS
### glibc ### glibc