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

---
sidebar_position: 9
description: Get table information and other functions to work with MySQL 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, MySQL]
---

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

# Get table information
 Gets information about the table



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

  | Parameter | CLI option | Type | Required | Description |
  |-|-|-|-|-|
  | Table | --table | String | ✔ | Table name |
  | Connection | --dbc | String, Arbitrary | ✖ | Connection or connection string |
  | Tls | --tls | Structure Of KeyAndValue | ✖ | TLS settings, if necessary. See GetTlsSettings |

  
  Returns:  Map Of KeyAndValue - Result of query execution

<br/>



```bsl title="1C:Enterprise/OneScript code example"
    Address  = FunctionParameters["PG_IP"];
    Login    = "bayselonarrend";
    Password = FunctionParameters["PG_Password"];
    Base     = "testbase1";

    TLS = True;
    Port = 3306;
    ConnectionString = OPI_MySQL.GenerateConnectionString(Address, Base, Login, Password, Port);

    If TLS Then
        TLSSettings = OPI_MySQL.GetTLSSettings(True);
    Else
        TLSSettings = Undefined;
    EndIf;

    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_MySQL.GetTableInformation(Table, ConnectionString, TLSSettings);
```
 

 <Tabs>
  
    <TabItem value="bash" label="Bash" default>
        ```bash
            # JSON data can also be passed as a path to a .json file
            
            oint mysql GetTableInformation \
             --table "test_new" \
             --dbc "mysql://bayselonarrend:***@127.0.0.1:3306/" \
             --tls "{'use_tls':true,'accept_invalid_certs':true}"
        ```
    </TabItem>
  
    <TabItem value="bat" label="CMD/Bat" default>
        ```batch
            :: JSON data can also be passed as a path to a .json file
            
            oint mysql GetTableInformation ^
             --table "test_new" ^
             --dbc "mysql://bayselonarrend:***@127.0.0.1:3306/" ^
             --tls "{'use_tls':true,'accept_invalid_certs':true}"
        ```
    </TabItem>
</Tabs>


```json title="Result"
{
 "data": [
  {
   "CHARACTER_MAXIMUM_LENGTH": 5,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "char_field",
   "DATA_TYPE": {
    "BYTES": "Y2hhcg=="
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": 255,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "varchar_field",
   "DATA_TYPE": {
    "BYTES": "dmFyY2hhcg=="
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": 255,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "tinytext_field",
   "DATA_TYPE": {
    "BYTES": "dGlueXRleHQ="
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": 65535,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "text_field",
   "DATA_TYPE": {
    "BYTES": "dGV4dA=="
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": 16777215,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "mediumtext_field",
   "DATA_TYPE": {
    "BYTES": "bWVkaXVtdGV4dA=="
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": 4294967295,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "longtext_field",
   "DATA_TYPE": {
    "BYTES": "bG9uZ3RleHQ="
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": null,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "tinyint_field",
   "DATA_TYPE": {
    "BYTES": "dGlueWludA=="
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": null,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "smallint_field",
   "DATA_TYPE": {
    "BYTES": "c21hbGxpbnQ="
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": null,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "mediumint_field",
   "DATA_TYPE": {
    "BYTES": "bWVkaXVtaW50"
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": null,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "int_field",
   "DATA_TYPE": {
    "BYTES": "aW50"
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": null,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "uint_field",
   "DATA_TYPE": {
    "BYTES": "aW50"
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": null,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "bigint_field",
   "DATA_TYPE": {
    "BYTES": "YmlnaW50"
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": null,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "float_field",
   "DATA_TYPE": {
    "BYTES": "ZmxvYXQ="
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": null,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "double_field",
   "DATA_TYPE": {
    "BYTES": "ZG91Ymxl"
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": null,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "date_field",
   "DATA_TYPE": {
    "BYTES": "ZGF0ZQ=="
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": null,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "time_field",
   "DATA_TYPE": {
    "BYTES": "dGltZQ=="
   },
   "IS_NULLABLE": "YES"
  },
  {
   "CHARACTER_MAXIMUM_LENGTH": null,
   "COLUMN_DEFAULT": null,
   "COLUMN_NAME": "datetime_field",
...
```