You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-11-29 22:27:42 +02:00
Main build (Jenkins)
This commit is contained in:
41
docs/en/md/MS_SQL/Common-methods/Close-connection.mdx
vendored
Normal file
41
docs/en/md/MS_SQL/Common-methods/Close-connection.mdx
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
:::caution
|
||||
**NOCLI:** this method is not available in CLI version
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
42
docs/en/md/MS_SQL/Common-methods/Create-connection.mdx
vendored
Normal file
42
docs/en/md/MS_SQL/Common-methods/Create-connection.mdx
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
:::caution
|
||||
**NOCLI:** this method is not available in CLI version
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
46
docs/en/md/MS_SQL/Common-methods/Execute-sql-query.mdx
vendored
Normal file
46
docs/en/md/MS_SQL/Common-methods/Execute-sql-query.mdx
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
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
|
||||
|
||||
<br/>
|
||||
|
||||
:::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
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
44
docs/en/md/MS_SQL/Common-methods/Generate-connection-string.mdx
vendored
Normal file
44
docs/en/md/MS_SQL/Common-methods/Generate-connection-string.mdx
vendored
Normal file
@@ -0,0 +1,44 @@
|
||||
---
|
||||
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 WindowsAuth = False) Export`
|
||||
|
||||
| Parameter | CLI option | Type | Required | Description |
|
||||
|-|-|-|-|-|
|
||||
| Address | --addr | String | ✔ | Adress, instance, and port of the DBMS server |
|
||||
| Base | --db | String | ✖ | Name of the database to connect |
|
||||
| Login | --login | String | ✖ | mssql user login |
|
||||
| Password | --pass | String | ✖ | mssql user password |
|
||||
| WindowsAuth | --trust | Boolean | ✖ | Use Windows authentication. The login and password will be ignored |
|
||||
|
||||
|
||||
Returns: String - MSSQL connection string
|
||||
|
||||
<br/>
|
||||
|
||||
:::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
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
45
docs/en/md/MS_SQL/Common-methods/Get-tls-settings.mdx
vendored
Normal file
45
docs/en/md/MS_SQL/Common-methods/Get-tls-settings.mdx
vendored
Normal file
@@ -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
|
||||
|
||||
<br/>
|
||||
|
||||
:::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
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
41
docs/en/md/MS_SQL/Common-methods/Is-connector.mdx
vendored
Normal file
41
docs/en/md/MS_SQL/Common-methods/Is-connector.mdx
vendored
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
:::caution
|
||||
**NOCLI:** this method is not available in CLI version
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
4
docs/en/md/MS_SQL/Common-methods/_category_.json
vendored
Normal file
4
docs/en/md/MS_SQL/Common-methods/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Common methods",
|
||||
"position": "2"
|
||||
}
|
||||
46
docs/en/md/MS_SQL/Orm/Add-records.mdx
vendored
Normal file
46
docs/en/md/MS_SQL/Orm/Add-records.mdx
vendored
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
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
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Record data is specified as an array of structures of the following type:<br/>`{'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
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
40
docs/en/md/MS_SQL/Orm/Add-table-column.mdx
vendored
Normal file
40
docs/en/md/MS_SQL/Orm/Add-table-column.mdx
vendored
Normal file
@@ -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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
38
docs/en/md/MS_SQL/Orm/Clear-table.mdx
vendored
Normal file
38
docs/en/md/MS_SQL/Orm/Clear-table.mdx
vendored
Normal file
@@ -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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
38
docs/en/md/MS_SQL/Orm/Create-database.mdx
vendored
Normal file
38
docs/en/md/MS_SQL/Orm/Create-database.mdx
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
---
|
||||
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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
43
docs/en/md/MS_SQL/Orm/Create-table.mdx
vendored
Normal file
43
docs/en/md/MS_SQL/Orm/Create-table.mdx
vendored
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
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
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
List of available types is described on the initial page of the MSSQL library documentation
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
38
docs/en/md/MS_SQL/Orm/Delete-database.mdx
vendored
Normal file
38
docs/en/md/MS_SQL/Orm/Delete-database.mdx
vendored
Normal file
@@ -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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
39
docs/en/md/MS_SQL/Orm/Delete-records.mdx
vendored
Normal file
39
docs/en/md/MS_SQL/Orm/Delete-records.mdx
vendored
Normal file
@@ -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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
39
docs/en/md/MS_SQL/Orm/Delete-table-column.mdx
vendored
Normal file
39
docs/en/md/MS_SQL/Orm/Delete-table-column.mdx
vendored
Normal file
@@ -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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
38
docs/en/md/MS_SQL/Orm/Delete-table.mdx
vendored
Normal file
38
docs/en/md/MS_SQL/Orm/Delete-table.mdx
vendored
Normal file
@@ -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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
45
docs/en/md/MS_SQL/Orm/Ensure-table.mdx
vendored
Normal file
45
docs/en/md/MS_SQL/Orm/Ensure-table.mdx
vendored
Normal file
@@ -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
|
||||
|
||||
<br/>
|
||||
|
||||
:::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
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
42
docs/en/md/MS_SQL/Orm/Get-records-filter-strucutre.mdx
vendored
Normal file
42
docs/en/md/MS_SQL/Orm/Get-records-filter-strucutre.mdx
vendored
Normal file
@@ -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
|
||||
|
||||
<br/>
|
||||
|
||||
:::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
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
42
docs/en/md/MS_SQL/Orm/Get-records.mdx
vendored
Normal file
42
docs/en/md/MS_SQL/Orm/Get-records.mdx
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
38
docs/en/md/MS_SQL/Orm/Get-table-information.mdx
vendored
Normal file
38
docs/en/md/MS_SQL/Orm/Get-table-information.mdx
vendored
Normal file
@@ -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
|
||||
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
46
docs/en/md/MS_SQL/Orm/Update-records.mdx
vendored
Normal file
46
docs/en/md/MS_SQL/Orm/Update-records.mdx
vendored
Normal file
@@ -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
|
||||
|
||||
<br/>
|
||||
|
||||
:::tip
|
||||
Record data is specified as an array of structures of the following type:<br/>`{'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
|
||||
:::
|
||||
<br/>
|
||||
|
||||
|
||||
|
||||
```bsl title="1C:Enterprise/OneScript code example"
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
4
docs/en/md/MS_SQL/Orm/_category_.json
vendored
Normal file
4
docs/en/md/MS_SQL/Orm/_category_.json
vendored
Normal file
@@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "ORM",
|
||||
"position": "3"
|
||||
}
|
||||
Reference in New Issue
Block a user