svn commit: r999219 - in /db/derby/docs/trunk/src/ref: refderby.ditamap rrefsqljtruncatetable.dita

[bp...@apache.org]

Author: bpendleton
Date: Tue Sep 21 04:40:50 2010
New Revision: 999219

URL: http://svn.apache.org/viewvc?rev=999219&view=rev
Log:
DERBY-4802: Document the TRUNCATE TABLE command

This change adds a page to the reference manual describing the syntax and
primary behaviors of the TRUNCATE TABLE command.


Added:
    db/derby/docs/trunk/src/ref/rrefsqljtruncatetable.dita   (with props)
Modified:
    db/derby/docs/trunk/src/ref/refderby.ditamap

Modified: db/derby/docs/trunk/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/refderby.ditamap?rev=999219&r1=999218&r2=999219&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Tue Sep 21 04:40:50 2010
@@ -214,6 +214,7 @@ limitations under the License.
 <topicref href="rrefsqlj32268.dita" navtitle="SET SCHEMA statement"></topicref>
 </topicref>
 <topicref href="rrefsqlj41360.dita" navtitle="SELECT statement"></topicref>
+<topicref href="rrefsqljtruncatetable.dita" navtitle="TRUNCATE TABLE statement"></topicref>
 <topicref href="rrefsqlj26498.dita" navtitle="UPDATE statement"></topicref>
 </topicref>
 <topicref href="rrefclauses.dita" navtitle="SQL Clauses">

Added: db/derby/docs/trunk/src/ref/rrefsqljtruncatetable.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsqljtruncatetable.dita?rev=999219&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsqljtruncatetable.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefsqljtruncatetable.dita Tue Sep 21 04:40:50 2010
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="utf-8"?>
+ 
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<!-- 
+Licensed to the Apache Software Foundation (ASF) under one or more
+contributor license agreements.  See the NOTICE file distributed with
+this work for additional information regarding copyright ownership.
+The ASF licenses this file to You under the Apache License, Version 2.0
+(the "License"); you may not use this file except in compliance with
+the License.  You may obtain a copy of the License at      
+
+http://www.apache.org/licenses/LICENSE-2.0  
+
+Unless required by applicable law or agreed to in writing, software  
+distributed under the License is distributed on an "AS IS" BASIS,  
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  
+See the License for the specific language governing permissions and  
+limitations under the License.
+-->
+<reference id="rrefsqljtruncatetable" xml:lang="en-us">
+<title>TRUNCATE TABLE statement</title>
+<prolog><metadata>
+<keywords><indexterm>TRUNCATE TABLE statement</indexterm><indexterm><indexterm>SQL
+statements</indexterm>TRUNCATE TABLE</indexterm><indexterm>tables<indexterm>space</indexterm></indexterm>
+</keywords>
+</metadata></prolog>
+<refbody>
+<section> <p>The TRUNCATE TABLE statement allows you to quickly remove all
+content from the specified table and return it to its initial empty state.</p>
+<p>To truncate a table, you must either
+be the 
+<xref href="rrefattrib26867.dita#rrefattrib26867">database owner</xref>
+or the table owner.</p>
+<p>You cannot truncate system tables with this statement.</p></section>
+<refsyn><title>Syntax</title> <codeblock><b>TRUNCATE TABLE <i><xref href="rreftablename.dita#rreftablename">table-Name</xref></i></b></codeblock>
+</refsyn>
+<example><title>Examples</title>
+<p>To truncate the entire <codeph>Flights</codeph> table,
+use the following statement:
+<codeblock>
+TRUNCATE TABLE Flights;
+</codeblock></p>
+</example>
+</refbody>
+</reference>

Propchange: db/derby/docs/trunk/src/ref/rrefsqljtruncatetable.dita
------------------------------------------------------------------------------
    svn:eol-style = native