/usr/share/doc/cl-sql/html/drop-index.html is in cl-sql 6.5.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>DROP-INDEX</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1" /><link rel="home" href="index.html" title="CLSQL Users' Guide" /><link rel="up" href="ref-fddl.html" title="Functional Data Definition Language (FDDL)" /><link rel="prev" href="create-index.html" title="CREATE-INDEX" /><link rel="next" href="list-indexes.html" title="LIST-INDEXES" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">DROP-INDEX</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="create-index.html">Prev</a> </td><th width="60%" align="center">Functional Data Definition Language (FDDL)</th><td width="20%" align="right"> <a accesskey="n" href="list-indexes.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="drop-index"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>DROP-INDEX — Drop a database index.<strong>Function</strong></p></div><div class="refsect1"><a id="idp62912240"></a><h2>Syntax</h2><pre class="synopsis">
<code class="function">drop-index</code> <em class="replaceable"><code>name</code></em> &key <em class="replaceable"><code>if-does-not-exist</code></em> <em class="replaceable"><code>on</code></em> <em class="replaceable"><code>database</code></em> => <span class="returnvalue"></span></pre></div><div class="refsect1"><a id="idp62915920"></a><h2>Arguments and Values</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>name</code></em></span></dt><dd><p>
The name of the index as a string, symbol or SQL expression.
</p></dd><dt><span class="term"><em class="parameter"><code>on</code></em></span></dt><dd><p>
The name of a table as a string, symbol or SQL
expression.
</p></dd><dt><span class="term"><em class="parameter"><code>database</code></em></span></dt><dd><p>
A database object which defaults to
<span class="symbol">*default-database*</span>.
</p></dd><dt><span class="term"><em class="parameter"><code>if-does-not-exist</code></em></span></dt><dd><p>
A symbol. Meaningful values are <span class="symbol">:ignore</span>
or <span class="symbol">:error</span> (the default).
</p></dd></dl></div></div><div class="refsect1"><a id="idp62926144"></a><h2>Description</h2><p>Drops the index called <em class="parameter"><code>name</code></em> in
<em class="parameter"><code>database</code></em> which defaults to
<span class="symbol">*default-database*</span>. If the index does not exist
and <em class="parameter"><code>if-does-not-exist</code></em> is
<span class="symbol">:ignore</span> then <em class="parameter"><code>drop-index</code></em>
returns <code class="constant">NIL</code> whereas an error is signalled if
<em class="parameter"><code>if-does-not-exist</code></em> is
<span class="symbol">:error</span>.
</p><p>
The argument <em class="parameter"><code>on</code></em> allows the optional
specification of a table to drop the index from. This is
required for compatability with MySQL.
</p></div><div class="refsect1"><a id="idp62933120"></a><h2>Examples</h2><pre class="screen">
(index-exists-p [foo])
=> T
(drop-index [foo] :if-does-not-exist :ignore)
=>
(index-exists-p [foo])
=> NIL
</pre></div><div class="refsect1"><a id="idp62934656"></a><h2>Side Effects</h2><p>
An index is dropped in <em class="parameter"><code>database</code></em>.
</p></div><div class="refsect1"><a id="idp62936432"></a><h2>Affected by</h2><p>
<span class="symbol">*default-database*</span>
</p></div><div class="refsect1"><a id="idp62937968"></a><h2>Exceptional Situations</h2><p>
An error is signalled if <em class="parameter"><code>name</code></em> is not a
string, symbol or SQL expression. An error of type
<span class="symbol">sql-database-data-error</span> is signalled if
<em class="parameter"><code>name</code></em> doesn't exist and
<em class="parameter"><code>if-does-not-exist</code></em> has a value of
<span class="symbol">:error</span>.
</p></div><div class="refsect1"><a id="idp62941856"></a><h2>See Also</h2><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="link" href="create-index.html" title="CREATE-INDEX"><code class="function">create-index</code></a></td></tr><tr><td><a class="link" href="list-indexes.html" title="LIST-INDEXES"><code class="function">list-indexes</code></a></td></tr><tr><td><a class="link" href="index-exists-p.html" title="INDEX-EXISTS-P"><code class="function">index-exists-p</code></a></td></tr></table></div><div class="refsect1"><a id="idp62946608"></a><h2>Notes</h2><p>
The <em class="parameter"><code>if-does-not-exist</code></em> and
<em class="parameter"><code>on</code></em> keyword arguments to
<code class="function">drop-index</code> are <span class="application"><span class="emphasis"><em>CLSQL</em></span></span> extensions. The
keyword argument <em class="parameter"><code>on</code></em> is provided for
compatibility with MySQL.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="create-index.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ref-fddl.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="list-indexes.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">CREATE-INDEX </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> LIST-INDEXES</td></tr></table></div></body></html>
|