/usr/share/doc/cl-sql/html/delete-instance-records.html is in cl-sql 6.7.0-1.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 | <?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>DELETE-INSTANCE-RECORDS</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-oodml.html" title="Object Oriented Data Manipulation Language (OODML)" /><link rel="prev" href="instance-refreshed.html" title="INSTANCE-REFRESHED" /><link rel="next" href="update-records-from-instance.html" title="UPDATE-RECORDS-FROM-INSTANCE" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">DELETE-INSTANCE-RECORDS</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="instance-refreshed.html">Prev</a> </td><th width="60%" align="center">Object Oriented Data Manipulation Language (OODML)</th><td width="20%" align="right"> <a accesskey="n" href="update-records-from-instance.html">Next</a></td></tr></table><hr /></div><div class="refentry"><a id="delete-instance-records"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>DELETE-INSTANCE-RECORDS — Delete SQL records represented by a <a class="glossterm" href="glossary.html#gloss-view-class"><em class="glossterm">View Class</em></a>
object.<strong>Function</strong></p></div><div class="refsect1"><a id="idp75925424"></a><h2>Syntax</h2><pre class="synopsis">
<code class="function">delete-instance-records</code> <em class="replaceable"><code>object</code></em> => <span class="returnvalue"></span></pre></div><div class="refsect1"><a id="idp75928496"></a><h2>Arguments and Values</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>object</code></em></span></dt><dd><p>
An instance of a <a class="glossterm" href="glossary.html#gloss-view-class"><em class="glossterm">View
Class</em></a>.
</p></dd></dl></div></div><div class="refsect1"><a id="idp75932768"></a><h2>Description</h2><p>Deletes the records represented by
<em class="parameter"><code>object</code></em> in the appropriate table of the
database associated with <em class="parameter"><code>object</code></em>. If
<em class="parameter"><code>object</code></em> is not yet associated with a
database, an error is signalled.
</p></div><div class="refsect1"><a id="idp75936176"></a><h2>Examples</h2><pre class="screen">
(def-view-class tab ()
((a :initarg :a :type integer :db-kind :key)
(b :initarg :b :type string)))
=> #<Standard-Db-Class TAB {49B01845}>
(create-view-from-class 'tab)
=>
(defvar obj (let ((*db-auto-sync* t))
(make-instance 'tab :a 5 :b "the string")))
=> OBJ
(start-sql-recording :type :both)
=>
(delete-instance-records obj)
;; 2004-07-17 11:07:19 foo/bar/baz => DELETE FROM tab WHERE tab.a = 5
;; 2004-07-17 11:07:19 foo/bar/baz <= T
=>
</pre></div><div class="refsect1"><a id="idp75938256"></a><h2>Side Effects</h2><p>
Deletes data from the SQL database.
</p></div><div class="refsect1"><a id="idp75939568"></a><h2>Affected by</h2><p>
Permissions granted by the SQL database to the user in the
database connection.
</p></div><div class="refsect1"><a id="idp75940992"></a><h2>Exceptional Situations</h2><p>
An exception may be signaled if the database connection user
does not have sufficient privileges to modify the database. An
error of type <span class="type">sql-database-error</span> is signalled if
<em class="replaceable"><code>object</code></em> is not associated with an
active database.
</p></div><div class="refsect1"><a id="idp75943328"></a><h2>See Also</h2><table border="0" summary="Simple list" class="simplelist"><tr><td><a class="link" href="update-records.html" title="UPDATE-RECORDS"><code class="function">update-records</code></a></td></tr><tr><td><a class="link" href="delete-records.html" title="DELETE-RECORDS"><code class="function">delete-records</code></a></td></tr><tr><td><a class="link" href="update-records-from-instance.html" title="UPDATE-RECORDS-FROM-INSTANCE"><code class="function">update-records-from-instance</code></a></td></tr></table></div><div class="refsect1"><a id="idp75948720"></a><h2>Notes</h2><p>
Instances are referenced in the database by values stored in
the key slots. If
<code class="function">delete-records-from-instance</code> is called
with an instance of a class that does not contain any keys,
then all records in that table will be deleted.
</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="instance-refreshed.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ref-oodml.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="update-records-from-instance.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">INSTANCE-REFRESHED </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> UPDATE-RECORDS-FROM-INSTANCE</td></tr></table></div></body></html>
|