1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-03-27 21:48:56 +02:00
OpenIntegrations/docs/en/md/SQLite/Orm/Get-records.mdx
Vitaly the Alpaca (bot) 02af8cc7d4 Main build (Jenkins)
2025-02-11 14:50:59 +03:00

102 lines
2.6 KiB
Plaintext
Vendored

---
sidebar_position: 4
---
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 = "") 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 | --db | String, Arbitrary | ✖ | Existing connection or database path |
Returns: Map Of KeyAndValue - Result of query execution
<br/>
:::tip
Values of the Binary data type (BLOB) are returned as `{'blob':Base64 string}`
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
Base = "C:\Users\Administrator\AppData\Local\Temp\v8_5571_2fd.sqlite";
Table = "test";
Fields = New Array;
Fields.Add("name");
Fields.Add("salary");
Filters = New Array;
FilterStructure1 = New Structure;
FilterStructure1.Insert("field", "name");
FilterStructure1.Insert("type" , "=");
FilterStructure1.Insert("value", "Vitaly");
FilterStructure1.Insert("union", "AND");
FilterStructure1.Insert("raw" , False);
FilterStructure2 = New Structure;
FilterStructure2.Insert("field", "age");
FilterStructure2.Insert("type" , "BETWEEN");
FilterStructure2.Insert("value", "20 AND 30");
FilterStructure2.Insert("raw" , True);
Filters.Add(FilterStructure1);
Filters.Add(FilterStructure2);
Sort = New Structure("created_at", "DESC");
Count = 1;
Result = OPI_SQLite.GetRecords(Table, Fields, Filters, Sort, Count, Base);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint sqlite GetRecords \
--table "test" \
--db "C:\Users\Administrator\AppData\Local\Temp\cfyaxf0knp1.sqlite"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint sqlite GetRecords ^
--table "test" ^
--db "C:\Users\Administrator\AppData\Local\Temp\cfyaxf0knp1.sqlite"
```
</TabItem>
</Tabs>
```json title="Result"
{
"data": [
{
"name": "Vitaly",
"salary": 1000.12
}
],
"result": true
}
```