1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2026-05-18 09:51:28 +02:00
Files
OpenIntegrations/docs/en/md/MSSQL/Common-methods/Generate-connection-string.mdx
T

88 lines
2.7 KiB
Plaintext
Vendored

---
sidebar_position: 5
description: Generate connection string and other functions to work with MSSQL 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, MSSQL]
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Admonition from '@theme/Admonition';
# Generate connection string
Forms a connection string from the passed data
<Tabs>
<TabItem value="params" label="Parameters" default>
`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 | &#x2714; | Database server address and instance |
| Base | --db | String | &#x2716; | Name of the database to connect |
| Login | --login | String | &#x2716; | mssql user login |
| Password | --pass | String | &#x2716; | mssql user password |
| Port | --port | Number | &#x2716; | Server port |
| WindowsAuth | --trust | Boolean | &#x2716; | Use Windows authentication. The login and password will be ignored |
<div className="return-value-note">
<div className="return-value-note__title">Returns</div>
<div className="return-value-note__value">
String - MSSQL connection string
</div>
</div>
</TabItem>
<TabItem value="extended" label={<span>Advanced call{' '}<a href="/docs/Start/Advanced-call" target="_blank" rel="noreferrer" title="About advanced call" onClick={(e) => e.stopPropagation()}>?</a></span>}>
*This method has no additional advanced call parameters.*
</TabItem>
</Tabs>
:::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)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
Address = "127.0.0.1";
Login = "bayselonarrend";
Password = "12we...";
Result = OPI_MSSQL.GenerateConnectionString(Address, , Login, Password);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint mssql GenerateConnectionString \
--addr "127.0.0.1" \
--login "SA" \
--pass "***"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint mssql GenerateConnectionString ^
--addr "127.0.0.1" ^
--login "SA" ^
--pass "***"
```
</TabItem>
</Tabs>
```json title="Result"
"Server=127.0.0.1;User Id=bayselonarrend;Password=\"***\";"
```