db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chaa...@apache.org
Subject svn commit: r757513 - in /db/derby/docs/trunk/src/ref: refderby.ditamap rrefupdatestatsproc.dita
Date Mon, 23 Mar 2009 19:21:58 GMT
Author: chaase3
Date: Mon Mar 23 19:21:58 2009
New Revision: 757513

URL: http://svn.apache.org/viewvc?rev=757513&view=rev
Log:
DERBY-3787: Document the new system stored procedure SYSCS_UTIL.SYSCS_UPDATE_STATISTICS which
was added as part of DERBY-269

This patch adds a new topic, rrefupdatestatsproc.dita, and updates the map file.

Documentation completed by Laura Stewart.

Patch: DERBY-3787-2.diff

Added:
    db/derby/docs/trunk/src/ref/rrefupdatestatsproc.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=757513&r1=757512&r2=757513&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Mon Mar 23 19:21:58 2009
@@ -404,6 +404,8 @@
 </topicref>
 <topicref href="rrefsetuseraccess.dita" navtitle="SYSCS_UTIL.SYSCS_SET_USER_ACCESS stored
procedure">
 </topicref>
+<topicref href="rrefupdatestatsproc.dita" navtitle="SYSCS_UTIL.SYSCS_UPDATE_STATISTICS
stored procedure">
+</topicref>
 </topicref>
 <topicref href="rrefsyscsdiagtables.dita" navtitle="SYSCS_DIAG diagnostic tables and functions">
 </topicref>

Added: db/derby/docs/trunk/src/ref/rrefupdatestatsproc.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefupdatestatsproc.dita?rev=757513&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefupdatestatsproc.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefupdatestatsproc.dita Mon Mar 23 19:21:58 2009
@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- 
+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.
+-->
+<!DOCTYPE reference PUBLIC "-//OASIS//DTD DITA Reference//EN"
+ "../dtd/reference.dtd">
+<reference id="rrefupdatestatsproc" xml:lang="en-us">
+<title>SYSCS_UTIL.SYSCS_UPDATE_STATISTICS system procedure</title>
+<refbody>
+<section><p>The SYSCS_UTIL.SYSCS_UPDATE_STATISTICS system procedure
+updates the cardinality statistics, or creates the statistics if they
+do not exist, for the index that you specify or for all of the indexes
+on a table. <ph>Derby</ph> uses cardinality statistics to determine
+the optimal query plan during the compilation of a query. If the statistics
+are missing, <ph>Derby</ph> might use a query plan which is not the
+most efficient plan. </p><p>For more information on cardinality statistics,
+see "Working with cardinality statistics" in the <ph
+conref="../conrefs.dita#pub/cittuning"></ph> guide.</p></section>
+<section><title>Syntax</title><codeblock>SYSCS_UTIL.SYSCS_UPDATE_STATISTICS(SCHEMANAME,
TABLENAME, INDEXNAME)</codeblock><note>You
+can specify <userinput>null</userinput> for the INDEXNAME to update
+any existing statistics and create statistics for those statistics
+that are missing.</note></section>
+<section><title>Examples</title><p>In the following example, the
system
+procedure updates statistics for the index PAY_DESC on the SAMP.EMPLOYEE
+table:</p><codeblock>SYSCS_UTIL.SYSCS_UPDATE_STATISTICS('SAMP','EMPLOYEE','PAY_DESC');
+</codeblock><p>In the following example, <userinput>null</userinput>
is
+specified instead of an index name. For all of the indexes, the existing
+statistics are updated and statistics are created for any missing
+statistics on the EMPLOYEE table in the SAMP schema.</p><codeblock>SYSCS_UTIL.SYSCS_UPDATE_STATISTICS('SAMP',
'EMPLOYEE', null); 
+</codeblock></section>
+</refbody>
+</reference>
+

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



Mime
View raw message