Команда ReQL: indexRename

Синтаксис команды

table.indexRename(oldIndexName, newIndexName) → object

Описание

Переименовать существующий вторичный индекс в таблице. Если optArg overwrite указан как true, ранее существовавший индекс с новым именем будет удален, и индекс будет переименован. Если overwrite является false (по умолчанию), будет выброшено исключение, если новый индекс с таким именем уже существует.

Значение возврата при успехе будет объектом формата {"renamed": 1}, или {"renamed": 0} если старое и новое имя совпадают.

Будет выброшено исключение, если старое имя индекса не существует, если новое имя индекса уже используется и overwrite равно false, или если старое или новое имя индекса совпадают с именем поля первичного ключа.

Пример: Переименование индекса в таблице комментариев.

r.table("comments").indexRename("postId", "messageId").run(conn);

Пример: Переименование индекса в таблице пользователей, перезаписывая любой существующий индекс с новым именем.

r.table("users").indexRename("mail", "email").optArg("overwrite", true)
 .run(conn);