`"truncateRecords"`

The truncateRecords action deletes all records from a database table very quickly by deleting and recreating the data file

Abstract

truncateRecords deletes all records from a database table very quickly by deleting and recreating the data file.

The "truncateRecords" action deletes all records from a database table very quickly by deleting and recreating the data file. It must get an exclusive lock on the table before it can truncate it.

Request examples

Minimal request example

{
  "api": "db",
  "authToken": "replaceWithAuthtokenFromCreateSession",
  "action": "truncateRecords",
  "params": {
    "tableName": "test1",
    "deleteAllRecords": true
  }
}

Maximal request example

{
  "api": "db",
  "apiVersion": "1.0",
  "requestId": "2",
  "authToken": "replaceWithAuthtokenFromCreateSession",
  "action": "truncateRecords",
  "params": {
    "databaseName": "ctreeSQL",
    "ownerName": "admin",
    "tableName": "test1",
    "deleteAllRecords": true
  },
  "responseOptions": {
    "binaryFormat": "hex",
    "dataFormat": "objects",
    "numberFormat": "string",
    "includeFields": [],
    "excludeFields": []
  },
  "debug": "max"
}

Response examples

Minimal response example

{
  "authToken": "authToken",
  "errorCode": 0,
  "errorMessage": ""
}

Maximal response example

{
  "authToken": "authToken",
  "requestId": "2",
  "debugInfo": {
    "request": {
      "authToken": "authToken",
      "api": "db",
      "action": "truncateRecords",
      "params": {
        "databaseName": "ctreeSQL",
        "ownerName": "admin",
        "tableName": "test1",
        "deleteAllRecords": true
      },
      "apiVersion": "1.0",
      "requestId": "2",
      "responseOptions": {
        "binaryFormat": "hex",
        "dataFormat": "objects",
        "numberFormat": "string",
        "includeFields": [],
        "excludeFields": []
      },
      "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.

Minimal example

Property summary

Table 1. "params" property summaries

Property

Description

Default

Type

Limits (inclusive)

databaseName

specifies the name of a database

Defaults to the "defaultDatabaseName" value that is set during "createSession". If no default is set during "createSession", then "faircom" is used.

string

1 to 64 bytes

deleteAllRecords

deletes all records in a table when set it to true

Required - No default value

Boolean

true

false

ownerName

specifies the unique name of a schema in a database

""

string

1 to 64 bytes

tableName

specifies the name of a table

Required - No default value

string

1 to 64 bytes

`"databaseName"`

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.

`"ownerName"`

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.

`"tableName"`

The "tableName" property is a string containing the name of a table.

Things to know:

A table name may contain up to 64 ASCII characters and must not start with a number.