Skip to main content

"listIntegrationTables"

JSON hub "listIntegrationTable action lists all existing tables for a given database

The "listIntegrationTables" action lists the tables for a given database.

Essential information

  • This action lists only integration tables. To list other tables, use the "listTables" action in the JSON DB API.

  • You can do the following:

    • You can return all integration tables by omitting all properties from the "params" object.

    • You can return tables that match a specific database and owner by specifying the optional "databaseNameFilter" and "ownerName" properties. These two properties must be used together.

    • You can return tables that match the partial table name specified in the optional "partialName" property. Using "partialName" also requires specifying the database and owner in the "databaseNameFilter" and "ownerName" properties. These three properties must be used together.

Request examples

List all integration tables request

{
  "api":        "hub",
  "apiVersion": "1.0",
  "requestId":  "1",
  "authToken":  "anAuthorizationTokenFromTheServer",
  "action":     "listIntegrationTables",
  "params":     {}
}

List integration tables with a specific database and owner request

{
  "api":        "hub",
  "apiVersion": "1.0",
  "authToken":  "anAuthorizationTokenFromTheServer",
  "requestId":  "2",
  "action":     "listIntegrationTables",
  "params":     {
    "databaseNameFilter": "faircom",
    "ownerName": "admin"
  }
}

List integration tables using partial name request

{
  "api":        "hub",
  "apiVersion": "1.0",
  "authToken":  "anAuthorizationTokenFromTheServer",
  "requestId":  "3",
  "action":     "listIntegrationTables",
  "params":     {
    "databaseNameFilter": "faircom",
    "ownerName": "admin",
    "partialName": "mqtt_msg_faircomadmin_t"
  }
}

Response examples

Successful response

{
    "authToken": "anAuthorizationTokenFromTheServer",
    "result": {
        "data": [
            {
                "databaseName": "faircom",
                "ownerName": "admin",
                "tableName": "mqtt_msg_faircomadmin_connections"
            },
            {
                "databaseName": "faircom",
                "ownerName": "admin",
                "tableName": "mqtt_msg_faircomadmin_subscribers"
            },
            {
                "databaseName": "faircom",
                "ownerName": "admin",
                "tableName": "mqtt_msg_faircomadmin_topics"
            }
        ]
    },
    "requestId": "1",
    "errorCode": 0,
    "errorMessage": ""
}

Use the listIntegrationTables JSON API action to list all existing tables for a given database

JSON hub APIAPI actionsjsonActionintegration tables actionslist integration tablelistIntegrationTables

"params"

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

Properties summary

Table 1. "params" properties summary

Property

Description

Default

Type

Limits (inclusive)

databaseNameFilter

causes the server to include tables that match the value of the specified database name or, when an empty string, returns all tables

""

string

1 to 64 bytes

ownerName

specifies the unique name of a schema in a database

""

string

1 to 64 bytes

partialName

filters the returned topics by applying partial matches to their names

""

string

0 to 64 bytes



"databaseNameFilter"

The "databaseNameFilter" property is an optional string that, when set to a non-empty string, causes the server to include tables that match the entire value of the specified database name, such as "faircom". It defaults to an empty string.

Essential information

  • When "databaseNameFilter" is set to an empty string, an action will return tables from all databases.

  • When the value of "databaseNameFilter" is a non-empty string, it must be set to a valid database name.

  • "databaseNameFilter" is case-insensitive.

  • When the "partialName" property is present, the "databaseNameFilter" and "partialName" properties must be set to valid database and owner names.

"ownerName"

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

"partialName"

The "partialName" property is an optional string that causes the server to include items in the result when the beginning of their names match the "partialName" value. It defaults to an empty string.

Essential information

  • A zero-length string matches all names.

  • The "partialName" property is used to filter results in several actions used to return lists.

"result"

Properties summary

Table 2. "result" properties summary

Property

Description

Type

Limits (inclusive)

data

specifies an array or object that the server returns, such as records returned by a query. It is always included in a response but contains an empty array when no results are available.

array

Its contents are determined by the action