The COLLECTION_DETAILS collection holds the structural details of all collections that are enabled in current design projects or have otherwise been requested.
A COLLECTION_DETAILS entry always has a corresponding COLLECTION_RESOURCE entry and their name, nativeIdentifier, projectId and connectorId attributes always match.
{
"_id" : "",
"name" : "",
"nativeIdentifier" : "",
"projectId" : "",
"connectorId" : "",
"fields" : [],
"constraints" : []
}
Attribute |
Value |
Note |
_id |
A unique identifier for the collection resource. |
|
name |
The given name for the collection resource |
By default, it is the simple name of the datasource collection |
nativeIdentifier |
The full native name of the collection |
Generally of the form <container>.<name> e.g.: "public.employees" |
projectId |
Reference to the design project (PROJECT_WIP entry) this collection belongs to. |
|
connectorId |
Reference to the connector (CONNECTOR entry) this collection is accessed through. |
|
fields |
A list of all the fields available on the collection in the AttributeDescriptor format. |
|
constraints |
A list of all the PK and FK constraints on the collection in the ConstraintDefinition format |
|
predicate |
A DTSPredicate that defines the fundamental filter applied to this collection |
Only records that match the filter will be allowed through the system. If the record request contains a query, it will be compounded (using AND) with the fundamental filter defined here. |
Published Project Usage
Objects of the COLLECTION_DETAILS form will also be used to describe collections in the connectors of published projects.