mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-31 16:28:55 +00:00
730ae1c76c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@345637 c90b9560-bf6c-de11-be94-00142212c4b1
108 lines
2.6 KiB
XML
108 lines
2.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<refentry xml:id="mysql-xdevapi-collection.dropindex" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>Collection::dropIndex</refname>
|
|
<refpurpose>Drop collection index</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>bool</type><methodname>mysql_xdevapi\Collection::dropIndex</methodname>
|
|
<methodparam><type>string</type><parameter>index_name</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Drop a collection index.
|
|
</para>
|
|
<para>
|
|
This operation does not yield an error if the index does not exist, but
|
|
&false; is returned in that case.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>index_name</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Name of collection index to drop.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&true; if the DROP INDEX operation succeeded, otherwise &false;.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>mysql_xdevapi\Collection::dropIndex</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?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 'An index named 'myindex' was found, and dropped.';
|
|
}
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
&example.outputs;
|
|
<screen>
|
|
<![CDATA[
|
|
An index named 'myindex' was found, and dropped.
|
|
]]>
|
|
</screen>
|
|
</example>
|
|
</refsect1>
|
|
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|