Команда ReQL: index_rename

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

table.index_rename(old_index_name, new_index_name[, overwrite=False]) → object

Описание

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

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

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

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

r.table('comments').index_rename('post_id', 'message_id').run(conn)