OpenIntegrations/docs/en/md/PostgreSQL/Orm/Get-table-information.mdx

---
sidebar_position: 4
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Get table information
 Gets information about the table



`Function GetTableInformation(Val Table, Val Connection = "") Export`

  | Parameter | CLI option | Type | Required | Description |
  |-|-|-|-|-|
  | Table | --table | String | ✔ | Table name |
  | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string |

  
  Returns:  Map Of KeyAndValue - Result of query execution

<br/>




```bsl title="1C:Enterprise/OneScript code example"
    Address  = "127.0.0.1";
    Login    = "bayselonarrend";
    Password = "12we...";
    Base     = "testbase1";

    ConnectionString = OPI_PostgreSQL.GenerateConnectionString(Address, Base, Login, Password);

    Table = "testtable";

    // 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()
    Result = OPI_PostgreSQL.GetTableInformation(Table, ConnectionString);
```
 

 <Tabs>
  
    <TabItem value="bash" label="Bash" default>
        ```bash
            oint postgres GetTableInformation \
             --table "heyho" \
             --dbc "postgresql://bayselonarrend:***@127.0.0.1:5432/"
        ```
    </TabItem>
  
    <TabItem value="bat" label="CMD/Bat" default>
        ```batch
            oint postgres GetTableInformation ^
             --table "heyho" ^
             --dbc "postgresql://bayselonarrend:***@127.0.0.1:5432/"
        ```
    </TabItem>
</Tabs>


```json title="Result"
{
 "data": [
  {
   "character_maximum_length": null,
   "column_name": "bool_field",
   "data_type": "boolean"
  },
  {
   "character_maximum_length": null,
   "column_name": "oldchar_field",
   "data_type": "\"char\""
  },
  {
   "character_maximum_length": null,
   "column_name": "smallint_field",
   "data_type": "smallint"
  },
  {
   "character_maximum_length": null,
   "column_name": "smallserial_field",
   "data_type": "smallint"
  },
  {
   "character_maximum_length": null,
   "column_name": "int_field",
   "data_type": "integer"
  },
  {
   "character_maximum_length": null,
   "column_name": "serial_field",
   "data_type": "integer"
  },
  {
   "character_maximum_length": null,
   "column_name": "oid_field",
   "data_type": "oid"
  },
  {
   "character_maximum_length": null,
   "column_name": "bigint_field",
   "data_type": "bigint"
  },
  {
   "character_maximum_length": null,
   "column_name": "bigserial_field",
   "data_type": "bigint"
  },
  {
   "character_maximum_length": null,
   "column_name": "real_field",
   "data_type": "real"
  },
  {
   "character_maximum_length": null,
   "column_name": "dp_field",
   "data_type": "double precision"
  },
  {
   "character_maximum_length": null,
   "column_name": "json_field",
   "data_type": "json"
  },
  {
   "character_maximum_length": null,
   "column_name": "jsonb_field",
   "data_type": "jsonb"
  },
  {
   "character_maximum_length": null,
   "column_name": "date_field",
   "data_type": "date"
  },
  {
   "character_maximum_length": null,
   "column_name": "time_field",
   "data_type": "time without time zone"
  },
  {
   "character_maximum_length": null,
   "column_name": "uuid_field",
   "data_type": "uuid"
  },
  {
   "character_maximum_length": null,
   "column_name": "bytea_field",
   "data_type": "bytea"
  },
  {
   "character_maximum_length": null,
   "column_name": "ts_field",
   "data_type": "timestamp without time zone"
  },
  {
   "character_maximum_length": null,
   "column_name": "tswtz_field",
   "data_type": "timestamp with time zone"
  },
  {
   "character_maximum_length": null,
   "column_name": "ip_field",
   "data_type": "inet"
  },
  {
   "character_maximum_length": null,
   "column_name": "text_field",
   "data_type": "text"
  },
  {
   "character_maximum_length": null,
   "column_name": "varchar_field",
   "data_type": "character varying"
  },
  {
   "character_maximum_length": 3,
   "column_name": "charn_field",
   "data_type": "character"
  },
  {
   "character_maximum_length": 1,
   "column_name": "char_field",
   "data_type": "character"
  },
  {
   "character_maximum_length": null,
   "column_name": "name_field",
   "data_type": "name"
  }
 ],
 "result": true
}
```