"truncateRecords"
JSON DB "truncateRecords" action 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
{
"api": "db",
"authToken": "replaceWithAuthtokenFromCreateSession",
"action": "truncateRecords",
"params": {
"tableName": "test1",
"deleteAllRecords": true
}
}
{
"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"
}
{
"authToken": "authToken",
"errorCode": 0,
"errorMessage": ""
}
{
"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": ""
}
Use the truncateRecords JSON API action to delete all records from a database table very quickly by deleting and recreating the data file
The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.
Property summary
"params" property summariesProperty | Description | Default | Type | Limits (inclusive) | ||
|---|---|---|---|---|---|---|
specifies the name of a database | Defaults to the | string | 1 to 64 bytes | |||
deleteAllRecords | deletes all records in a table when set it to | Required - No default value | Boolean |
| ||
specifies the unique name of a schema in a database |
| string | 1 to 64 bytes | |||
specifies the name of a table | Required - No default value | string | 1 to 64 bytes |
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.
A zero-length
"databaseName"is invalid.Its limits are from 0 to 64 bytes.
If the
"databaseName"property is omitted or set tonull, 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 theservices.jsonfile.
The "ownerName" property is an optional string from 1 to 64 bytes that specifies the account that owns an object.
The "tableName" property is a string containing the name of a table.
A table name may contain up to 64 ASCII characters and must not start with a number.