"deleteIndexes"
JSON DB "deleteIndexes" action deletes indexes
The "deleteIndexes" action deletes one or more indexes in a single transaction. All specified indexes are deleted or none are.
Request examples
Minimal request
{
"api":"db",
"authToken": "replaceWithValidAuthtoken",
"action": "deleteIndexes",
"params": {
"tableName": "test1",
"indexNames": [
"name"
]
}
}{
"requestId": "2",
"authToken": "replaceWithValidAuthtoken",
"api": "db",
"action": "deleteIndexes",
"params": {
"databaseName": "ctreeSQL",
"ownerName": "admin",
"tableName": "test1",
"indexNames": [
"name"
]
},
"responseOptions": {
"binaryFormat": "hex",
"dataFormat": "objects",
"numberFormat": "string"
},
"apiVersion": "1.0",
"debug": "max"
}
Note
If the target object does not exist, the response returns success and the debug property contains a warning that the object was not found.
{
"authToken": "replaceWithValidAuthtoken",
"result": {
"data": [
{
"collectStats": true,
"compression": "off",
"conditionalExpression": null,
"databaseName": "ctreeSQL",
"deferIndexing": false,
"fields": [
{
"caseInsensitive": false,
"name": "name",
"reverseCompare": false,
"sortDescending": false
}
],
"filename": "admin_test1.idx",
"immutableKeys": false,
"indexName": "name",
"indexNumber": 1,
"ownerName": "admin",
"tableName": "test1",
"unique": false
}
]
},
"errorCode": 0,
"errorMessage": ""
}
{
"authToken": "replaceWithValidAuthtoken",
"result": {
"data": [
{
"collectStats": true,
"compression": "off",
"conditionalExpression": null,
"databaseName": "ctreeSQL",
"deferIndexing": false,
"fields": [
{
"caseInsensitive": false,
"name": "name",
"reverseCompare": false,
"sortDescending": false
}
],
"filename": "admin_test1.idx",
"immutableKeys": false,
"indexName": "name",
"indexNumber": 1,
"ownerName": "admin",
"tableName": "test1",
"unique": false
}
]
},
"requestId": "2",
"debugInfo": {
"request": {
"authToken": "replaceWithValidAuthtoken",
"api": "db",
"action": "deleteIndexes",
"params": {
"databaseName": "ctreeSQL",
"ownerName": "admin",
"tableName": "test1",
"indexNames": [
"name"
]
},
"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": ""
}
Use the deleteIndexes API action to delete indexes
The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.
Properties summary
"params" properties summaryProperty | Description | Default | Type | Limits (inclusive) |
|---|---|---|---|---|
specifies the name of a database | Defaults to the | string | 1 to 64 bytes | |
indexNames | defines the name of an index | Required - No default value | array | |
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.
Properties summary
"result" properties summaryProperty | 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 |
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_WAKEstartup 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_WAKEstartup 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.