OpenIntegrations/docs/en/md/Instructions/MSSQL.md

id, sidebar_class_name

id	sidebar_class_name
MSSQL	MSSQL

<img src={require('../../static/img/APIs/MSSQL.png').default} width='64px' />

MSSQL

This section covers the library for working with MS SQL Server in 1С:Enterprise, OneScript, and CLI. This page describes all the steps required to get started.

<img src={require('../../static/img/addin.png').default} class="tipimage" />

An external component is used to implement some functions in this library
Please review the ["About external components"](/docs/Start/Component-requirements) section before getting started

<img src={require('../../static/img/lock.png').default} class="tipimage" />

This library requires **OpenSSL 3.x** to run on Linux
Learn more: "Using OpenSSL in External Components"

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 MSSQL 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 MSSQL type list lists only a few suitable types

Имя типа (ключ структуры)	Тип значения 1С	Подходит для типов MSSQL
TINYINT	Number	tinyint
SMALLINT	Number	smallint
INT	Number	int
BIGINT	Number	bigint
FLOAT24	Number	float(24), real
FLOAT53	Number	float(53)
NUMERIC	Number	decimal, numeric
DECIMAL	Number	decimal, numeric
BIT	Bool	bit
NVARCHAR	String	nvarchar, varchar, nchar, char, ntext, text
UUID	String, UUID	uniqueidentifier
XML	String	xml
DATE	Date, String	date
TIME	Date, String	time
DATETIME	Date, String	datetime, datetime2
DATETIMEOFFSET	Date, String	datetimeoffset
BYTES	BinaryData	varbinary

Retrieving Binary Data

Binary data retrieved from the database will be represented as an object (structure) of the form {"BYTES": "Base64 string"} and must be manually converted from Base64

TLS

The library supports operation in TLS mode. To enable it, you need to configure TLS settings using the GetTlsSettings function and pass them as the corresponding parameter to the CreateConnection function or one of the ORM functions that support this parameter. If the TLS parameter is not provided when calling these functions, the connection will be initialized in an unsecured mode.

:::tip TLS settings can only be applied when the connection is established — either explicitly when using the CreateConnection function or implicitly when passing a connection string to ORM methods. Providing TLS settings along with an already established connection (passed via the Connection parameter) will be ignored. :::