From fa875743f1bc3996ff187c5ab4701e2d78c2c98a Mon Sep 17 00:00:00 2001 From: Anton Titovets Date: Thu, 10 Jul 2025 08:54:42 +0300 Subject: [PATCH] Fastfix --- .../MSSQL/Common-methods/Close-connection.mdx | 53 ++++++++ .../Common-methods/Create-connection.mdx | 51 +++++++ .../Common-methods/Execute-sql-query.mdx | 109 +++++++++++++++ .../Generate-connection-string.mdx | 52 +++++++ .../MSSQL/Common-methods/Get-tls-settings.mdx | 45 ++++++ .../md/MSSQL/Common-methods/Is-connector.mdx | 53 ++++++++ .../md/MSSQL/Common-methods/_category_.json | 4 + docs/en/md/MSSQL/Orm/Add-records.mdx | 99 ++++++++++++++ docs/en/md/MSSQL/Orm/Add-table-column.mdx | 40 ++++++ docs/en/md/MSSQL/Orm/Clear-table.mdx | 38 ++++++ docs/en/md/MSSQL/Orm/Create-database.mdx | 51 +++++++ docs/en/md/MSSQL/Orm/Create-table.mdx | 75 ++++++++++ docs/en/md/MSSQL/Orm/Delete-database.mdx | 38 ++++++ docs/en/md/MSSQL/Orm/Delete-records.mdx | 39 ++++++ docs/en/md/MSSQL/Orm/Delete-table-column.mdx | 39 ++++++ docs/en/md/MSSQL/Orm/Delete-table.mdx | 38 ++++++ docs/en/md/MSSQL/Orm/Ensure-table.mdx | 45 ++++++ .../Orm/Get-records-filter-strucutre.mdx | 42 ++++++ docs/en/md/MSSQL/Orm/Get-records.mdx | 94 +++++++++++++ .../en/md/MSSQL/Orm/Get-table-information.mdx | 38 ++++++ docs/en/md/MSSQL/Orm/Update-records.mdx | 46 +++++++ docs/en/md/MSSQL/Orm/_category_.json | 4 + .../MSSQL/Common-methods/Close-connection.mdx | 53 ++++++++ .../Common-methods/Create-connection.mdx | 51 +++++++ .../Common-methods/Execute-sql-query.mdx | 128 ++++++++++++++++++ .../Generate-connection-string.mdx | 52 +++++++ .../MSSQL/Common-methods/Get-tls-settings.mdx | 50 +++++++ .../md/MSSQL/Common-methods/Is-connector.mdx | 53 ++++++++ .../md/MSSQL/Common-methods/_category_.json | 4 + docs/ru/md/MSSQL/Orm/Add-records.mdx | 108 +++++++++++++++ docs/ru/md/MSSQL/Orm/Add-table-column.mdx | 40 ++++++ docs/ru/md/MSSQL/Orm/Clear-table.mdx | 38 ++++++ docs/ru/md/MSSQL/Orm/Create-database.mdx | 55 ++++++++ docs/ru/md/MSSQL/Orm/Create-table.mdx | 79 +++++++++++ docs/ru/md/MSSQL/Orm/Delete-database.mdx | 38 ++++++ docs/ru/md/MSSQL/Orm/Delete-records.mdx | 39 ++++++ docs/ru/md/MSSQL/Orm/Delete-table-column.mdx | 39 ++++++ docs/ru/md/MSSQL/Orm/Delete-table.mdx | 38 ++++++ docs/ru/md/MSSQL/Orm/Ensure-table.mdx | 45 ++++++ .../Orm/Get-records-filter-strucutre.mdx | 40 ++++++ docs/ru/md/MSSQL/Orm/Get-records.mdx | 120 ++++++++++++++++ .../ru/md/MSSQL/Orm/Get-table-information.mdx | 38 ++++++ docs/ru/md/MSSQL/Orm/Update-records.mdx | 46 +++++++ docs/ru/md/MSSQL/Orm/_category_.json | 4 + 44 files changed, 2251 insertions(+) create mode 100644 docs/en/md/MSSQL/Common-methods/Close-connection.mdx create mode 100644 docs/en/md/MSSQL/Common-methods/Create-connection.mdx create mode 100644 docs/en/md/MSSQL/Common-methods/Execute-sql-query.mdx create mode 100644 docs/en/md/MSSQL/Common-methods/Generate-connection-string.mdx create mode 100644 docs/en/md/MSSQL/Common-methods/Get-tls-settings.mdx create mode 100644 docs/en/md/MSSQL/Common-methods/Is-connector.mdx create mode 100644 docs/en/md/MSSQL/Common-methods/_category_.json create mode 100644 docs/en/md/MSSQL/Orm/Add-records.mdx create mode 100644 docs/en/md/MSSQL/Orm/Add-table-column.mdx create mode 100644 docs/en/md/MSSQL/Orm/Clear-table.mdx create mode 100644 docs/en/md/MSSQL/Orm/Create-database.mdx create mode 100644 docs/en/md/MSSQL/Orm/Create-table.mdx create mode 100644 docs/en/md/MSSQL/Orm/Delete-database.mdx create mode 100644 docs/en/md/MSSQL/Orm/Delete-records.mdx create mode 100644 docs/en/md/MSSQL/Orm/Delete-table-column.mdx create mode 100644 docs/en/md/MSSQL/Orm/Delete-table.mdx create mode 100644 docs/en/md/MSSQL/Orm/Ensure-table.mdx create mode 100644 docs/en/md/MSSQL/Orm/Get-records-filter-strucutre.mdx create mode 100644 docs/en/md/MSSQL/Orm/Get-records.mdx create mode 100644 docs/en/md/MSSQL/Orm/Get-table-information.mdx create mode 100644 docs/en/md/MSSQL/Orm/Update-records.mdx create mode 100644 docs/en/md/MSSQL/Orm/_category_.json create mode 100644 docs/ru/md/MSSQL/Common-methods/Close-connection.mdx create mode 100644 docs/ru/md/MSSQL/Common-methods/Create-connection.mdx create mode 100644 docs/ru/md/MSSQL/Common-methods/Execute-sql-query.mdx create mode 100644 docs/ru/md/MSSQL/Common-methods/Generate-connection-string.mdx create mode 100644 docs/ru/md/MSSQL/Common-methods/Get-tls-settings.mdx create mode 100644 docs/ru/md/MSSQL/Common-methods/Is-connector.mdx create mode 100644 docs/ru/md/MSSQL/Common-methods/_category_.json create mode 100644 docs/ru/md/MSSQL/Orm/Add-records.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Add-table-column.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Clear-table.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Create-database.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Create-table.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Delete-database.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Delete-records.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Delete-table-column.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Delete-table.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Ensure-table.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Get-records-filter-strucutre.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Get-records.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Get-table-information.mdx create mode 100644 docs/ru/md/MSSQL/Orm/Update-records.mdx create mode 100644 docs/ru/md/MSSQL/Orm/_category_.json diff --git a/docs/en/md/MSSQL/Common-methods/Close-connection.mdx b/docs/en/md/MSSQL/Common-methods/Close-connection.mdx new file mode 100644 index 0000000000..5736805fcf --- /dev/null +++ b/docs/en/md/MSSQL/Common-methods/Close-connection.mdx @@ -0,0 +1,53 @@ +--- +sidebar_position: 2 +description: Close connection and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Close connection + Explicitly closes the passed connection + + + +`Function CloseConnection(Val Connection) Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Connection | - | Arbitrary | ✔ | AddIn object with open connection | + + + Returns: Structure Of KeyAndValue - Result of connection termination + +
+ + +:::caution +**NOCLI:** this method is not available in CLI version +::: +
+ + + +```bsl title="1C:Enterprise/OneScript code example" + Address = "127.0.0.1"; + Login = "SA"; + Password = "12we..."; + + ConnectionString = OPI_MSSQL.GenerateConnectionString(Address, , Login, Password); + TLSSettings = OPI_MSSQL.GetTlsSettings(True); + + Connection = OPI_MSSQL.CreateConnection(ConnectionString, TLSSettings); + Result = OPI_MSSQL.CloseConnection(Connection); +``` + + + + +```json title="Result" +{ + "result": true +} +``` diff --git a/docs/en/md/MSSQL/Common-methods/Create-connection.mdx b/docs/en/md/MSSQL/Common-methods/Create-connection.mdx new file mode 100644 index 0000000000..03052e9668 --- /dev/null +++ b/docs/en/md/MSSQL/Common-methods/Create-connection.mdx @@ -0,0 +1,51 @@ +--- +sidebar_position: 1 +description: Create Connection and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Create Connection + Creates a connection to the specified base + + + +`Function CreateConnection(Val ConnectionString = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | ConnectionString | - | String | ✖ | Connection string. See GenerateConnectionString | + | Tls | - | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Arbitrary - Connector object or structure with error information + +
+ + +:::caution +**NOCLI:** this method is not available in CLI version +::: +
+ + + +```bsl title="1C:Enterprise/OneScript code example" + Address = "127.0.0.1"; + Login = "SA"; + Password = "12we..."; + + ConnectionString = OPI_MSSQL.GenerateConnectionString(Address, , Login, Password); + TLSSettings = OPI_MSSQL.GetTlsSettings(True); + + Result = OPI_MSSQL.CreateConnection(ConnectionString, TLSSettings); +``` + + + + +```json title="Result" +NOT JSON: OneScript.StandardLibrary.NativeApi.NativeApiComponent +``` diff --git a/docs/en/md/MSSQL/Common-methods/Execute-sql-query.mdx b/docs/en/md/MSSQL/Common-methods/Execute-sql-query.mdx new file mode 100644 index 0000000000..5856d18b62 --- /dev/null +++ b/docs/en/md/MSSQL/Common-methods/Execute-sql-query.mdx @@ -0,0 +1,109 @@ +--- +sidebar_position: 4 +description: Execute SQL query and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Execute SQL query + Executes an arbitrary SQL query + + + +`Function ExecuteSQLQuery(Val QueryText, Val Parameters = "", Val ForceResult = False, Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | QueryText | --sql | String | ✔ | Database query text | + | Parameters | --params | Array Of Arbitrary | ✖ | Array of positional parameters of the request | + | ForceResult | --force | Boolean | ✖ | Includes an attempt to retrieve the result, even for nonSELECT queries | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ +:::tip +Query parameters are specified as an array of structures of the following type: `{'Type': 'Value'}`. List of available types is described on the initial page of the MSSQL library documentation + +Without specifying the `ForcifyResult` flag, result data is returned only for queries beginning with `SELECT` keyword For other queries, `result:true` or `false` with error text is returned +::: +
+ + + +```bsl title="1C:Enterprise/OneScript code example" + CurrentDate = OPI_Tools.GetCurrentDate(); + Image = "https://hut.openintegrations.dev/test_data/picture.jpg"; + OPI_TypeConversion.GetBinaryData(Image); // Image - Type: BinaryData + + Address = "127.0.0.1"; + Login = "SA"; + Password = "12we..."; + Base = "test_data"; + + TLSSettings = OPI_MSSQL.GetTlsSettings(True); + ConnectionString = OPI_MSSQL.GenerateConnectionString(Address, Base, Login, Password); + Connection = OPI_MSSQL.CreateConnection(ConnectionString, TLSSettings); + + // CREATE + + QueryText = " + |CREATE TABLE test_table ( + | ID INT PRIMARY KEY, + | FirstName NVARCHAR(50), + | LastName NVARCHAR(50), + | BirthDate DATE, + | IsEmployed BIT, + | Salary DECIMAL(10, 2), + | CreatedAt DATETIME, + | Age SMALLINT, + | RowGuid UNIQUEIDENTIFIER, + | Data VARBINARY(MAX) + |);"; + + Result = OPI_MSSQL.ExecuteSQLQuery(QueryText, , , Connection); + + // INSERT with parameters + + QueryText = " + |INSERT INTO test_table (ID, FirstName, LastName, BirthDate, IsEmployed, Salary, CreatedAt, Age, RowGuid, Data) + |VALUES (@P1, @P2, @P3, @P4, @P5, @P6, @P7, @P8, @P9, @P10);"; + + ParameterArray = New Array; + ParameterArray.Add(New Structure("INT" , 1)); + ParameterArray.Add(New Structure("NVARCHAR", "Vitaly")); + ParameterArray.Add(New Structure("NVARCHAR", "Alpaca")); + ParameterArray.Add(New Structure("DATE" , CurrentDate)); + ParameterArray.Add(New Structure("BIT" , True)); + ParameterArray.Add(New Structure("DECIMAL" , 10.30)); + ParameterArray.Add(New Structure("DATETIME", CurrentDate)); + ParameterArray.Add(New Structure("SMALLINT", 20)); + ParameterArray.Add(New Structure("UUID" , New UUID)); + ParameterArray.Add(New Structure("BYTES" , Image)); + + Result = OPI_MSSQL.ExecuteSQLQuery(QueryText, ParameterArray, , Connection); + + // SELECT (The result of this query is shown in the Result block) + + QueryText = "SELECT FirstName, LastName, BirthDate, IsEmployed, Salary, CreatedAt, Age, RowGuid, Data FROM test_table;"; + + Result = OPI_MSSQL.ExecuteSQLQuery(QueryText, , , Connection); + + // SQL query from file + + SQLFile = "https://hut.openintegrations.dev/test_data/TEST_DATA2.sql"; // Binary Data, URL or path to file + + Result = OPI_MSSQL.ExecuteSQLQuery(SQLFile, , , Connection); + + Closing = OPI_MSSQL.CloseConnection(Connection); +``` + + + + + diff --git a/docs/en/md/MSSQL/Common-methods/Generate-connection-string.mdx b/docs/en/md/MSSQL/Common-methods/Generate-connection-string.mdx new file mode 100644 index 0000000000..2dbb7569ec --- /dev/null +++ b/docs/en/md/MSSQL/Common-methods/Generate-connection-string.mdx @@ -0,0 +1,52 @@ +--- +sidebar_position: 5 +description: Generate connection string and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Generate connection string + Forms a connection string from the passed data + + + +`Function GenerateConnectionString(Val Address, Val Base = "", Val Login = "", Val Password = "", Val Port = "", Val WindowsAuth = False) Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Address | --addr | String | ✔ | Database server address and instance | + | Base | --db | String | ✖ | Name of the database to connect | + | Login | --login | String | ✖ | mssql user login | + | Password | --pass | String | ✖ | mssql user password | + | Port | --port | Number | ✖ | Server port | + | WindowsAuth | --trust | Boolean | ✖ | Use Windows authentication. The login and password will be ignored | + + + Returns: String - MSSQL connection string + +
+ +:::tip +This function allows you to quickly assemble a basic connection string. In case you need more flexible configuration, you can also form (obtain) this connection string on your own (ADO format) +::: +
+ + + +```bsl title="1C:Enterprise/OneScript code example" + Address = "127.0.0.1"; + Login = "bayselonarrend"; + Password = "12we..."; + Base = ""; + + Result = OPI_MSSQL.GenerateConnectionString(Address, Base, Login, Password); +``` + + + + +```json title="Result" +"Server=127.0.0.1;User Id=bayselonarrend;Password=***;" +``` diff --git a/docs/en/md/MSSQL/Common-methods/Get-tls-settings.mdx b/docs/en/md/MSSQL/Common-methods/Get-tls-settings.mdx new file mode 100644 index 0000000000..6222f1ff2c --- /dev/null +++ b/docs/en/md/MSSQL/Common-methods/Get-tls-settings.mdx @@ -0,0 +1,45 @@ +--- +sidebar_position: 6 +description: Get TLS Settings and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Get TLS Settings + Forms settings for using TLS + + + +`Function GetTlsSettings(Val DisableCertVerification, Val CertFilepath = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | DisableCertVerification | --trust | Boolean | ✔ | Allows to work with invalid certificates, including self signed | + | CertFilepath | --cert | String | ✖ | Path to the root PEM file of the certificate if it is not in the system repository | + + + Returns: Structure Of KeyAndValue - Structure of TLS connection settings + +
+ +:::tip +Tls settings can only be set when a connection is created: explicitly, by using the `OpenConnection` function or implicit, when passing the connection string to ORM methods. + +Passing Tls settings together with passing an already created connection to the `Connection` parameter will be ignored + +Tls settings can also be passed in the connection string +::: +
+ + + +```bsl title="1C:Enterprise/OneScript code example" + Result = OPI_MSSQL.GetTlsSettings(True); +``` + + + + + diff --git a/docs/en/md/MSSQL/Common-methods/Is-connector.mdx b/docs/en/md/MSSQL/Common-methods/Is-connector.mdx new file mode 100644 index 0000000000..d87ec459af --- /dev/null +++ b/docs/en/md/MSSQL/Common-methods/Is-connector.mdx @@ -0,0 +1,53 @@ +--- +sidebar_position: 3 +description: Is connector and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Is connector + Checks that the value is an object of the external MSSQL component + + + +`Function IsConnector(Val Value) Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Value | - | Arbitrary | ✔ | Value to check | + + + Returns: Boolean - Is connector + +
+ + +:::caution +**NOCLI:** this method is not available in CLI version +::: +
+ + + +```bsl title="1C:Enterprise/OneScript code example" + Address = "127.0.0.1"; + Login = "SA"; + Password = "12we..."; + + ConnectionString = OPI_MSSQL.GenerateConnectionString(Address, , Login, Password); + TLSSettings = OPI_MSSQL.GetTlsSettings(True); + + Connection = OPI_MSSQL.CreateConnection(ConnectionString, TLSSettings); + Result = OPI_MSSQL.IsConnector(Connection); + + OPI_MSSQL.CloseConnection(Result); +``` + + + + +```json title="Result" +false +``` diff --git a/docs/en/md/MSSQL/Common-methods/_category_.json b/docs/en/md/MSSQL/Common-methods/_category_.json new file mode 100644 index 0000000000..04585be7f8 --- /dev/null +++ b/docs/en/md/MSSQL/Common-methods/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Common methods", +"position": "2" +} \ No newline at end of file diff --git a/docs/en/md/MSSQL/Orm/Add-records.mdx b/docs/en/md/MSSQL/Orm/Add-records.mdx new file mode 100644 index 0000000000..2516cbeb3f --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Add-records.mdx @@ -0,0 +1,99 @@ +--- +sidebar_position: 10 +description: Add rows and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Add rows + Adds new rows to the table + + + +`Function AddRecords(Val Table, Val DataArray, Val Transaction = True, Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Table | --table | String | ✔ | Table name | + | DataArray | --rows | Array of Structure | ✔ | An array of string data structures: Key > field, Value > field value | + | Transaction | --trn | Boolean | ✖ | True > adding records to transactions with rollback on error | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ +:::tip +Record data is specified as an array of structures of the following type:
`{'Field name 1': {'Type': 'Value'}, 'Field name 2': {'Type': 'Value'},...}` + +List of available types is described on the initial page of the MSSQL library documentation +::: +
+ + + +```bsl title="1C:Enterprise/OneScript code example" + Address = "127.0.0.1"; + Login = "SA"; + Password = "12we..."; + Base = "testbase1"; + + TLSSettings = OPI_MSSQL.GetTlsSettings(True); + ConnectionString = OPI_MSSQL.GenerateConnectionString(Address, Base, Login, Password); + + Table = "testtable"; + RecordsArray = New Array; + + Image = "https://hut.openintegrations.dev/test_data/picture.jpg"; + OPI_TypeConversion.GetBinaryData(Image); // Image - Type: BinaryData + + XML = " + | + | + | Example + | 123 + | + | + | Test + | 456 + | + |"; + + CurrentDate = OPI_Tools.GetCurrentDate(); + CurrentDateTZ = OPI_Tools.DateRFC3339(CurrentDate, "+05:00"); + + RecordStructure = New Structure; + RecordStructure.Insert("tinyint_field" , New Structure("TINYINT" , 5)); + RecordStructure.Insert("smallint_field" , New Structure("SMALLINT" , 2000)); + RecordStructure.Insert("int_field" , New Structure("INT" , 200000)); + RecordStructure.Insert("bigint_field" , New Structure("BIGINT" , 20000000000)); + RecordStructure.Insert("float24_field" , New Structure("FLOAT24" , 10.1234567)); + RecordStructure.Insert("float53_field" , New Structure("FLOAT53" , 10.123456789123456)); + RecordStructure.Insert("bit_field" , New Structure("BIT" , True)); + RecordStructure.Insert("nvarchar_field" , New Structure("NVARCHAR" , "Some text")); + RecordStructure.Insert("varbinary_field", New Structure("BYTES" , Image)); + RecordStructure.Insert("uid_field" , New Structure("UUID" , New UUID)); + RecordStructure.Insert("numeric_field" , New Structure("NUMERIC" , 5.333)); + RecordStructure.Insert("xml_field" , New Structure("XML" , XML)); + RecordStructure.Insert("date_field" , New Structure("DATE" , CurrentDate)); + RecordStructure.Insert("time_field" , New Structure("TIME" , CurrentDate)); + RecordStructure.Insert("dto_field" , New Structure("DATETIMEOFFSET", CurrentDateTZ)); + RecordStructure.Insert("datetime_field" , New Structure("DATETIME" , CurrentDate)); + + RecordsArray.Add(RecordStructure); + + // When using the connection string, a new connection is initialised, + // which will be closed after the function is executed. + // If several operations are performed, it is desirable to use one connection, + // previously created by the CreateConnection function() + Result = OPI_MSSQL.AddRecords(Table, RecordsArray, True, ConnectionString, TLSSettings); +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Add-table-column.mdx b/docs/en/md/MSSQL/Orm/Add-table-column.mdx new file mode 100644 index 0000000000..6f6c15be15 --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Add-table-column.mdx @@ -0,0 +1,40 @@ +--- +sidebar_position: 4 +description: Add table column and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Add table column + Adds a new column to an existing table + + + +`Function AddTableColumn(Val Table, Val Name, Val DataType, Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Table | --table | String | ✔ | Table name | + | Name | --name | String | ✔ | Column name | + | DataType | --type | String | ✔ | Column data type | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ + + + +```bsl title="1C:Enterprise/OneScript code example" + +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Clear-table.mdx b/docs/en/md/MSSQL/Orm/Clear-table.mdx new file mode 100644 index 0000000000..169c94227b --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Clear-table.mdx @@ -0,0 +1,38 @@ +--- +sidebar_position: 7 +description: Clear table and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Clear table + Clears the database table + + + +`Function ClearTable(Val Table, Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Table | --table | String | ✔ | Table name | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ + + + +```bsl title="1C:Enterprise/OneScript code example" + +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Create-database.mdx b/docs/en/md/MSSQL/Orm/Create-database.mdx new file mode 100644 index 0000000000..6b831a611d --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Create-database.mdx @@ -0,0 +1,51 @@ +--- +sidebar_position: 1 +description: Create database and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Create database + Creates a database with the specified name + + + +`Function CreateDatabase(Val Base, Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Base | --base | String | ✔ | Database name | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ + + + +```bsl title="1C:Enterprise/OneScript code example" + Address = "127.0.0.1"; + Login = "SA"; + Password = "12we..."; + + TLSSettings = OPI_MSSQL.GetTlsSettings(True); + ConnectionString = OPI_MSSQL.GenerateConnectionString(Address, , Login, Password); + + Base = "testbase1"; + + // When using the connection string, a new connection is initialised, + // which will be closed after the function is executed. + // If several operations are performed, it is desirable to use one connection, + // previously created by the CreateConnection function() + Result = OPI_MSSQL.CreateDatabase(Base, ConnectionString, TLSSettings); +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Create-table.mdx b/docs/en/md/MSSQL/Orm/Create-table.mdx new file mode 100644 index 0000000000..4b0e333ee7 --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Create-table.mdx @@ -0,0 +1,75 @@ +--- +sidebar_position: 3 +description: Create table and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Create table + Creates an empty table in the database + + + +`Function CreateTable(Val Table, Val ColoumnsStruct, Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Table | --table | String | ✔ | Table name | + | ColoumnsStruct | --cols | Structure Of KeyAndValue | ✔ | Column structure: Key > Name, Value > Data type | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ +:::tip +List of available types is described on the initial page of the MSSQL library documentation +::: +
+ + + +```bsl title="1C:Enterprise/OneScript code example" + Address = "127.0.0.1"; + Login = "SA"; + Password = "12we..."; + Base = "testbase1"; + + TLSSettings = OPI_MSSQL.GetTlsSettings(True); + ConnectionString = OPI_MSSQL.GenerateConnectionString(Address, Base, Login, Password); + + Table = "testtable"; + + ColoumnsStruct = New Structure; + ColoumnsStruct.Insert("tinyint_field" , "tinyint"); + ColoumnsStruct.Insert("smallint_field" , "smallint"); + ColoumnsStruct.Insert("int_field" , "int"); + ColoumnsStruct.Insert("bigint_field" , "bigint"); + ColoumnsStruct.Insert("float24_field" , "float(24)"); + ColoumnsStruct.Insert("float53_field" , "float(53)"); + ColoumnsStruct.Insert("bit_field" , "bit"); + ColoumnsStruct.Insert("nvarchar_field" , "nvarchar(4000)"); + ColoumnsStruct.Insert("varbinary_field", "varbinary(max)"); + ColoumnsStruct.Insert("uid_field" , "uniqueidentifier"); + ColoumnsStruct.Insert("numeric_field" , "numeric(5,3)"); // Or decimal + ColoumnsStruct.Insert("xml_field" , "xml"); + ColoumnsStruct.Insert("date_field" , "date"); + ColoumnsStruct.Insert("time_field" , "time"); + ColoumnsStruct.Insert("dto_field" , "datetimeoffset"); + ColoumnsStruct.Insert("datetime_field" , "datetime"); + + // When using the connection string, a new connection is initialised, + // which will be closed after the function is executed. + // If several operations are performed, it is desirable to use one connection, + // previously created by the CreateConnection function() + Result = OPI_MSSQL.CreateTable(Table, ColoumnsStruct, ConnectionString, TLSSettings); +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Delete-database.mdx b/docs/en/md/MSSQL/Orm/Delete-database.mdx new file mode 100644 index 0000000000..e46edd5299 --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Delete-database.mdx @@ -0,0 +1,38 @@ +--- +sidebar_position: 2 +description: Drop database and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Drop database + Deletes the database + + + +`Function DeleteDatabase(Val Base, Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Base | --base | String | ✔ | Database name | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ + + + +```bsl title="1C:Enterprise/OneScript code example" + +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Delete-records.mdx b/docs/en/md/MSSQL/Orm/Delete-records.mdx new file mode 100644 index 0000000000..6eeaac8847 --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Delete-records.mdx @@ -0,0 +1,39 @@ +--- +sidebar_position: 13 +description: Delete records and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Delete records + Deletes records from the table + + + +`Function DeleteRecords(Val Table, Val Filters = "", Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Table | --table | String | ✔ | Table name | + | Filters | --filter | Array of Structure | ✖ | Filters array. See GetRecordsFilterStrucutre | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ + + + +```bsl title="1C:Enterprise/OneScript code example" + +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Delete-table-column.mdx b/docs/en/md/MSSQL/Orm/Delete-table-column.mdx new file mode 100644 index 0000000000..c61848be89 --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Delete-table-column.mdx @@ -0,0 +1,39 @@ +--- +sidebar_position: 5 +description: Delete table column and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Delete table column + Deletes a column from the table + + + +`Function DeleteTableColumn(Val Table, Val Name, Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Table | --table | String | ✔ | Table name | + | Name | --name | String | ✔ | Column name | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ + + + +```bsl title="1C:Enterprise/OneScript code example" + +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Delete-table.mdx b/docs/en/md/MSSQL/Orm/Delete-table.mdx new file mode 100644 index 0000000000..19dad2ea72 --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Delete-table.mdx @@ -0,0 +1,38 @@ +--- +sidebar_position: 8 +description: Delete table and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Delete table + Deletes a table from the database + + + +`Function DeleteTable(Val Table, Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Table | --table | String | ✔ | Table name | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ + + + +```bsl title="1C:Enterprise/OneScript code example" + +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Ensure-table.mdx b/docs/en/md/MSSQL/Orm/Ensure-table.mdx new file mode 100644 index 0000000000..93f2e31e6a --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Ensure-table.mdx @@ -0,0 +1,45 @@ +--- +sidebar_position: 6 +description: Ensure table and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Ensure table + Creates a new table if it does not exist or updates the composition of columns in an existing table + + + +`Function EnsureTable(Val Table, Val ColoumnsStruct, Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Table | --table | String | ✔ | Table name | + | ColoumnsStruct | --cols | Structure Of KeyAndValue | ✔ | Column structure: Key > Name, Value > Data type | + | Connection | --dbc | String, Arbitrary | ✖ | Existing connection or database path | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ +:::tip +As a result of changing the table structure, data may be lost! It is recommended to test this method on test data beforehand + +This function does not update the data type of existing columns +::: +
+ + + +```bsl title="1C:Enterprise/OneScript code example" + +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Get-records-filter-strucutre.mdx b/docs/en/md/MSSQL/Orm/Get-records-filter-strucutre.mdx new file mode 100644 index 0000000000..e4041795a1 --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Get-records-filter-strucutre.mdx @@ -0,0 +1,42 @@ +--- +sidebar_position: 14 +description: Get records filter strucutre and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Get records filter strucutre + Gets the template structure for filtering records in ORM queries + + + +`Function GetRecordsFilterStrucutre(Val Clear = False) Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Clear | --empty | Boolean | ✖ | True > structure with empty valuse, False > field descriptions at values | + + + Returns: Structure Of KeyAndValue - Record filter element + +
+ +:::tip +The use of the `raw` feature is necessary for compound constructions like `BEETWEEN`. For example: with `raw:false` the filter `type:BETWEEN` `value:10 AND 20` will be interpolated as `BETWEEN ?1 ` where `?1 = "10 AND 20,"' which would cause an error. + +In such a case, you must use `raw:true` to set the condition directly in the query text +::: +
+ + + +```bsl title="1C:Enterprise/OneScript code example" + +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Get-records.mdx b/docs/en/md/MSSQL/Orm/Get-records.mdx new file mode 100644 index 0000000000..3e0d56e9be --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Get-records.mdx @@ -0,0 +1,94 @@ +--- +sidebar_position: 11 +description: Get records and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Get records + Gets records from the selected table + + + +`Function GetRecords(Val Table, Val Fields = "*", Val Filters = "", Val Sort = "", Val Count = "", Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Table | --table | String | ✔ | Table name | + | Fields | --fields | Array Of String | ✖ | Fields for selection | + | Filters | --filter | Array of Structure | ✖ | Filters array. See GetRecordsFilterStrucutre | + | Sort | --order | Structure Of KeyAndValue | ✖ | Sorting: Key > field name, Value > direction (ASC, DESC) | + | Count | --limit | Number | ✖ | Limiting the number of received strings | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ + + + +```bsl title="1C:Enterprise/OneScript code example" + Address = "127.0.0.1"; + Login = "SA"; + Password = "12we..."; + Base = "testbase1"; + + TLSSettings = OPI_MSSQL.GetTlsSettings(True); + ConnectionString = OPI_MSSQL.GenerateConnectionString(Address, Base, Login, Password); + + // All records without filters + + Table = "testtable"; + + // When using the connection string, a new connection is initialised, + // which will be closed after the function is executed. + // If several operations are performed, it is desirable to use one connection, + // previously created by the CreateConnection function() + Result = OPI_MSSQL.GetRecords(Table, , , , , ConnectionString, TLSSettings); + + // Filter, selected fields, limit and sorting + + ConnectionString = OPI_MSSQL.GenerateConnectionString(Address, "test_data", Login, Password); + + Table = "test_data"; + + Fields = New Array; + Fields.Add("first_name"); + Fields.Add("last_name"); + Fields.Add("email"); + + Filters = New Array; + + FilterStructure1 = New Structure; + + FilterStructure1.Insert("field", "gender"); + FilterStructure1.Insert("type" , "="); + FilterStructure1.Insert("value", "Male"); + FilterStructure1.Insert("union", "AND"); + FilterStructure1.Insert("raw" , False); + + FilterStructure2 = New Structure; + + FilterStructure2.Insert("field", "id"); + FilterStructure2.Insert("type" , "BETWEEN"); + FilterStructure2.Insert("value", "20 AND 50"); + FilterStructure2.Insert("raw" , True); + + Filters.Add(FilterStructure1); + Filters.Add(FilterStructure2); + + Sort = New Structure("ip_address", "DESC"); + Count = 5; + + Result = OPI_MSSQL.GetRecords(Table, Fields, Filters, Sort, Count, ConnectionString, TLSSettings); +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Get-table-information.mdx b/docs/en/md/MSSQL/Orm/Get-table-information.mdx new file mode 100644 index 0000000000..32d5b8c24c --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Get-table-information.mdx @@ -0,0 +1,38 @@ +--- +sidebar_position: 9 +description: Get table information and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Get table information + Gets information about the table + + + +`Function GetTableInformation(Val Table, Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Table | --table | String | ✔ | Table name | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ + + + +```bsl title="1C:Enterprise/OneScript code example" + +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/Update-records.mdx b/docs/en/md/MSSQL/Orm/Update-records.mdx new file mode 100644 index 0000000000..c6f5d246b9 --- /dev/null +++ b/docs/en/md/MSSQL/Orm/Update-records.mdx @@ -0,0 +1,46 @@ +--- +sidebar_position: 12 +description: Update records and other functions to work with MS SQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI +keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Update records + Updates the value of records by selected criteria + + + +`Function UpdateRecords(Val Table, Val ValueStructure, Val Filters = "", Val Connection = "", Val Tls = "") Export` + + | Parameter | CLI option | Type | Required | Description | + |-|-|-|-|-| + | Table | --table | String | ✔ | Table name | + | ValueStructure | --values | Structure Of KeyAndValue | ✔ | Values structure: Key > field, Value > field value | + | Filters | --filter | Array of Structure | ✖ | Filters array. See GetRecordsFilterStrucutre | + | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string | + | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings | + + + Returns: Map Of KeyAndValue - Result of query execution + +
+ +:::tip +Record data is specified as an array of structures of the following type:
`{'Field name 1': {'Type': 'Value'}, 'Field name 2': {'Type': 'Value'},...}` + +List of available types is described on the initial page of the MSSQL library documentation +::: +
+ + + +```bsl title="1C:Enterprise/OneScript code example" + +``` + + + + + diff --git a/docs/en/md/MSSQL/Orm/_category_.json b/docs/en/md/MSSQL/Orm/_category_.json new file mode 100644 index 0000000000..e10609d962 --- /dev/null +++ b/docs/en/md/MSSQL/Orm/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "ORM", +"position": "3" +} \ No newline at end of file diff --git a/docs/ru/md/MSSQL/Common-methods/Close-connection.mdx b/docs/ru/md/MSSQL/Common-methods/Close-connection.mdx new file mode 100644 index 0000000000..13ee86e769 --- /dev/null +++ b/docs/ru/md/MSSQL/Common-methods/Close-connection.mdx @@ -0,0 +1,53 @@ +--- +sidebar_position: 2 +description: Закрыть соединение и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Закрыть соединение + Явно закрывает переданное соединение + + + +`Функция ЗакрытьСоединение(Знач Соединение) Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Соединение | - | Произвольный | ✔ | Объект компоненты с открытым соединением | + + + Возвращаемое значение: Структура Из КлючИЗначение - Результат закрытия соединения + +
+ + +:::caution +**NOCLI:** данный метод недоступен для использования в CLI версии +::: +
+ + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + Адрес = "127.0.0.1"; + Логин = "SA"; + Пароль = "12we..."; + + СтрокаПодключения = OPI_MSSQL.СформироватьСтрокуПодключения(Адрес, , Логин, Пароль); + НастройкиTLS = OPI_MSSQL.ПолучитьНастройкиTls(Истина); + + Соединение = OPI_MSSQL.ОткрытьСоединение(СтрокаПодключения, НастройкиTLS); + Результат = OPI_MSSQL.ЗакрытьСоединение(Соединение); +``` + + + + +```json title="Результат" +{ + "result": true +} +``` diff --git a/docs/ru/md/MSSQL/Common-methods/Create-connection.mdx b/docs/ru/md/MSSQL/Common-methods/Create-connection.mdx new file mode 100644 index 0000000000..7872229091 --- /dev/null +++ b/docs/ru/md/MSSQL/Common-methods/Create-connection.mdx @@ -0,0 +1,51 @@ +--- +sidebar_position: 1 +description: Открыть соединение и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Открыть соединение + Создает подключение к указанной базе + + + +`Функция ОткрытьСоединение(Знач СтрокаПодключения = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | СтрокаПодключения | - | Строка | ✖ | Строка подключения. См. СформироватьСтрокуПодключения | + | Tls | - | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Произвольный - Объект коннектора или структура с информацией об ошибке + +
+ + +:::caution +**NOCLI:** данный метод недоступен для использования в CLI версии +::: +
+ + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + Адрес = "127.0.0.1"; + Логин = "SA"; + Пароль = "12we..."; + + СтрокаПодключения = OPI_MSSQL.СформироватьСтрокуПодключения(Адрес, , Логин, Пароль); + НастройкиTLS = OPI_MSSQL.ПолучитьНастройкиTls(Истина); + + Результат = OPI_MSSQL.ОткрытьСоединение(СтрокаПодключения, НастройкиTLS); +``` + + + + +```json title="Результат" +НЕ JSON: OneScript.StandardLibrary.NativeApi.NativeApiComponent +``` diff --git a/docs/ru/md/MSSQL/Common-methods/Execute-sql-query.mdx b/docs/ru/md/MSSQL/Common-methods/Execute-sql-query.mdx new file mode 100644 index 0000000000..873f75038d --- /dev/null +++ b/docs/ru/md/MSSQL/Common-methods/Execute-sql-query.mdx @@ -0,0 +1,128 @@ +--- +sidebar_position: 4 +description: Выполнить запрос SQL и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Выполнить запрос SQL + Выполняет произвольный SQL запрос + + + +`Функция ВыполнитьЗапросSQL(Знач ТекстЗапроса, Знач Параметры = "", Знач ФорсироватьРезультат = Ложь, Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | ТекстЗапроса | --sql | Строка | ✔ | Текст запроса к базе | + | Параметры | --params | Массив Из Произвольный | ✖ | Массив позиционных параметров запроса | + | ФорсироватьРезультат | --force | Булево | ✖ | Включает попытку получения результата, даже для не SELECT запросов | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ +:::tip +Параметры запроса указываются как массив структур вида `{'Тип данных': 'Значение'}`. Список доступных типов описан на начальной странице документации библиотеки MSSQL + +Без указания флага `ФорсироватьРезультат`, чтение результата осуществляется только для запросов, начинающихся с `SELECT` Для остальных запросов возвращается `result:true` или `false` с текстом ошибки +::: +
+ + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); + Картинка = "https://hut.openintegrations.dev/test_data/picture.jpg"; + OPI_ПреобразованиеТипов.ПолучитьДвоичныеДанные(Картинка); // Картинка - Тип: ДвоичныеДанные + + Адрес = "127.0.0.1"; + Логин = "SA"; + Пароль = "12we..."; + База = "test_data"; + + НастройкиTLS = OPI_MSSQL.ПолучитьНастройкиTls(Истина); + СтрокаПодключения = OPI_MSSQL.СформироватьСтрокуПодключения(Адрес, База, Логин, Пароль); + Соединение = OPI_MSSQL.ОткрытьСоединение(СтрокаПодключения, НастройкиTLS); + + // CREATE + + ТекстЗапроса = " + |CREATE TABLE test_table ( + | ID INT PRIMARY KEY, + | FirstName NVARCHAR(50), + | LastName NVARCHAR(50), + | BirthDate DATE, + | IsEmployed BIT, + | Salary DECIMAL(10, 2), + | CreatedAt DATETIME, + | Age SMALLINT, + | RowGuid UNIQUEIDENTIFIER, + | Data VARBINARY(MAX) + |);"; + + Результат = OPI_MSSQL.ВыполнитьЗапросSQL(ТекстЗапроса, , , Соединение); + + // INSERT с параметрами + + ТекстЗапроса = " + |INSERT INTO test_table (ID, FirstName, LastName, BirthDate, IsEmployed, Salary, CreatedAt, Age, RowGuid, Data) + |VALUES (@P1, @P2, @P3, @P4, @P5, @P6, @P7, @P8, @P9, @P10);"; + + МассивПараметров = Новый Массив; + МассивПараметров.Добавить(Новый Структура("INT" , 1)); + МассивПараметров.Добавить(Новый Структура("NVARCHAR", "Vitaly")); + МассивПараметров.Добавить(Новый Структура("NVARCHAR", "Alpaca")); + МассивПараметров.Добавить(Новый Структура("DATE" , ТекущаяДата)); + МассивПараметров.Добавить(Новый Структура("BIT" , Истина)); + МассивПараметров.Добавить(Новый Структура("DECIMAL" , 10.30)); + МассивПараметров.Добавить(Новый Структура("DATETIME", ТекущаяДата)); + МассивПараметров.Добавить(Новый Структура("SMALLINT", 20)); + МассивПараметров.Добавить(Новый Структура("UUID" , Новый УникальныйИдентификатор)); + МассивПараметров.Добавить(Новый Структура("BYTES" , Картинка)); + + Результат = OPI_MSSQL.ВыполнитьЗапросSQL(ТекстЗапроса, МассивПараметров, , Соединение); + + // SELECT (Результат этого запроса приведен в следующем блоке) + + ТекстЗапроса = "SELECT FirstName, LastName, BirthDate, IsEmployed, Salary, CreatedAt, Age, RowGuid, Data FROM test_table;"; + + Результат = OPI_MSSQL.ВыполнитьЗапросSQL(ТекстЗапроса, , , Соединение); + + // SQL запрос из файла + + ФайлSQL = "https://hut.openintegrations.dev/test_data/TEST_DATA2.sql"; // Двоичные данные, URL или путь к файлу + + Результат = OPI_MSSQL.ВыполнитьЗапросSQL(ФайлSQL, , , Соединение); + + Закрытие = OPI_MSSQL.ЗакрытьСоединение(Соединение); +``` + + + + +```json title="Результат" +{ + "data": [ + { + "Age": null, + "BirthDate": "2025-07-04", + "CreatedAt": "2025-07-04T18:43:28", + "Data": { + "BYTES": "Base64" + }, + "FirstName": "Vitaly", + "IsEmployed": null, + "LastName": "Alpaca", + "RowGuid": "85d3505e-10ac-4956-8859-0c01dd3dcc94", + "Salary": 10.3 + } + ], + "result": true +} +``` diff --git a/docs/ru/md/MSSQL/Common-methods/Generate-connection-string.mdx b/docs/ru/md/MSSQL/Common-methods/Generate-connection-string.mdx new file mode 100644 index 0000000000..f02a9ebd8f --- /dev/null +++ b/docs/ru/md/MSSQL/Common-methods/Generate-connection-string.mdx @@ -0,0 +1,52 @@ +--- +sidebar_position: 5 +description: Сформировать строку подключения и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Сформировать строку подключения + Формирует строку подключения из переданных данных + + + +`Функция СформироватьСтрокуПодключения(Знач Адрес, Знач База = "", Знач Логин = "", Знач Пароль = "", Знач Порт = "", Знач АутентификацияWindows = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Адрес | --addr | Строка | ✔ | Адрес и экземпляр сервера СУБД | + | База | --db | Строка | ✖ | Имя базы данных для подключения | + | Логин | --login | Строка | ✖ | Логин пользователя mssql | + | Пароль | --pass | Строка | ✖ | Пароль пользователя mssql | + | Порт | --port | Число | ✖ | Порт сервера | + | АутентификацияWindows | --trust | Булево | ✖ | Использовать аутентификацию Windows. Логин и пароль будут проигнорированы | + + + Возвращаемое значение: Строка - Строка подключения к базе MSSQL + +
+ +:::tip +Данная функция позволяет быстро собрать базовую строку подключения. В случае необходимости более гибкой настройки, вы также можете сформировать (получить) данную строку самостоятельно (формат ADO) +::: +
+ + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + Адрес = "127.0.0.1"; + Логин = "bayselonarrend"; + Пароль = "12we..."; + База = ""; + + Результат = OPI_MSSQL.СформироватьСтрокуПодключения(Адрес, База, Логин, Пароль); +``` + + + + +```json title="Результат" +"Server=127.0.0.1;User Id=bayselonarrend;Password=***;" +``` diff --git a/docs/ru/md/MSSQL/Common-methods/Get-tls-settings.mdx b/docs/ru/md/MSSQL/Common-methods/Get-tls-settings.mdx new file mode 100644 index 0000000000..31201f9150 --- /dev/null +++ b/docs/ru/md/MSSQL/Common-methods/Get-tls-settings.mdx @@ -0,0 +1,50 @@ +--- +sidebar_position: 6 +description: Получить настройки TLS и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Получить настройки TLS + Формирует настройки для использования TLS при выполнении запросов + + + +`Функция ПолучитьНастройкиTls(Знач ОтключитьПроверкуСертификатов, Знач ПутьКСертификату = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | ОтключитьПроверкуСертификатов | --trust | Булево | ✔ | Позволяет работать с некорретными сертификатами, в т.ч. самоподписанными | + | ПутьКСертификату | --cert | Строка | ✖ | Путь к корневому PEM файлу сертификата, если его нет в системном хранилище | + + + Возвращаемое значение: Структура Из КлючИЗначение - Структура настроек TLS соединения + +
+ +:::tip +Настройки Tls могут быть установлены только в момент создания соединения: явного, при использовании функции `ОткрытьСоединение` или неявного, при передаче строки подключения в методы ORM. + +Передача настроек Tls совместно с передачей уже созданного соединения в параметр `Соединение` будет проигнорирована + +Настройки Tls могут быть также переданы в строке подключения +::: +
+ + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + Результат = OPI_MSSQL.ПолучитьНастройкиTls(Истина); +``` + + + + +```json title="Результат" +{ + "use_tls": true, + "accept_invalid_certs": true +} +``` diff --git a/docs/ru/md/MSSQL/Common-methods/Is-connector.mdx b/docs/ru/md/MSSQL/Common-methods/Is-connector.mdx new file mode 100644 index 0000000000..4577c3508f --- /dev/null +++ b/docs/ru/md/MSSQL/Common-methods/Is-connector.mdx @@ -0,0 +1,53 @@ +--- +sidebar_position: 3 +description: Это коннектор и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Это коннектор + Проверяет, что значение является объектом внешней компоненты MSSQL + + + +`Функция ЭтоКоннектор(Знач Значение) Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Значение | - | Произвольный | ✔ | Значение для проверки | + + + Возвращаемое значение: Булево - Это коннектор + +
+ + +:::caution +**NOCLI:** данный метод недоступен для использования в CLI версии +::: +
+ + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + Адрес = "127.0.0.1"; + Логин = "SA"; + Пароль = "12we..."; + + СтрокаПодключения = OPI_MSSQL.СформироватьСтрокуПодключения(Адрес, , Логин, Пароль); + НастройкиTLS = OPI_MSSQL.ПолучитьНастройкиTls(Истина); + + Соединение = OPI_MSSQL.ОткрытьСоединение(СтрокаПодключения, НастройкиTLS); + Результат = OPI_MSSQL.ЭтоКоннектор(Соединение); + + OPI_MSSQL.ЗакрытьСоединение(Результат); +``` + + + + +```json title="Результат" +false +``` diff --git a/docs/ru/md/MSSQL/Common-methods/_category_.json b/docs/ru/md/MSSQL/Common-methods/_category_.json new file mode 100644 index 0000000000..7eabf78735 --- /dev/null +++ b/docs/ru/md/MSSQL/Common-methods/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "Основные методы", +"position": "2" +} \ No newline at end of file diff --git a/docs/ru/md/MSSQL/Orm/Add-records.mdx b/docs/ru/md/MSSQL/Orm/Add-records.mdx new file mode 100644 index 0000000000..0be99e64c3 --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Add-records.mdx @@ -0,0 +1,108 @@ +--- +sidebar_position: 10 +description: Добавить записи и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Добавить записи + Добавляет записи в таблицу + + + +`Функция ДобавитьЗаписи(Знач Таблица, Знач МассивДанных, Знач Транзакция = Истина, Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Таблица | --table | Строка | ✔ | Имя таблицы | + | МассивДанных | --rows | Массив Из Структура | ✔ | Массив структур данных строк: Ключ > поле, Значение > значение поля | + | Транзакция | --trn | Булево | ✖ | Истина > добавление записей в транзакции с откатом при ошибке | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ +:::tip +Данные записей указываются как массив структур вида:
`{'Имя поля 1': {'Тип данных': 'Значение'}, 'Имя поля 2': {'Тип данных': 'Значение'},...}` + +Список доступных типов описан на начальной странице документации библиотеки MSSQL +::: +
+ + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + Адрес = "127.0.0.1"; + Логин = "SA"; + Пароль = "12we..."; + База = "testbase1"; + + НастройкиTLS = OPI_MSSQL.ПолучитьНастройкиTls(Истина); + СтрокаПодключения = OPI_MSSQL.СформироватьСтрокуПодключения(Адрес, База, Логин, Пароль); + + Таблица = "testtable"; + МассивЗаписей = Новый Массив; + + Картинка = "https://hut.openintegrations.dev/test_data/picture.jpg"; + OPI_ПреобразованиеТипов.ПолучитьДвоичныеДанные(Картинка); // Картинка - Тип: ДвоичныеДанные + + XML = " + | + | + | Пример + | 123 + | + | + | Тест + | 456 + | + |"; + + ТекущаяДата = OPI_Инструменты.ПолучитьТекущуюДату(); + ТекущаяДатаЧП = OPI_Инструменты.ДатаRFC3339(ТекущаяДата, "+05:00"); + + СтруктураЗаписи = Новый Структура; + СтруктураЗаписи.Вставить("tinyint_field" , Новый Структура("TINYINT" , 5)); + СтруктураЗаписи.Вставить("smallint_field" , Новый Структура("SMALLINT" , 2000)); + СтруктураЗаписи.Вставить("int_field" , Новый Структура("INT" , 200000)); + СтруктураЗаписи.Вставить("bigint_field" , Новый Структура("BIGINT" , 20000000000)); + СтруктураЗаписи.Вставить("float24_field" , Новый Структура("FLOAT24" , 10.1234567)); + СтруктураЗаписи.Вставить("float53_field" , Новый Структура("FLOAT53" , 10.123456789123456)); + СтруктураЗаписи.Вставить("bit_field" , Новый Структура("BIT" , Истина)); + СтруктураЗаписи.Вставить("nvarchar_field" , Новый Структура("NVARCHAR" , "Some text")); + СтруктураЗаписи.Вставить("varbinary_field", Новый Структура("BYTES" , Картинка)); + СтруктураЗаписи.Вставить("uid_field" , Новый Структура("UUID" , Новый УникальныйИдентификатор)); + СтруктураЗаписи.Вставить("numeric_field" , Новый Структура("NUMERIC" , 5.333)); + СтруктураЗаписи.Вставить("xml_field" , Новый Структура("XML" , XML)); + СтруктураЗаписи.Вставить("date_field" , Новый Структура("DATE" , ТекущаяДата)); + СтруктураЗаписи.Вставить("time_field" , Новый Структура("TIME" , ТекущаяДата)); + СтруктураЗаписи.Вставить("dto_field" , Новый Структура("DATETIMEOFFSET", ТекущаяДатаЧП)); + СтруктураЗаписи.Вставить("datetime_field" , Новый Структура("DATETIME" , ТекущаяДата)); + + МассивЗаписей.Добавить(СтруктураЗаписи); + + // При использовании строки подключения инициализируется новое соединение, + // которое будет закрыто после выполнения функции. + // В случае выполнения нескольких операций желательно использовать одно соединение, + // заранее созданное функцией ОткрытьСоединение() + Результат = OPI_MSSQL.ДобавитьЗаписи(Таблица, МассивЗаписей, Истина, СтрокаПодключения, НастройкиTLS); +``` + + + + +```json title="Результат" +{ + "commit": { + "result": true + }, + "result": true, + "rows": 1, + "errors": [] +} +``` diff --git a/docs/ru/md/MSSQL/Orm/Add-table-column.mdx b/docs/ru/md/MSSQL/Orm/Add-table-column.mdx new file mode 100644 index 0000000000..51844a5307 --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Add-table-column.mdx @@ -0,0 +1,40 @@ +--- +sidebar_position: 4 +description: Добавить колонку таблицы и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Добавить колонку таблицы + Добавляет новую колонку в существующую таблицу + + + +`Функция ДобавитьКолонкуТаблицы(Знач Таблица, Знач Имя, Знач ТипДанных, Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Таблица | --table | Строка | ✔ | Имя таблицы | + | Имя | --name | Строка | ✔ | Имя колонки | + | ТипДанных | --type | Строка | ✔ | Тип данных колонки | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ + + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + +``` + + + + + diff --git a/docs/ru/md/MSSQL/Orm/Clear-table.mdx b/docs/ru/md/MSSQL/Orm/Clear-table.mdx new file mode 100644 index 0000000000..8832676d29 --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Clear-table.mdx @@ -0,0 +1,38 @@ +--- +sidebar_position: 7 +description: Очистить таблицу и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Очистить таблицу + Очищает таблицу базы + + + +`Функция ОчиститьТаблицу(Знач Таблица, Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Таблица | --table | Строка | ✔ | Имя таблицы | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ + + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + +``` + + + + + diff --git a/docs/ru/md/MSSQL/Orm/Create-database.mdx b/docs/ru/md/MSSQL/Orm/Create-database.mdx new file mode 100644 index 0000000000..e8cdbbe9a5 --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Create-database.mdx @@ -0,0 +1,55 @@ +--- +sidebar_position: 1 +description: Создать базу данных и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Создать базу данных + Создает базу данных с указанным именем + + + +`Функция СоздатьБазуДанных(Знач База, Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | База | --base | Строка | ✔ | Имя базы | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ + + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + Адрес = "127.0.0.1"; + Логин = "SA"; + Пароль = "12we..."; + + НастройкиTLS = OPI_MSSQL.ПолучитьНастройкиTls(Истина); + СтрокаПодключения = OPI_MSSQL.СформироватьСтрокуПодключения(Адрес, , Логин, Пароль); + + База = "testbase1"; + + // При использовании строки подключения инициализируется новое соединение, + // которое будет закрыто после выполнения функции. + // В случае выполнения нескольких операций желательно использовать одно соединение, + // заранее созданное функцией ОткрытьСоединение() + Результат = OPI_MSSQL.СоздатьБазуДанных(База, СтрокаПодключения, НастройкиTLS); +``` + + + + +```json title="Результат" +{ + "result": true +} +``` diff --git a/docs/ru/md/MSSQL/Orm/Create-table.mdx b/docs/ru/md/MSSQL/Orm/Create-table.mdx new file mode 100644 index 0000000000..932f45df3f --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Create-table.mdx @@ -0,0 +1,79 @@ +--- +sidebar_position: 3 +description: Создать таблицу и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Создать таблицу + Создает пустую таблицу в базе + + + +`Функция СоздатьТаблицу(Знач Таблица, Знач СтруктураКолонок, Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Таблица | --table | Строка | ✔ | Имя таблицы | + | СтруктураКолонок | --cols | Структура Из КлючИЗначение | ✔ | Структура колонок: Ключ > имя, Значение > Тип данных | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ +:::tip +Список доступных типов описан на начальной странице документации библиотеки MSSQL +::: +
+ + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + Адрес = "127.0.0.1"; + Логин = "SA"; + Пароль = "12we..."; + База = "testbase1"; + + НастройкиTLS = OPI_MSSQL.ПолучитьНастройкиTls(Истина); + СтрокаПодключения = OPI_MSSQL.СформироватьСтрокуПодключения(Адрес, База, Логин, Пароль); + + Таблица = "testtable"; + + СтруктураКолонок = Новый Структура; + СтруктураКолонок.Вставить("tinyint_field" , "tinyint"); + СтруктураКолонок.Вставить("smallint_field" , "smallint"); + СтруктураКолонок.Вставить("int_field" , "int"); + СтруктураКолонок.Вставить("bigint_field" , "bigint"); + СтруктураКолонок.Вставить("float24_field" , "float(24)"); + СтруктураКолонок.Вставить("float53_field" , "float(53)"); + СтруктураКолонок.Вставить("bit_field" , "bit"); + СтруктураКолонок.Вставить("nvarchar_field" , "nvarchar(4000)"); + СтруктураКолонок.Вставить("varbinary_field", "varbinary(max)"); + СтруктураКолонок.Вставить("uid_field" , "uniqueidentifier"); + СтруктураКолонок.Вставить("numeric_field" , "numeric(5,3)"); // Или decimal + СтруктураКолонок.Вставить("xml_field" , "xml"); + СтруктураКолонок.Вставить("date_field" , "date"); + СтруктураКолонок.Вставить("time_field" , "time"); + СтруктураКолонок.Вставить("dto_field" , "datetimeoffset"); + СтруктураКолонок.Вставить("datetime_field" , "datetime"); + + // При использовании строки подключения инициализируется новое соединение, + // которое будет закрыто после выполнения функции. + // В случае выполнения нескольких операций желательно использовать одно соединение, + // заранее созданное функцией ОткрытьСоединение() + Результат = OPI_MSSQL.СоздатьТаблицу(Таблица, СтруктураКолонок, СтрокаПодключения, НастройкиTLS); +``` + + + + +```json title="Результат" +{ + "result": true +} +``` diff --git a/docs/ru/md/MSSQL/Orm/Delete-database.mdx b/docs/ru/md/MSSQL/Orm/Delete-database.mdx new file mode 100644 index 0000000000..8abc1704a2 --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Delete-database.mdx @@ -0,0 +1,38 @@ +--- +sidebar_position: 2 +description: Удалить базу данных и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Удалить базу данных + Удаляет базу данных + + + +`Функция УдалитьБазуДанных(Знач База, Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | База | --base | Строка | ✔ | Имя базы | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ + + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + +``` + + + + + diff --git a/docs/ru/md/MSSQL/Orm/Delete-records.mdx b/docs/ru/md/MSSQL/Orm/Delete-records.mdx new file mode 100644 index 0000000000..17b3910eb0 --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Delete-records.mdx @@ -0,0 +1,39 @@ +--- +sidebar_position: 13 +description: Удалить записи и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Удалить записи + Удаляет записи из таблицы + + + +`Функция УдалитьЗаписи(Знач Таблица, Знач Фильтры = "", Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Таблица | --table | Строка | ✔ | Имя таблицы | + | Фильтры | --filter | Массив Из Структура | ✖ | Массив фильтров. См. ПолучитьСтруктуруФильтраЗаписей | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ + + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + +``` + + + + + diff --git a/docs/ru/md/MSSQL/Orm/Delete-table-column.mdx b/docs/ru/md/MSSQL/Orm/Delete-table-column.mdx new file mode 100644 index 0000000000..4c376bf5ee --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Delete-table-column.mdx @@ -0,0 +1,39 @@ +--- +sidebar_position: 5 +description: Удалить колонку таблицы и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Удалить колонку таблицы + Удаляет колонку из таблицы + + + +`Функция УдалитьКолонкуТаблицы(Знач Таблица, Знач Имя, Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Таблица | --table | Строка | ✔ | Имя таблицы | + | Имя | --name | Строка | ✔ | Имя колонки | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ + + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + +``` + + + + + diff --git a/docs/ru/md/MSSQL/Orm/Delete-table.mdx b/docs/ru/md/MSSQL/Orm/Delete-table.mdx new file mode 100644 index 0000000000..0b953f1625 --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Delete-table.mdx @@ -0,0 +1,38 @@ +--- +sidebar_position: 8 +description: Удалить таблицу и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Удалить таблицу + Удаляет таблицу из базы + + + +`Функция УдалитьТаблицу(Знач Таблица, Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Таблица | --table | Строка | ✔ | Имя таблицы | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ + + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + +``` + + + + + diff --git a/docs/ru/md/MSSQL/Orm/Ensure-table.mdx b/docs/ru/md/MSSQL/Orm/Ensure-table.mdx new file mode 100644 index 0000000000..65ff46ced0 --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Ensure-table.mdx @@ -0,0 +1,45 @@ +--- +sidebar_position: 6 +description: Гарантировать таблицу и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Гарантировать таблицу + Создает новую таблицу в случае отсутствия или обновляет состав колонок существующей таблицы + + + +`Функция ГарантироватьТаблицу(Знач Таблица, Знач СтруктураКолонок, Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Таблица | --table | Строка | ✔ | Имя таблицы | + | СтруктураКолонок | --cols | Структура Из КлючИЗначение | ✔ | Структура колонок: Ключ > имя, Значение > Тип данных | + | Соединение | --dbc | Строка, Произвольный | ✖ | Существующее соединение или путь к базе | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ +:::tip +В результате изменения структуры таблицы данные могут быть утеряны! Рекомендуется предварительно опробовать данный метод на тестовых данных + +Данная функция не обновляет тип данных существующих колонок +::: +
+ + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + +``` + + + + + diff --git a/docs/ru/md/MSSQL/Orm/Get-records-filter-strucutre.mdx b/docs/ru/md/MSSQL/Orm/Get-records-filter-strucutre.mdx new file mode 100644 index 0000000000..246e919f4e --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Get-records-filter-strucutre.mdx @@ -0,0 +1,40 @@ +--- +sidebar_position: 14 +description: Получить структуру фильтра записей и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Получить структуру фильтра записей + Получает структуру шаблон для фильтрации записей в запросах ORM + + + +`Функция ПолучитьСтруктуруФильтраЗаписей(Знач Пустая = Ложь) Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Пустая | --empty | Булево | ✖ | Истина > структура с пустыми значениями, Ложь > в значениях будут описания полей | + + + Возвращаемое значение: Структура Из КлючИЗначение - Элемент фильтра записей + +
+ +:::tip +Использование признака `raw` необходимо для составных конструкций, вроде `BEETWEEN`. Например: при `raw:false` фильтр `type:BETWEEN` `value:10 AND 20` будет интерпритирован как `BETWEEN ?1 ` где `?1 = "10 AND 20"`, что приведет к ошибке. В таком случае необходимо использовать `raw:true` для установки условия напрямую в текст запроса +::: +
+ + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + +``` + + + + + diff --git a/docs/ru/md/MSSQL/Orm/Get-records.mdx b/docs/ru/md/MSSQL/Orm/Get-records.mdx new file mode 100644 index 0000000000..277e49f77e --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Get-records.mdx @@ -0,0 +1,120 @@ +--- +sidebar_position: 11 +description: Получить записи и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Получить записи + Получает записи из выбранной таблицы + + + +`Функция ПолучитьЗаписи(Знач Таблица, Знач Поля = "*", Знач Фильтры = "", Знач Сортировка = "", Знач Количество = "", Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Таблица | --table | Строка | ✔ | Имя таблицы | + | Поля | --fields | Массив Из Строка | ✖ | Поля для выборки | + | Фильтры | --filter | Массив Из Структура | ✖ | Массив фильтров. См. ПолучитьСтруктуруФильтраЗаписей | + | Сортировка | --order | Структура Из КлючИЗначение | ✖ | Сортировка: Ключ > поле, Значение > направление (ASC, DESC) | + | Количество | --limit | Число | ✖ | Ограничение количества получаемых строк | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ + + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + Адрес = "127.0.0.1"; + Логин = "SA"; + Пароль = "12we..."; + База = "testbase1"; + + НастройкиTLS = OPI_MSSQL.ПолучитьНастройкиTls(Истина); + СтрокаПодключения = OPI_MSSQL.СформироватьСтрокуПодключения(Адрес, База, Логин, Пароль); + + // Все записи без отборов + + Таблица = "testtable"; + + // При использовании строки подключения инициализируется новое соединение, + // которое будет закрыто после выполнения функции. + // В случае выполнения нескольких операций желательно использовать одно соединение, + // заранее созданное функцией ОткрытьСоединение() + Результат = OPI_MSSQL.ПолучитьЗаписи(Таблица, , , , , СтрокаПодключения, НастройкиTLS); + + // Отборы, выбранные поля, количество и сортировка + + СтрокаПодключения = OPI_MSSQL.СформироватьСтрокуПодключения(Адрес, "test_data", Логин, Пароль); + + Таблица = "test_data"; + + Поля = Новый Массив; + Поля.Добавить("first_name"); + Поля.Добавить("last_name"); + Поля.Добавить("email"); + + Фильтры = Новый Массив; + + СтруктураФильтра1 = Новый Структура; + + СтруктураФильтра1.Вставить("field", "gender"); + СтруктураФильтра1.Вставить("type" , "="); + СтруктураФильтра1.Вставить("value", "Male"); + СтруктураФильтра1.Вставить("union", "AND"); + СтруктураФильтра1.Вставить("raw" , Ложь); + + СтруктураФильтра2 = Новый Структура; + + СтруктураФильтра2.Вставить("field", "id"); + СтруктураФильтра2.Вставить("type" , "BETWEEN"); + СтруктураФильтра2.Вставить("value", "20 AND 50"); + СтруктураФильтра2.Вставить("raw" , Истина); + + Фильтры.Добавить(СтруктураФильтра1); + Фильтры.Добавить(СтруктураФильтра2); + + Сортировка = Новый Структура("ip_address", "DESC"); + Количество = 5; + + Результат = OPI_MSSQL.ПолучитьЗаписи(Таблица, Поля, Фильтры, Сортировка, Количество, СтрокаПодключения, НастройкиTLS); +``` + + + + +```json title="Результат" +{ + "data": [ + { + "bigint_field": 20000000000, + "bit_field": 0, + "date_field": "2025-07-09", + "datetime_field": "2025-07-09T19:33:52", + "dto_field": "2025-07-09T09:33:52.062438400+00:00", + "float24_field": 10.1234569549561, + "float53_field": 10.1234567891235, + "int_field": 200000, + "numeric_field": 5.333, + "nvarchar_field": "Some text", + "smallint_field": 2000, + "time_field": "19:33:52", + "tinyint_field": 5, + "uid_field": "25216af9-4b56-4efd-aff2-7608d10c4ff7", + "varbinary_field": { + "BYTES": "/9j/4VTBRX..." + }, + "xml_field": "Пример123Тест456" + } + ], + "result": true +} +``` diff --git a/docs/ru/md/MSSQL/Orm/Get-table-information.mdx b/docs/ru/md/MSSQL/Orm/Get-table-information.mdx new file mode 100644 index 0000000000..065f4881dd --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Get-table-information.mdx @@ -0,0 +1,38 @@ +--- +sidebar_position: 9 +description: Получить информацию о таблице и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Получить информацию о таблице + Получает информацию о таблице + + + +`Функция ПолучитьИнформациюОТаблице(Знач Таблица, Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Таблица | --table | Строка | ✔ | Имя таблицы | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ + + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + +``` + + + + + diff --git a/docs/ru/md/MSSQL/Orm/Update-records.mdx b/docs/ru/md/MSSQL/Orm/Update-records.mdx new file mode 100644 index 0000000000..c206588bcb --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/Update-records.mdx @@ -0,0 +1,46 @@ +--- +sidebar_position: 12 +description: Обновить записи и другие функции для работы с MS SQL в Открытом пакете интеграций - бесплатной open-source библиотеке интеграций для 1С:Предприятие 8, OneScript и CLI +keywords: [1C, 1С, 1С:Предприятие, 1С:Предприятие 8.3, API, Интеграция, Сервисы, Обмен, OneScript, CLI, MS SQL] +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Обновить записи + Обновляет значение записей по выбранным критериям + + + +`Функция ОбновитьЗаписи(Знач Таблица, Знач СтруктураЗначений, Знач Фильтры = "", Знач Соединение = "", Знач Tls = "") Экспорт` + + | Параметр | CLI опция | Тип | Обяз. | Назначение | + |-|-|-|-|-| + | Таблица | --table | Строка | ✔ | Имя таблицы | + | СтруктураЗначений | --values | Структура Из КлючИЗначение | ✔ | Структура значений: Ключ > поле, Значение > значение поля | + | Фильтры | --filter | Массив Из Структура | ✖ | Массив фильтров. См. ПолучитьСтруктуруФильтраЗаписей | + | Соединение | --dbc | Строка, Произвольный | ✖ | Соединение или строка подключения | + | Tls | --tls | Структура Из КлючИЗначение | ✖ | Настройки TLS, если необходимо. См. ПолучитьНастройкиTls | + + + Возвращаемое значение: Соответствие Из КлючИЗначение - Результат выполнения запроса + +
+ +:::tip +Данные записей указываются как массив структур вида:
`{'Имя поля 1': {'Тип данных': 'Значение'}, 'Имя поля 2': {'Тип данных': 'Значение'},...}` + +Список доступных типов описан на начальной странице документации библиотеки MSSQL +::: +
+ + + +```bsl title="Пример использования для 1С:Предприятие/OneScript" + +``` + + + + + diff --git a/docs/ru/md/MSSQL/Orm/_category_.json b/docs/ru/md/MSSQL/Orm/_category_.json new file mode 100644 index 0000000000..e10609d962 --- /dev/null +++ b/docs/ru/md/MSSQL/Orm/_category_.json @@ -0,0 +1,4 @@ +{ +"label": "ORM", +"position": "3" +} \ No newline at end of file