集合索引是虚拟列上的普通 MySQL 索引，这些虚拟列从集合中的文档中提取数据。由于 MySQL 无法直接索引 JSON 值，因此要启用集合的索引，您需要提供一个 JSON 文档，该文档指定索引要使用的文档字段。您将定义索引的 JSON 文档作为 IndexDefinition 参数传递给 Collection.createIndex(name, IndexDefinition) 方法。此通用示例（不同编程语言的实际语法可能会有所不同）展示了如何基于字段 count 创建一个强制的整数类型索引

myCollection.createIndex("count", {fields:[{"field": "$.count", "type":"INT", required:true}]});

此示例展示了如何基于文本字段创建索引：在本例中为邮政编码。对于文本字段，您必须指定索引的长度前缀，这是 MySQL 服务器的要求

myCollection.createIndex("zip", {fields: [{field: "$.zip", type: "TEXT(10)"}]})

有关 IndexDefinition 格式以及支持索引的字段类型的详细信息，请参阅 定义索引。

如果名称相同的索引已存在或索引定义格式不正确，则 Collection.createIndex() 方法将失败并返回错误。名称参数是必需的，必须是 SQL 语句 CREATE INDEX 接受的有效索引名称。

要删除现有索引，请使用 collection.dropIndex(string name) 方法。这将删除具有传递名称的索引，并且如果命名索引不存在，则操作会静默成功。

集合的索引将存储为虚拟列。要验证创建的索引，请使用 SHOW INDEX 语句。例如，要从 MySQL Shell 使用此 SQL

session.runSql('SHOW INDEX FROM mySchema.myCollection');

要基于集合中的文档创建索引，您需要创建一个 IndexDefinition JSON 文档。本节将说明您可以在此类 JSON 文档中使用的有效字段以定义索引。

要定义文档字段以对其进行索引，该字段的类型必须在整个集合中保持一致。换句话说，类型必须一致。用于定义索引的 JSON 文档（例如 {fields: [{field: '$.username', type: 'TEXT'}]}）可以包含以下内容

在 IndexDefinition 或 IndexField JSON 文档中包含任何其他未在上面描述的字段会导致 collection.createIndex() 失败并返回错误。

如果未指定索引类型或将其设置为 INDEX，则创建的索引与通过发出 CREATE INDEX 创建的索引相同。如果索引类型设置为 SPATIAL，则创建的索引与通过发出 CREATE INDEX（使用 SPATIAL 关键字）创建的索引相同，请参阅 空间索引优化 和 创建空间索引。例如

myCollection.createIndex('myIndex', //
{fields: [{field: '$.myGeoJsonField', type: 'GEOJSON', required: true}], type:'SPATIAL'})

这是一个基于多个字段创建索引的示例

myCollection.createIndex('myIndex', {fields: [{field: '$.myField', type: 'TEXT'}, //
{field: '$.myField2', type: 'TEXT(10)'}, {field: '$.myField3', type: 'INT'}]})

索引字段的值使用标准的 MySQL 类型转换从 JSON 转换为 IndexField 描述中指定的类型（请参阅 表达式求值中的类型转换），但 GEOJSON 类型除外，它使用 ST_GeomFromGeoJSON() 函数进行转换。这意味着，当在 IndexField 描述中使用数值类型时，实际的非数值字段值将转换为 0。

IndexField 中的 options 和 srid 字段只能在 type 设置为 GEOJSON 时存在。如果存在，它们将用作将 GEOJSON 数据转换为 MySQL 本地 GEOMETRY 值时的 ST_GeomFromGeoJSON() 的参数。

以下数据类型受文档字段支持。类型名称在 type 字段中使用时不区分大小写。

X DevAPI 支持通过将 IndexField 描述中的布尔值 array 字段设置为 true 来创建基于数组字段的索引。例如，要基于 emails 数组字段创建索引

collection.createIndex("emails_idx", //
    {fields: [{"field": "$.emails", "type":"CHAR(128)", "array": true}]});

基于数组创建索引的以下限制适用