CustomIndex

Represents an index used to increase the speed of queries.

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

CustomIndex components have the suffix .indx-meta and are stored in the customindexfolder.

Version 

Introduced in API version 50.0.

Special Access Rules 

To use this metadata and create a custom index, review Indexes in Best Practices for Deployments with Large Data Volumes, and then contact Salesforce Customer Support.

Fields 

allowNullValues 

  • Type: boolean
  • Required: No
  • Description: Indicates whether null values are allowed in the index (true) or not (false). The default value is false.

booleanIndexedValue 

  • Type: boolean
  • Required: No
  • Introduced: API version 61.0
  • Description: Indicates whether boolean fields are indexed (true) or not (false).

Declarative Metadata Sample Definition 

The following is an example of a CustomIndex component.

1<?xml version="1.0" encoding="UTF-8" ?>
2<CustomIndex xmlns="http://soap.sforce.com/2006/04/metadata">
3    <allowNullValues>false</allowNullValues>
4    <booleanIndexedValue>true</booleanIndexedValue>
5</CustomIndex>

Wildcard Support in the Manifest File 

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.