Skip to main content

"listTables"

Abstract

listTables lists tables in the specified database that the logged-in user is allowed to see.

The "listTables" action lists tables in the specified database that the logged-in user is allowed to see. It also returns all available information about each table.

Request examples

Minimal request example

{
  "api": "db",
  "authToken": "replaceWithValidAuthtoken",
  "action": "listTables",
  "params": {
    "databaseName": "ctreeSQL"
  }
}
{
  "api": "db",
  "apiVersion": "1.0",
  "requestId": "2",
  "authToken": "replaceWithValidAuthtoken",
  "action": "listTables",
  "params": {
    "databaseName": "ctreeSQL",
    "partialTableName": "a"
  }
}
{
  "api": "db",
  "apiVersion": "1.0",
  "requestId": "3",
  "authToken": "replaceWithValidAuthtoken",
  "action": "listTables",
  "params": {
    "databaseName": "ctreeSQL",
    "tableNames": [
      "athlete",
      "test1"
    ]
  }
}
{
  "api": "db",
  "apiVersion": "1.0",
  "requestId": "4",
  "authToken": "replaceWithValidAuthtoken",
  "action": "listTables",
  "params": {
    "databaseName": "ctreeSQL",
    "ownerName": "admin",
    "skipRecords": 1,
    "maxRecords": 3,
    "includeSystemTables": false
  },
  "debug": "max"
}

Response examples

{
  "authToken": "replaceWithValidAuthtoken",
  "result": {
    "dataFormat": "objects",
    "data": [
      {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "path": "./ctreeSQL.dbs",
        "tableName": "all_types",
        "totalRecordCount": -1,
        "uid": 1189
      },
      {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "path": ".\\ctreeSQL.dbs",
        "tableName": "athlete",
        "totalRecordCount": -1,
        "uid": 1185
      },
      {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "path": ".\\ctreeSQL.dbs",
        "tableName": "test1",
        "totalRecordCount": -1,
        "uid": 1181
      }
    ]
  },
  "errorCode": 0,
  "errorMessage": ""
}
{
  "authToken": "replaceWithValidAuthtoken",
  "result": {
    "dataFormat": "objects",
    "data": [
      {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "path": "./ctreeSQL.dbs",
        "tableName": "all_types",
        "totalRecordCount": -1,
        "uid": 1189
      },
      {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "path": ".\\ctreeSQL.dbs",
        "tableName": "athlete",
        "totalRecordCount": -1,
        "uid": 1185
      }
    ]
  },
  "requestId": "2",
  "errorCode": 0,
  "errorMessage": ""
}
{
  "authToken": "replaceWithValidAuthtoken",
  "result": {
    "dataFormat": "objects",
    "data": [
      {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "path": ".\\ctreeSQL.dbs",
        "tableName": "athlete",
        "totalRecordCount": -1,
        "uid": 1185
      },
      {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "path": ".\\ctreeSQL.dbs",
        "tableName": "test1",
        "totalRecordCount": -1,
        "uid": 1181
      }
    ]
  },
  "requestId": "3",
  "errorCode": 0,
  "errorMessage": ""
}
{
  "authToken": "replaceWithValidAuthtoken",
  "result": {
    "dataFormat": "objects",
    "data": [
      {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "path": ".\\ctreeSQL.dbs",
        "tableName": "athlete",
        "totalRecordCount": -1,
        "uid": 1185
      },
      {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "path": ".\\ctreeSQL.dbs",
        "tableName": "test1",
        "totalRecordCount": -1,
        "uid": 1181
      }
    ]
  },
  "requestId": "4",
  "debugInfo": {
    "request": {
      "authToken": "replaceWithValidAuthtoken",
      "api": "db",
      "action": "listTables",
      "params": {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "skipRecords": 1,
        "maxRecords": 3,
        "includeSystemTables": false
      },
      "apiVersion": "1.0",
      "requestId": "4",
      "debug": "max"
    },
    "serverSuppliedValues": {
      "databaseName": "ctreeSQL",
      "ownerName": "admin"
    },
    "errorData": {
      "errorData": null
    },
    "warnings": []
  },
  "errorCode": 0,
  "errorMessage": ""
}

"params"

The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.

Property summary

Table 1. "params" property summaries

Property

Description

Default

Type

Limits (inclusive)

"databaseName"

contains the name of a database

Defaults to the "defaultDatabaseName" value that is set during "createSession"

string

Minimum length: 1
Maximum length: 64

"includeSystemTables"

includes the system tables in the list of tables when true

false

Boolean

true
false

"maxRecords"

sets the maximum number of records to return from an action

20

integer

-1 - 65535

"ownerName"

contains the unique name of a schema in a database

""

string

Minimum length: 1
Maximum length: 64

"partialTableName"

filters the returned databases by applying partial matches to database names

""

string

Minimum length: 0
Maximum length: 64

"skipRecords"

specifies the number of records to skip over in the results before returning records

0

integer

0 - 9,223,372,036,854,775,807

"tableNames"

lists table names to return in the response message

""

array

Minimum length: 1
Maximum length: 64


The "databaseName" property is an optional string that specifies the database that contains the tables. It defaults to the database name supplied at login.

Note

In the API Explorer, "defaultDatabaseName" is set to "ctreeSQL" in the "createSession" action that happens at login.

