1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-11-27 22:18:36 +02:00
Files
OpenIntegrations/docs/en/md/PostgreSQL/Orm/Get-table-information.mdx

235 lines
6.0 KiB
Plaintext
Raw Normal View History

2025-02-11 08:47:01 +03:00
---
2025-02-14 23:21:49 +03:00
sidebar_position: 4
2025-05-05 11:15:20 +03:00
description: Get table information and other functions to work with PostgreSQL in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
2025-05-05 09:49:19 +03:00
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, PostgreSQL]
2025-02-11 08:47:01 +03:00
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
2025-02-12 19:33:53 +03:00
# Get table information
Gets information about the table
2025-02-11 08:47:01 +03:00
2025-03-11 21:09:03 +03:00
`Function GetTableInformation(Val Table, Val Connection = "", Val Tls = "") Export`
2025-02-11 08:47:01 +03:00
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
2025-02-12 19:33:53 +03:00
| Table | --table | String | ✔ | Table name |
2025-02-11 08:47:01 +03:00
| Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string |
2025-03-11 21:09:03 +03:00
| Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings |
2025-02-11 08:47:01 +03:00
2025-02-17 17:16:27 +03:00
Returns: Map Of KeyAndValue - Result of query execution
2025-02-11 08:47:01 +03:00
<br/>
```bsl title="1C:Enterprise/OneScript code example"
2025-06-29 14:35:33 +03:00
Address = "127.0.0.1";
2025-02-11 08:47:01 +03:00
Login = "bayselonarrend";
2025-06-29 14:35:33 +03:00
Password = "12we...";
2025-02-12 19:33:53 +03:00
Base = "testbase1";
2025-02-11 08:47:01 +03:00
2025-09-01 14:51:24 +03:00
TLS = True;
Port = 5432;
ConnectionString = OPI_PostgreSQL.GenerateConnectionString(Address, Base, Login, Password, Port);
If TLS Then
TLSSettings = OPI_PostgreSQL.GetTLSSettings(True);
Else
TLSSettings = Undefined;
EndIf;
2025-02-11 08:47:01 +03:00
2025-02-12 19:33:53 +03:00
Table = "testtable";
2025-02-11 08:47:01 +03:00
2025-02-15 22:58:22 +03:00
// When using the connection string, a new connection is initialised,
// which will be closed after the function is executed.
// If several operations are performed, it is desirable to use one connection,
// previously created by the CreateConnection function()
2025-09-01 14:51:24 +03:00
Result = OPI_PostgreSQL.GetTableInformation(Table, ConnectionString, TLSSettings);
2025-02-11 08:47:01 +03:00
```
2025-02-18 14:08:09 +03:00
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
2025-10-07 19:27:04 +03:00
# JSON data can also be passed as a path to a .json file
2025-02-18 14:08:09 +03:00
oint postgres GetTableInformation \
2025-10-07 19:27:04 +03:00
--table "test_new" \
2025-09-16 09:07:33 +03:00
--dbc "postgresql://bayselonarrend:***@127.0.0.1:5432/" \
2025-10-07 19:27:04 +03:00
--tls "{'use_tls':true,'accept_invalid_certs':true}"
2025-02-18 14:08:09 +03:00
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
2025-10-07 19:27:04 +03:00
:: JSON data can also be passed as a path to a .json file
2025-02-18 14:08:09 +03:00
oint postgres GetTableInformation ^
2025-10-07 19:27:04 +03:00
--table "test_new" ^
2025-09-16 09:07:33 +03:00
--dbc "postgresql://bayselonarrend:***@127.0.0.1:5432/" ^
2025-10-07 19:27:04 +03:00
--tls "{'use_tls':true,'accept_invalid_certs':true}"
2025-02-18 14:08:09 +03:00
```
</TabItem>
</Tabs>
2025-06-17 16:20:59 +03:00
```json title="Result"
{
"data": [
{
"character_maximum_length": null,
"column_default": null,
"column_name": "bool_field",
"data_type": "boolean",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "oldchar_field",
"data_type": "\"char\"",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "smallint_field",
"data_type": "smallint",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": "nextval('testtable_smallserial_field_seq'::regclass)",
"column_name": "smallserial_field",
"data_type": "smallint",
"is_nullable": "NO"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "int_field",
"data_type": "integer",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": "nextval('testtable_serial_field_seq'::regclass)",
"column_name": "serial_field",
"data_type": "integer",
"is_nullable": "NO"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "oid_field",
"data_type": "oid",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "bigint_field",
"data_type": "bigint",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": "nextval('testtable_bigserial_field_seq'::regclass)",
"column_name": "bigserial_field",
"data_type": "bigint",
"is_nullable": "NO"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "real_field",
"data_type": "real",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "dp_field",
"data_type": "double precision",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "json_field",
"data_type": "json",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "jsonb_field",
"data_type": "jsonb",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "date_field",
"data_type": "date",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "time_field",
"data_type": "time without time zone",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "uuid_field",
"data_type": "uuid",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "bytea_field",
"data_type": "bytea",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "ts_field",
"data_type": "timestamp without time zone",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "tswtz_field",
"data_type": "timestamp with time zone",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "ip_field",
"data_type": "inet",
"is_nullable": "YES"
},
{
"character_maximum_length": null,
"column_default": null,
"column_name": "text_field",
"data_type": "text",
"is_nullable": "YES"
},
{
...
```