Skip to main content

"deleteTables"

Abstract

deleteTables deletes one or more tables in a single transaction.

The "deleteTables" action deletes one or more tables in a single transaction. All specified tables are deleted or none are.

Request examples

Minimal request example

{
    "api":"db",
    "authToken": "replaceWithValidAuthtoken",
    "action": "deleteTables",
    "params": {
        "tableNames": [
            "test1"
        ]
    }
}
{
    "api": "db",
    "apiVersion": "1.0",
    "requestId": "2",
    "authToken": "replaceWithValidAuthtoken",
    "action": "deleteTables",
    "params": {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "tableNames": [
            "athlete",
            "all_types"
        ]
    },
    "responseOptions": {
        "binaryFormat": "hex",
        "dataFormat": "objects",
        "numberFormat": "string"
    },
    "debug": "max"
}

Response examples

{
    "result": {
        "dataFormat": "objects",
        "data": [
            {
                "createRecByteIndex": false,
                "databaseName": "ctreeSQL",
                "fieldDelimiterValue": 0,
                "fields": [
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "id",
                        "nullable": false,
                        "scale": null,
                        "type": "bigint"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "changeId",
                        "nullable": true,
                        "scale": null,
                        "type": "bigint"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 50,
                        "name": "name",
                        "nullable": true,
                        "scale": null,
                        "type": "varchar"
                    }
                ],
                "folder": ".\\ctreeSQL.dbs",
                "growthExtent": 0,
                "indexFileExtension": ".idx",
                "indexes": [
                    {
                        "collectStats": false,
                        "compression": "off",
                        "conditionalExpression": null,
                        "databaseName": "ctreeSQL",
                        "deferIndexing": false,
                        "fields": [
                            {
                                "caseInsensitive": false,
                                "name": "id",
                                "reverseCompare": false,
                                "sortDescending": false
                            }
                        ],
                        "filename": null,
                        "immutableKeys": false,
                        "indexName": "id_pk",
                        "indexNumber": 0,
                        "ownerName": "admin",
                        "tableName": "test1",
                        "unique": true
                    }
                ],
                "ownerName": "admin",
                "padValue": 0,
                "path": ".\\ctreeSQL.dbs\\admin_test1.dat",
                "smallFile": false,
                "tableFileExtension": ".dat",
                "tableName": "test1",
                "totalRecordCount": 3,
                "transactionModel": "LOGTRANSACTIONS",
                "uid": 1169
            }
        ]
    },
    "errorCode": 0,
    "errorMessage": ""
}
{
    "result": {
        "dataFormat": "objects",
        "data": [
            {
                "createRecByteIndex": false,
                "databaseName": "ctreeSQL",
                "fieldDelimiterValue": 0,
                "fields": [
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "id",
                        "nullable": false,
                        "scale": null,
                        "type": "bigint"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "changeId",
                        "nullable": true,
                        "scale": null,
                        "type": "bigint"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 30,
                        "name": "name",
                        "nullable": true,
                        "scale": null,
                        "type": "varchar"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "ranking",
                        "nullable": false,
                        "scale": null,
                        "type": "smallint"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "birthDate",
                        "nullable": true,
                        "scale": null,
                        "type": "date"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 32,
                        "name": "playerNumber",
                        "nullable": true,
                        "scale": 6,
                        "type": "number"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "livedPast2000",
                        "nullable": true,
                        "scale": null,
                        "type": "bit"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 32,
                        "name": "earnings",
                        "nullable": true,
                        "scale": 4,
                        "type": "money"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 500,
                        "name": "favoriteSaying",
                        "nullable": true,
                        "scale": null,
                        "type": "varchar"
                    }
                ],
                "folder": ".\\ctreeSQL.dbs",
                "growthExtent": 0,
                "indexFileExtension": ".idx",
                "indexes": [
                    {
                        "collectStats": false,
                        "compression": "off",
                        "conditionalExpression": null,
                        "databaseName": "ctreeSQL",
                        "deferIndexing": false,
                        "fields": [
                            {
                                "caseInsensitive": false,
                                "name": "id",
                                "reverseCompare": false,
                                "sortDescending": false
                            }
                        ],
                        "filename": null,
                        "immutableKeys": false,
                        "indexName": "id_pk",
                        "indexNumber": 0,
                        "ownerName": "admin",
                        "tableName": "athlete",
                        "unique": true
                    }
                ],
                "ownerName": "admin",
                "padValue": 0,
                "path": ".\\ctreeSQL.dbs\\admin_athlete.dat",
                "smallFile": false,
                "tableFileExtension": ".dat",
                "tableName": "athlete",
                "totalRecordCount": 0,
                "transactionModel": "LOGTRANSACTIONS",
                "uid": 1177
            },
            {
                "createRecByteIndex": false,
                "databaseName": "ctreeSQL",
                "fieldDelimiterValue": 0,
                "fields": [
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "id",
                        "nullable": false,
                        "scale": null,
                        "type": "bigint"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "changeId",
                        "nullable": true,
                        "scale": null,
                        "type": "bigint"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 65500,
                        "name": "nested_json_object_or_array",
                        "nullable": true,
                        "scale": null,
                        "type": "json"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "boolean_byte",
                        "nullable": true,
                        "scale": null,
                        "type": "bit"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "signed_int8",
                        "nullable": true,
                        "scale": null,
                        "type": "tinyint"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "signed_int16",
                        "nullable": true,
                        "scale": null,
                        "type": "smallint"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "signed_int32",
                        "nullable": true,
                        "scale": null,
                        "type": "integer"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "signed_int64",
                        "nullable": true,
                        "scale": null,
                        "type": "bigint"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "iee_base2float32",
                        "nullable": true,
                        "scale": null,
                        "type": "real"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "iee_base2float64",
                        "nullable": true,
                        "scale": null,
                        "type": "float"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 32,
                        "name": "signed32digits_base10_left32right0",
                        "nullable": true,
                        "scale": 0,
                        "type": "number"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 32,
                        "name": "signed32digits_base10_left0right32",
                        "nullable": true,
                        "scale": 32,
                        "type": "number"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 32,
                        "name": "signed32digits_base10_left20right12",
                        "nullable": true,
                        "scale": 12,
                        "type": "number"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 32,
                        "name": "signed32digits_base10_left30right2",
                        "nullable": true,
                        "scale": 2,
                        "type": "money"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 32,
                        "name": "signed32digits_base10_left28right4",
                        "nullable": true,
                        "scale": 4,
                        "type": "money"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "date_yyyymmdd",
                        "nullable": true,
                        "scale": null,
                        "type": "date"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "time_hhmmss",
                        "nullable": true,
                        "scale": null,
                        "type": "time"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "datetime_yyyymmddthhmmss_nnnz",
                        "nullable": true,
                        "scale": null,
                        "type": "timestamp"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 10,
                        "name": "fixed_string_10bytes",
                        "nullable": true,
                        "scale": null,
                        "type": "char"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 65500,
                        "name": "variable_string_up_to_max65500bytes",
                        "nullable": true,
                        "scale": null,
                        "type": "varchar"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "variable_string_up_to_2GB",
                        "nullable": true,
                        "scale": null,
                        "type": "lvarchar"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 10,
                        "name": "fixed_binary_10bytes",
                        "nullable": true,
                        "scale": null,
                        "type": "binary"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": 65500,
                        "name": "variable_binary_up_to_max65500bytes",
                        "nullable": true,
                        "scale": null,
                        "type": "varbinary"
                    },
                    {
                        "autoTimestamp": "none",
                        "defaultValue": null,
                        "length": null,
                        "name": "variable_binary_up_to_2GB",
                        "nullable": true,
                        "scale": null,
                        "type": "lvarbinary"
                    }
                ],
                "folder": ".\\ctreeSQL.dbs",
                "growthExtent": 0,
                "indexFileExtension": ".idx",
                "indexes": [
                    {
                        "collectStats": false,
                        "compression": "off",
                        "conditionalExpression": null,
                        "databaseName": "ctreeSQL",
                        "deferIndexing": false,
                        "fields": [
                            {
                                "caseInsensitive": false,
                                "name": "id",
                                "reverseCompare": false,
                                "sortDescending": false
                            }
                        ],
                        "filename": null,
                        "immutableKeys": false,
                        "indexName": "id_pk",
                        "indexNumber": 0,
                        "ownerName": "admin",
                        "tableName": "all_types",
                        "unique": true
                    }
                ],
                "ownerName": "admin",
                "padValue": 0,
                "path": ".\\ctreeSQL.dbs\\admin_all_types.dat",
                "smallFile": false,
                "tableFileExtension": ".dat",
                "tableName": "all_types",
                "totalRecordCount": 0,
                "transactionModel": "LOGTRANSACTIONS",
                "uid": 1181
            }
        ]
    },
    "requestId": "2",
    "debugInfo": {
        "request": {
            "authToken": "replaceWithValidAuthtoken",
            "api": "db",
            "action": "deleteTables",
            "params": {
                "databaseName": "ctreeSQL",
                "ownerName": "admin",
                "tableNames": [
                    "athlete",
                    "all_types"
                ]
            },
            "apiVersion": "1.0",
            "requestId": "2",
            "responseOptions": {
                "binaryFormat": "hex",
                "dataFormat": "objects",
                "numberFormat": "string"
            },
            "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

"ownerName"

contains the unique name of a schema in a database

""

string

Minimum length: 1
Maximum length: 64

"tableNames"

lists table names to return in the response message

Required - No default value

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 "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 "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.

Troubleshooting errors

You cannot modify a table while it is in use. When a table has no activity for a default of 2 seconds, it will be closed so you can modify it.

  • When a table is in use, the following actions return an error, such as -8 or 4012:

    • "alterTable"

    • "rebuildTables"

    • "deleteTables"

    • "createIndex"

    • "deleteIndexes"

    • "rebuildIndexes"

    • "runSqlStatements"

  • A table is in use when any account is performing one or more of the following actions with the table:

    • "insertRecords"

    • "updateRecords"

    • "deleteRecords"

    • "truncateRecords"

    • "getRecords..."

    • Has open cursors on the table.

    • Has open transactions on the table (such "createTransaction").

  • Modify the SQL_IDLE_WAKE startup configuration setting to change the number of seconds the server waits before closing a table. A larger number keeps the table open longer for better performance. A smaller number allows you to modify the table sooner.

  • Modify the SQL_IDLE_WAKE startup configuration setting to change the number of tables the server keeps open after they are no longer being actively used. A larger number caches more tables and improves performance. A smaller number allows you to modify tables sooner.