TableDefinitions
Retrieve information for the tables belonging to a given application.
Table Specific Information
Select
The TableDefinitions table gathers detailed information regarding the tables associated with a specific application. This involves retrieving metadata related to the entity, such as the table description, its storage space, and timezone information.
The provider uses the Quickbase API to retrieve TableDefinitions either for an entire application (by AppId) or for a specific table within that application (by Id and AppId). All other filters are applied client-side within the provider.
For example, the following queries are processed server side:
SELECT * FROM [TableDefinitions] WHERE [AppId] = 'bu99sj2wn' SELECT * FROM [TableDefinitions] WHERE [Id] = 'bu99sj2wu' AND [AppId] = 'bu99sj2wn'
Insert
The Quickbase provider inserts a new row into the TableDefinitions table, creating a table definition with the specified name, description, record names, and associated AppId.
For example:
INSERT INTO TableDefinitions(Name, Description, SingleRecordName, PluralRecordName, AppId) VALUES('tableFromAPI1', 'description1', 'record', 'records', 'bvajvby2n')
Update
The Quickbase provider updates an existing row in the TableDefinitions table identified by the Id field while modifying its values.
For example:
UPDATE TableDefinitions Name='UpdatedTableUsingAPI1', Description='Updated description for UpdatedTableUsingAPI1' WHERE [Id] = 'bvajv8gg2' AND AppId = 'bvajvby2n'
Delete
The Quickbase provider deletes a row from the TableDefinitions table identified by the Id field based on specified criteria.For example:
DELETE FROM [TableDefinitions] WHERE [Id] = 'bvajv8gg2' AND [AppId] = 'bvajvby2n'
Columns
| Name | Type | ReadOnly | References | SupportedOperators | Description |
| Id [KEY] | String | True | = |
The unique identifier (dbid) of the table. | |
| Name | String | False |
The name of the table. | ||
| Alias | String | True |
The automatically-created table alias for the table. | ||
| Description | String | False |
The description of the table, as configured by an application administrator. | ||
| Created | Datetime | True |
The time and date when the table was created, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone). | ||
| Updated | Datetime | True |
The time and date when the table schema or data was last updated, in the ISO 8601 time format YYYY-MM-DDThh:mm:ss.sssZ (in UTC time zone). | ||
| NextRecordId | Int64 | True |
The incremental Record Id that will be used when the next record is created, as determined when the API call was ran. | ||
| NextFieldId | Int64 | True |
The incremental Field Id that will be used when the next field is created, as determined when the API call was ran. | ||
| DefaultSortFieldId | Int64 | True |
The id of the field that is configured for default sorting. | ||
| DefaultSortOrder | String | True |
The configuration of the default sort order on the table. | ||
| KeyFieldId | Int64 | True |
The id of the field that is configured to be the key on this table, which is usually the Quickbase Record Id. | ||
| SingleRecordName | String | False |
The builder-configured singular noun of the table. | ||
| PluralRecordName | String | False |
The builder-configured plural noun of the table. | ||
| SizeLimit | String | True |
The size limit for the table. | ||
| SpaceUsed | String | True |
The amount of space currently being used by the table. | ||
| SpaceRemaining | String | True |
The amount of space remaining for use by the table. | ||
| AppId | String | True |
Apps.Id | = |
The unique identifier for this application. |