Request examples
Minimal
{
"action": "describeTables",
"params": {
"tableNames": [
"test1"
]
},
"authToken": "replaceWithAuthTokenFromCreateSession"
}Maximal
{
"api": "db",
"action": "describeTables",
"params": {
"databaseName": "ctreeSQL",
"ownerName": "admin",
"tableNames": [
"all_types"
],
"transactionId": null
},
"responseOptions": {
"binaryFormat": "hex",
"dataFormat": "objects",
"numberFormat": "string"
},
"debug": "max",
"authToken": "replaceWithAuthTokenFromCreateSession",
"apiVersion": "1.0",
"requestId": "00000004"
}
Response examples
Minimal
{
"result": {
"dataFormat": "objects",
"data": [
{
"changeIdField": "changeId",
"createRecByteIndex": false,
"databaseName": "ctreeSQL",
"fieldDelimiterValue": 0,
"fields": [
{
"autoValue": "incrementOnInsert",
"defaultValue": null,
"length": null,
"name": "id",
"nullable": false,
"primaryKey": 1,
"scale": null,
"type": "bigint"
},
{
"autoValue": "changeId",
"defaultValue": null,
"length": null,
"name": "changeId",
"nullable": true,
"primaryKey": 0,
"scale": null,
"type": "bigint"
},
{
"autoValue": "none",
"defaultValue": null,
"length": 50,
"name": "name",
"nullable": true,
"primaryKey": 0,
"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": "admin_test1.idx",
"immutableKeys": false,
"indexName": "id_pk",
"indexNumber": 0,
"ownerName": "admin",
"tableName": "test1",
"unique": true
}
],
"ownerName": "admin",
"padValue": 0,
"path": ".\\ctreeSQL.dbs\\admin_test1.dat",
"primaryKeyFields": [
"id"
],
"smallFile": false,
"tableFileExtension": ".dat",
"tableName": "test1",
"totalRecordCount": 0,
"transactionModel": "logTransactions",
"uid": 1181
}
]
},
"debugInfo": {
"request": {
"action": "describeTables",
"params": {
"tableNames": [
"test1"
]
},
"debug": "max",
"authToken": "replaceWithAuthTokenFromCreateSession"
},
"serverSuppliedValues": {
"databaseName": "ctreeSQL",
"ownerName": "admin"
},
"errorData": {
"errorData": null
},
"warnings": []
},
"errorCode": 0,
"errorMessage": "",
"authToken": "replaceWithAuthTokenFromCreateSession"
}Maximal
{
"result": {
"dataFormat": "objects",
"data": [
{
"changeIdField": "changeId",
"createRecByteIndex": false,
"databaseName": "ctreeSQL",
"fieldDelimiterValue": 0,
"fields": [
{
"autoValue": "incrementOnInsert",
"defaultValue": null,
"length": null,
"name": "id",
"nullable": false,
"primaryKey": 1,
"scale": null,
"type": "bigint"
},
{
"autoValue": "changeId",
"defaultValue": null,
"length": null,
"name": "changeId",
"nullable": true,
"primaryKey": 0,
"scale": null,
"type": "bigint"
},
{
"autoValue": "none",
"defaultValue": null,
"length": 30,
"name": "name",
"nullable": true,
"primaryKey": 0,
"scale": null,
"type": "varchar"
},
{
"autoValue": "none",
"defaultValue": null,
"length": null,
"name": "ranking",
"nullable": false,
"primaryKey": 0,
"scale": null,
"type": "smallint"
},
{
"autoValue": "none",
"defaultValue": null,
"length": null,
"name": "birthDate",
"nullable": true,
"primaryKey": 0,
"scale": null,
"type": "date"
},
{
"autoValue": "none",
"defaultValue": null,
"length": 32,
"name": "playerNumber",
"nullable": true,
"primaryKey": 0,
"scale": 6,
"type": "number"
},
{
"autoValue": "none",
"defaultValue": null,
"length": null,
"name": "livedPast2000",
"nullable": true,
"primaryKey": 0,
"scale": null,
"type": "bit"
},
{
"autoValue": "none",
"defaultValue": null,
"length": 32,
"name": "earnings",
"nullable": true,
"primaryKey": 0,
"scale": 4,
"type": "money"
},
{
"autoValue": "none",
"defaultValue": null,
"length": 500,
"name": "favoriteSaying",
"nullable": true,
"primaryKey": 0,
"scale": null,
"type": "varchar"
}
],
"folder": ".\\ctreeSQL.dbs",
"growthExtent": 0,
"indexFileExtension": ".idx",
"indexes": [
{
"primaryIndex": true,
"collectStats": false,
"compression": "off",
"conditionalExpression": null,
"databaseName": "ctreeSQL",
"deferIndexing": false,
"fields": [
{
"caseInsensitive": false,
"name": "id",
"reverseCompare": false,
"sortDescending": false
}
],
"filename": "admin_athlete.idx",
"immutableKeys": false,
"indexName": "id_pk",
"indexNumber": 0,
"ownerName": "admin",
"tableName": "athlete",
"unique": true
}
],
"ownerName": "admin",
"padValue": 0,
"path": ".\\ctreeSQL.dbs\\admin_athlete.dat",
"primaryIndexName": "id_pk",
"primaryKeyFields": [
"id"
],
"smallFile": false,
"tableFileExtension": ".dat",
"tableName": "athlete",
"totalRecordCount": 0,
"transactionModel": "logTransactions",
"uid": 1185
}
]
},
"requestId": "2",
"debugInfo": {
"request": {
"api": "db",
"action": "describeTables",
"params": {
"databaseName": "ctreeSQL",
"ownerName": "admin",
"tableNames": [
"athlete"
]
},
"apiVersion": "1.0",
"requestId": "2",
"responseOptions": {
"dataFormat": "objects"
},
"debug": "max",
"authToken": "replaceWithAuthTokenFromCreateSession"
},
"serverSuppliedValues": {
"databaseName": "ctreeSQL",
"ownerName": "admin"
},
"errorData": {
"errorData": null
},
"warnings": []
},
"errorCode": 0,
"errorMessage": "",
"authToken": "replaceWithAuthTokenFromCreateSession"
}
Request properties ("params")
| Property | Description | Default | Type | Limits (inclusive) |
|---|---|---|---|---|
ownerName |
The You specify this property when you want to use a different account instead of the default. Your session's account must have the appropriate privileges to access the code package. This property is useful because objects, such as tables and code packages, can have the same name in the same database as long as different accounts own each object. This feature allows you to create duplicate objects for different users on the same server and reuse the same JSON actions on those objects. For example, an administrator can copy objects from a production environment to her account so she can troubleshoot an issue using the same JSON actions, JavaScript, and SQL code. It is an error to set If no default owner is specified during |
Optional with default of the session's "defaultOwnerName" property |
string | 1 to 64 bytes |
tableName |
The See table name in System specifications for the table naming requirements and limitations.
"params": {
"tableName": "ctreeTable"
} |
Required - No default value | string | 1 to 64 bytes |
databaseName |
The You specify this property when you want to use a different database instead of the default. This property is useful because objects, such as tables and code packages, can have the same name in multiple databases. This feature allows you to create multiple environments in the same server and reuse the same JSON actions in each environment. For example, you can create It is an error to set If no default database is specified during |
Defaults to the session's "defaultDatabaseName" property |
string | 1 to 64 bytes |
transactionId |
The "transactionId" property identifies a transaction in which the specified action will be included. |
Optional with default of ""
|
string | 0 to 255 bytes |
Response properties ("result")
| Property | Description | Type | Limits (inclusive) |
|---|---|---|---|
dataFormat |
The
|
string |
|
data |
The |
array of objects | The action determines its contents. |
|
data .changeIdField |
The "changeIdField" property specifies the name of the field used for the change-tracking functionality. If the table already has a change-tracking field, this new field is now used instead for change-tracking. |
string | 1 to 64 bytes |
|
data .createRecByteIndex |
The
|
Boolean |
|
|
data .databaseName |
The
|
string | 1 to 64 bytes |
|
data .fieldDelimiterValue |
The
|
integer |
0 to 255
|
|
data .fields |
The
"fields": [
{
"autoValue": "none",
"name": "name",
"type": "varchar",
"length": 50,
"scale": null,
"defaultValue": null,
"nullable": false, |
array |
updateRecords and deleteRecords only:
|
|
data .fields .autoValue |
The "autoValue" property indicates when and how the server automatically sets the field value. See autoValue for more details. |
string |
|
|
data .fields .defaultValue |
The "defaultValue" property specifies the field's default value. |
string | 0 to 65,500 bytes |
|
data .fields .length |
Identifies the length of the field. | integer |
1 to 65500 |
|
data .fields .name |
The The The
|
string | 1 to 64 bytes |
|
data .fields .nullable |
“nullable” identifies whether a field can contain a NULL value. |
Boolean |
|
|
data .fields .primaryKey |
When > 0, the "primaryKey" property identifies the ordinal position of the field within the table's primary key. |
integer |
0 to 32
|
|
data .indexes .fields .caseInsensitive |
The When "fields": [
{
"caseInsensitive": true
}
] |
Boolean |
|
|
data .indexes .fields .reverseCompare |
The When "fields": [
{
"reverseCompare": true
}
] |
Boolean |
|
|
data .indexes .fields .sortDescending |
The "fields": [
{
"sortDescending": true
}
] |
Optional with default of false
|
Boolean |
|
data .fields .scale |
If the type is "number" or "money", the "scale" property identifies the number of places to the right of the decimal point,. |
integer |
0 to 32
|
|
data .fields .type |
Identifies the type of the field. See Data types. | string |
|
|
data .folder |
The
|
string | 0 to 2,048 bytes |
|
data .growthExtent |
The
|
integer |
0 to 2147483647
|
|
data .indexFileExtension |
The
|
string | 0 to 64 bytes |
|
data .indexes .collectstats |
The “collectStats” property identifies whether usage statistics are being collected and stored. |
boolean |
|
|
data .indexes .compression |
The “compression” property identifies whether the index is compressed. |
string |
|
|
data .indexes .conditionalExpression |
The “conditionalExpression” property identifies an optional conditional expression that filters which records are included in the index. It is null when there is no conditional expression. |
string |
null or a string containing a conditional expression. |
|
data .indexes .databaseName |
The You specify this property when you want to use a different database instead of the default. This property is useful because objects, such as tables and code packages, can have the same name in multiple databases. This feature allows you to create multiple environments in the same server and reuse the same JSON actions in each environment. For example, you can create It is an error to set If no default database is specified during |
string | 1 to 64 bytes |
|
data .indexes .deferIndexing |
“deferindexing” identifies whether deferred indexing is enabled. A deferred index builds and updates asynchronously. This speeds up inserts, updates, and deletes, with a slight delay due to the changes being included in the index. |
boolean |
|
|
data .indexes .filename |
The
|
string | 0 to 2048 bytes |
|
data .indexes .immutableKeys |
"immutableKeys" indicates whether a key's value can be changed. |
boolean |
|
|
data .indexes .indexName |
The "indexName" property specifies the name of an index. A zero-length "indexName" is invalid. |
string | 1 to 64 bytes |
|
data .indexes .ownerName |
The You specify this property when you want to use a different account instead of the default. Your session's account must have the appropriate privileges to access the code package. This property is useful because objects, such as tables and code packages, can have the same name in the same database as long as different accounts own each object. This feature allows you to create duplicate objects for different users on the same server and reuse the same JSON actions on those objects. For example, an administrator can copy objects from a production environment to her account so she can troubleshoot an issue using the same JSON actions, JavaScript, and SQL code. It is an error to set If no default owner is specified during |
string | 1 to 64 bytes |
|
data .indexes .tableName |
The See table name in System specifications for the table naming requirements and limitations. |
string | 1 to 64 bytes |
|
data .indexes .unique |
The "unique" property causes the "createIndex" action to create a unique index, which requires the columns in the index to have a unique value for each record in the table, when set to true. |
Boolean |
|
|
data .ownerName |
The "ownerName" property identifies the user who owns an object (see Object owner). |
string | 0 to 64 bytes |
|
data .padValue |
The All fixed-length fields in a table are padded with the same pad value. For more details, see |
integer |
0 to 255
|
|
data .path |
The "path" property identifies the path of the database folder. For more details, see "path". |
string | 0 to 2,048 bytes |
|
data .primaryKeyFields |
This property specifies the fields of the table’s primary key when multiple fields are combined to form the primary key.
The order of fields in this property is the order of fields in the primary key index. The A primary key with multiple fields has an index named If only one field is used as the primary key, the
Example "primaryKeyFields": [
"a",
"b",
"c"
],
"fields": [
{
"name": "a",
"type": "tinyint"
},
{
"name": "b",
"type": "smallint"
},
{
"name": "c",
"type": "integer"
}
] |
array | an array |
|
data .smallFile |
The
|
Boolean |
|
|
data .tableFileExtension |
The
|
string | 0 to 64 bytes |
|
data .tableName |
The See table name in System specifications for the table naming requirements and limitations. |
string | 1 to 64 bytes |
|
data .totalRecordCount |
The
|
integer |
|
|
data .transactionModel |
The Possible values:
|
string |
|