Things to know:
  • A zero-length "databaseName" is invalid.

  • Its limits are from 0 to 64 bytes.

  • If the "databaseName" property is omitted or set to null, the server will use the default database name specified at login.

  • If no default database is specified during "createSession", "defaultDatabaseName" will be set to the "defaultDatabaseName" value that is specified in the services.json file.

The "maxRecords" is an optional integer from -1 to 65,535 that sets the maximum number of records to return from an action. It is used in query actions to paginate the query results when returning records directly. The default for most actions is to return 20 records.

Important

-1 returns all records and should be used very carefully because a large query can return so many records that it eventually times out and wastes server and client resources.

Things to know:
  • When present, "maxRecords" works in conjunction with the "skipRecords" (and, when applicable, "reverseOrder") properties to paginate results.

  • "maxRecords" returns an error when "returnCursor" is true.

    Note

    This does not apply to the actions where "returnCursor" is not present.

  • When returning a cursor, retrieve records using the "getRecordsFromCursor" action.

  • A value of 0 for "maxRecords" is not useful because it causes the action to return no records.

  • "maxRecords" is ignored by the "getRecordsByIds" action.

The "ownerName" property is an optional string from 1 to 64 bytes that specifies the account that owns an object.

Things to know:
  • The "ownerName" property is optional and has a dynamic default value.

  • If the "ownerName" property is omitted or set to null, the server uses the value of the "defaultOwnerName" property supplied during the "createSession" action.

  • If the "defaultOwnerName" property is not defined, the server uses the "admin" as the owner name.

  • The owner of an object has administrative rights over that object.

  • The "ownerName" property is a namespace for an object. You can think of it as a container of objects.

    The "ownerName" allows users to use any name for the objects they create — for example, a QA engineer may copy tables into their owner space to run a set of tests.

    It is common for a user to create their own copies of objects from other accounts for testing, troubleshooting, and fixing data. The copied objects can retain the same name because the "ownerName" distinguishes between them.

  • The fully qualified name of an object is the "databaseName", "ownerName", and the object's name, such as "tableName" meaning a FairCom server may contain many tables with the name "mytable" as long as each one is in a different database or in a different owner space.

    For example, an organization often creates different databases for different phases of the development lifecycle, such as dev, test, stage, ua, and prod. Each of these databases contains the same set of objects with the same names. Applications leave the "databaseName" out of their JSON actions and use the "defaultDatabaseName" property to specify the target database.

  • Queries and scripts are often written without specifying "databaseName" and/or "ownerName", allowing queries and scripts to work properly when run in different databases or in different schemas.

The "partialTableName" property is an optional string from 0 to 64 bytes that filters the returned databases by applying partial matches to database names. It defaults to an empty string.

Things to know:
  • The "listTables" action uses "partialTableName" to return all tables whose table names start with these same characters.

  • A zero-length string matches all table names.

The "skipRecords" property is an optional integer from 0 to 9,223,372,036,854,775,807. It is used in query actions to paginate the query results when returning records directly. It defaults to 0.

Things to know:
  • It specifies the number of records to skip over in the results before returning records.

  • It works with "maxRecords" and "reverseOrder".

  • It is ignored when "returnCursor" is true.

    Note

    This does not apply to the actions where "returnCursor" is not present.

The "tableNames" property is a required array of strings. Each string is from 1 to 64 bytes.

Things to know:
  • Contains at least one string.

  • Each string is the name of a table.

  • A zero-length "tableName" is invalid.

  • A client should force the uniqueness of items in the array because the server ignores duplicate items.

"result"

Property summary

Table 2. "result" property summaries

Property

Description

Type

Limits (inclusive)

"data"

contains an array or object that the server returns, such as records returned by a query

Note

It is an empty array when there are no results available.

array

Its contents are determined by the action

"dataFormat"

defines the format of the data in the "data" property

string

"autoDetect"
"arrays"
"objects"


The "dataFormat" property is an optional, case-insensitive string enum that defines the format of the response in the "data" property. The default format is an array of arrays. The alternative is an array of objects. The default for "dataFormat" can be changed during a "createSession" action by assigning a different value to the "dataFormat" property in "defaultResponseOptions".

There are three different (but similar) versions of the "dataFormat" property:

Two of those versions occur in a request and another occurs in a response. They all indicate how data is formatted.

  • "dataFormat" in the request inside "responseOptions" determines how the "data" property in the response is formatted.

    Possible values include:

    • "arrays"

      This is the default and causes the server to return results as an array of arrays, which is the most efficient.

    • "objects"

      This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.

  • "dataFormat" in the request in the "params" object notifies the server how the "sourceData" property is formatted in the request. This version is rarely used because of the default "autoDetect" behavior.

    Possible values include:

    • "arrays"

      This causes the server to return results as an array of arrays, which is the most efficient.

    • "objects"

      This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.

    • "autoDetect"

      This is the default and causes the server to automatically detect the format of the data in the "sourceData" property.

  • "dataFormat" in the response shows the client how the server formatted the "data" property.

    Possible values include:

    • "arrays"

      This is the default and causes the server to return results as an array of arrays, which is the most efficient.

    • "objects"

      This returns results as an array of objects. This is less efficient but is simpler to generate, read, and troubleshoot.