Collection::createIndex

(No version information available, might only be in Git)

Collection::createIndex — Створює індекс для колекції

Опис

public mysql_xdevapi\Collection::createIndex(string $index_name, string $index_desc_json): void

Створює індекс для колекції.

Видається виняток, якщо індекс із таким ім'ям вже існує, або якщо визначення індексу сформовано неправильно.

Список параметрів

index_name

Ім'я індексу, який потрібно створити. Має бути коректним ім'ям індексу, допустимим для SQL-запиту CREATE INDEX

index_desc_json

Визначення індексу для створення. Містить масив об'єктів IndexField, і кожен об'єкт описує один елемент документа для додавання до індексу, а також необов'язковий рядок для типу індексу, який може бути INDEX (за замовчуванням) або SPATIAL.

Один опис IndexField складається з наступних полів:

• field: рядок, повний шлях документа до елемента документа чи поля для індексації

• type: рядок, один із підтримуваних типів стовпців SQL для зіставлення поля. Для числових типів можна додати необов'язкове ключове слово UNSIGNED. Для типу TEXT може бути додана довжина для індексації.

• required: логічне значення (необов'язкове) true, якщо поле має бути обов'язковим у документі. За замовчуванням використовується значення**false, за исключением типаGEOJSON, де за замовчуванням використовується значенняtrue**

• options: ціле число, (необов'язкове) прапори спеціальних опцій для використання при декодуванні данихGEOJSON

• srid: ціле число (необов'язкове) значення srid для використання при декодуванні данихGEOJSON

Помилково включати інші поля, не описані вище, до документів IndexDefinition або IndexField.

Значення, що повертаються

Приклади

Приклад #1 Приклад використання mysql_xdevapi\Collection::createIndex()****

Loading...
▶