2024-12-29 17:57:09 +03:00
---
2025-01-03 15:55:52 +03:00
sidebar_position: 4
2024-12-29 17:57:09 +03:00
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Execute SQL query
Executes an arbitrary SQL query
2024-12-29 22:28:49 +03:00
`Function ExecuteSQLQuery(Val QueryText, Val Parameters = "", Val ForceResult = False, Val Connection = "") Export`
2024-12-29 17:57:09 +03:00
| 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 |
2024-12-29 22:28:49 +03:00
| Connection | --db | String, Arbitrary | ✖ | Existing connection or path to the base. In memory, if not filled |
2024-12-29 17:57:09 +03:00
Returns: Structure Of KeyAndValue - Result of query execution
<br/>
:::tip
2025-01-06 01:09:55 +03:00
Available parameter types: String, Number, Date, Boolean, BinaryData. Binary data can also be passed as a `{'blob':File path}` structure. Binary data (BLOB) values are returned as `{'blob':Base64 string}
2024-12-29 17:57:09 +03:00
2025-01-01 18:14:37 +03:00
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
2024-12-29 17:57:09 +03:00
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
2024-12-30 17:08:45 +03:00
TFN = GetTempFileName("sqlite");
2024-12-29 17:57:09 +03:00
2024-12-30 22:30:57 +03:00
Image = "https://api.athenaeum.digital/test_data/picture.jpg";
OPI_TypeConversion.GetBinaryData(Image); // Image - Type: BinaryData
2024-12-30 17:08:45 +03:00
Connection = OPI_SQLite.CreateConnection(TFN);
// CREATE
QueryText = "
|CREATE TABLE test_table (
|id INTEGER PRIMARY KEY,
|name TEXT,
|age INTEGER,
|salary REAL,
|is_active BOOLEAN,
|created_at DATETIME,
|data BLOB
|);";
Result = OPI_SQLite.ExecuteSQLQuery(QueryText, , , Connection);
// INSERT with parameters
QueryText = "
|INSERT INTO test_table (name, age, salary, is_active, created_at, data)
|VALUES (?1, ?2, ?3, ?4, ?5, ?6);";
ParameterArray = New Array;
ParameterArray.Add("Vitaly"); // TEXT
ParameterArray.Add(25); // INTEGER
ParameterArray.Add(1000.12); // REAL
ParameterArray.Add(True); // BOOL
ParameterArray.Add(OPI_Tools.GetCurrentDate()); // DATETIME
2024-12-30 22:30:57 +03:00
ParameterArray.Add(Image); // BLOB
2024-12-30 17:08:45 +03:00
Result = OPI_SQLite.ExecuteSQLQuery(QueryText, ParameterArray, , Connection);
// SELECT (The result of this query is shown in the Result block)
QueryText = "SELECT id, name, age, salary, is_active, created_at, data FROM test_table;";
Result = OPI_SQLite.ExecuteSQLQuery(QueryText, , , Connection);
// Transaction
QueryText = "BEGIN TRANSACTION;
| CREATE TABLE IF NOT EXISTS users (
| id INTEGER PRIMARY KEY AUTOINCREMENT,
| name TEXT NOT NULL,
| age INTEGER NOT NULL
| );
| INSERT INTO users (name, age) VALUES ('Alice', 30);
| INSERT INTO users (name, age) VALUES ('Bob', 25);
| INSERT INTO users (name, age) VALUES ('Charlie', 35);
| COMMIT;";
Result = OPI_SQLite.ExecuteSQLQuery(QueryText, , , Connection);
Closing = OPI_SQLite.CloseConnection(Connection);
2024-12-29 17:57:09 +03:00
```