sqltableinfo

Retrieve database table metadata

Since R2025a

Syntax

tableInfo = sqltableinfo(dataSourceInfo,tablename)

Description

tableInfo = sqltableinfo(dataSourceInfo,tablename) returns database table metadata by using information about the data source in dataSourceInfo, which can either be a connection object or a data source name.

Examples

Retrieve Database Table Information

This example assumes you already stored your user credentials with your data source in the Database Explorer app.

Use sqltableinfo by specifying the name of the data source and the database table that you want to retrieve information about.

dataSourceInfo = "PostgreSQL Native";
tablename = "airlinesmall";
tableInfo = sqltableinfo(dataSourceInfo,tablename)

tableInfo = 

  struct with fields:

          Catalog: "toy_store"
           Schema: "public"
            Table: "airlinesmall"
          NumCols: 29
          NumRows: 123523
    VariableNames: ["year"    "month"    "dayofmonth"    "dayofweek"    "deptime"    "crsdeptime"    "arrtime"    "crsarrtime"    "uniquecarrier"    "flightnum"    …    ] (1×29 string)
    VariableTypes: ["double"    "double"    "double"    "double"    "double"    "double"    "double"    "double"    "string"    "double"    "string"    "double"    …    ] (1×29 string)

Input Arguments

dataSourceInfo — Data source information

connection object | string scalar | character vector

Data source information, specified as a connection object, string scalar, or character vector. Specifying data source information depends on the connection method:

• Specify dataSourceInfo as connection object by using the database function and retrieving your credentials using getSecret. This method assumes you have not stored your user credentials with the data source when using the Database Explorer app. Supported connection objects include:

  • database.odbc.connection

  • database.jdbc.connection

  • database.mysql.connection

  • database.postgre.connection

  • sqlite

• Specify dataSourceInfo as a character vector or string scalar if you have already created your data source and saved your user credentials with the Database Explorer app. Supported data sources include:

  • ODBC

  • JDBC

  • MySQL

  • PostgreSQL

tablename — Database table name

string scalar | character vector

Database table name, specified as a string scalar or character vector.

Output Arguments

tableInfo — Table information

structure

Table information, returned as a structure containing the following fields:

• Catalog

• Schema

• Table

• NumCols

• NumRows

• VariableNames

• VariableTypes

Version History

Introduced in R2025a