Skip to content

CustomIndex

The CustomIndex column on a container field allows for the generation of one or more database indexes on one or more columns of the generated database table.

Provide details of the index(es) to be created in a JSON array following the CustomIndexDefinition contract. The following properties may be provided for each index:

  • IncludeParentId (boolean): Whether to include the foreign key to the container's parent in the index. If not provided parent id will be included.
  • IndexName (string): The name of the index. All fields with the same index name become part of the same index. If not provided, index will include only this field and will receive a default name.
  • IsUnique (boolean): Whether the index is unique. If not provided index will be non-unique.
  • Order (integer): The position of this field relative to other members of the index. If order is provided for any field it must be provided for all fields. If it is not provided fields will appear in the index in the order they are processed.
  • ParentIdOrder (integer): The position of the parent id relative to other fields. If order is provided for any field it must be provided for all fields including parent Id. If it is not provided, parent Id will appear first.

Examples

Single-field unique index

To create a unique index on a single field that does not include the parent, provide the following value for CustomIndex on that field:

[{"IsUnique": true, "IncludeParentId": false}]

Multiple indexes involving multiple fields

On a container with fields FirstName, LastName, and UserName, provide the values below for CustomIndex to generate the following indexes:

  • a unique index called UniqueName on FirstName and LastName that includes the parent instance ID
  • a non-unique index called NameLookup on UserName and LastName, in that order and not including parent instance ID
  • a unique index on UserName that does not include the parent instance id.

CustomIndex values for each field:

  • FirstName: 
[{
    "IndexName":"UniqueName", 
    "IsUnique":true, 
    "IncludeParentId": true
}]
  • LastName: 
[{
    "IndexName":"UniqueName", 
    "IsUnique":true, 
    "IncludeParentId": true
}, 
{
    "IndexName":"NameLookup",
    "IsUnique":false, 
    "Order": 2, 
    "IncludeParentId": false
}]
  • UserName: 
[{
    "IsUnique":true, 
    "IncludeParentId": false
}, 
{
    "IndexName":"NameLookup",
    "IsUnique":false, 
    "Order": 1, 
    "IncludeParentId": false
}]

Controls

The CustomIndex column applies to the following controls: