PHP Conference Japan 2024

Collection::dropIndex

(无版本信息可用,可能仅存在于 Git 中)

Collection::dropIndex删除集合索引

描述

public mysql_xdevapi\Collection::dropIndex(string $index_name): bool

删除集合索引。

如果索引不存在,此操作不会产生错误,但在这种情况下将返回false

参数

index_name

要删除的集合索引的名称。

返回值

如果 DROP INDEX 操作成功,则返回true,否则返回false

示例

示例 #1 mysql_xdevapi\Collection::dropIndex() 示例

<?php
$session
= mysql_xdevapi\getSession("mysqlx://user:password@localhost");

$session->sql("DROP DATABASE IF EXISTS addressbook")->execute();
$session->sql("CREATE DATABASE addressbook")->execute();

$schema = $session->getSchema("addressbook");
$create = $schema->createCollection("people");

// ...

$collection = $schema->getCollection("people");

$collection->createIndex(
'myindex',
'{"fields": [{"field": "$.name", "type": "TEXT(25)", "required": true}], "unique": false}'
);

// ...

if ($collection->dropIndex('myindex')) {
echo
"找到名为 'myindex' 的索引,并已删除。;
}
?>

以上示例将输出

An index named 'myindex' was found, and dropped.
添加注释

用户贡献的注释

此页面没有用户贡献的注释。
To Top