db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chaa...@apache.org
Subject svn commit: r1598692 - in /db/derby/docs/trunk/src/ref: refderby.ditamap rrefsyscspeekidentity.dita
Date Fri, 30 May 2014 18:20:29 GMT
Author: chaase3
Date: Fri May 30 18:20:28 2014
New Revision: 1598692

URL: http://svn.apache.org/r1598692
Log:
DERBY-6580  Document the new SYSCS_UTIL.SYSCS_PEEK_AT_IDENTITY function

Added a new Reference Manual topic, modified the map file.

Patches: DERBY-6580-2.diff

Added:
    db/derby/docs/trunk/src/ref/rrefsyscspeekidentity.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=1598692&r1=1598691&r2=1598692&view=diff
==============================================================================
--- db/derby/docs/trunk/src/ref/refderby.ditamap (original)
+++ db/derby/docs/trunk/src/ref/refderby.ditamap Fri May 30 18:20:28 2014
@@ -844,6 +844,7 @@ limitations under the License.
 </topicref>
 <topicref href="rref_syscs_get_xplain_mode.dita" navtitle="SYSCS_UTIL.SYSCS_GET_XPLAIN_MODE
system function"></topicref>
 <topicref href="rref_syscs_get_xplain_schema.dita" navtitle="SYSCS_UTIL.SYSCS_GET_XPLAIN_SCHEMA
system function"></topicref>
+<topicref href="rrefsyscspeekidentity.dita" navtitle="SYSCS_UTIL.SYSCS_PEEK_AT_IDENTITY
system function"/>
 <topicref href="rrefsyscspeeksequence.dita" navtitle="SYSCS_UTIL.SYSCS_PEEK_AT_SEQUENCE
system function"></topicref>
 </topicref>
 <topicref href="crefsqlbuiltinsystemprocedures.dita" navtitle="Built-in system procedures">

Added: db/derby/docs/trunk/src/ref/rrefsyscspeekidentity.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/trunk/src/ref/rrefsyscspeekidentity.dita?rev=1598692&view=auto
==============================================================================
--- db/derby/docs/trunk/src/ref/rrefsyscspeekidentity.dita (added)
+++ db/derby/docs/trunk/src/ref/rrefsyscspeekidentity.dita Fri May 30 18:20:28 2014
@@ -0,0 +1,59 @@
+<?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="rrefsyscspeekidentity" xml:lang="en-us">
+<title>SYSCS_UTIL.SYSCS_PEEK_AT_IDENTITY system function</title>
+<shortdesc>The <codeph>SYSCS_UTIL.SYSCS_PEEK_AT_IDENTITY</codeph> function
+allows users to observe the next value which will be issued for an identity
+column.</shortdesc>
+<refbody>
+<section>
+<p>This function can be used in databases which have been fully upgraded to
+<ph conref="../conrefs.dita#prod/productshortname"></ph> Release 10.11 or
+higher. (See "Upgrading a database" in the
+<ph conref="../conrefs.dita#pub/citdevelop"></ph> for more information.) In a
+database which has been fully upgraded to Release 10.11 or higher, identity
+values are produced by internal, system-managed sequence generators.
+<codeph>SYSCS_UTIL.SYSCS_PEEK_AT_IDENTITY</codeph> allows users to observe the
+next identity value without having to query the SYSSEQUENCES system table.</p>
+<p>This function has no meaning in a database which is at Release 10.10 or
+earlier.</p>
+<p>Querying the SYSSEQUENCES system table does not actually return the current
+identity value; it only returns an upper bound on that value, that is, the end
+of the chunk of identity values which has been preallocated but not actually
+used. The <codeph>SYSCS_UTIL.SYSCS_PEEK_AT_IDENTITY</codeph> function shows you
+the very next value which will be inserted into a table. Users should never
+directly query the SYSSEQUENCES table, because that will cause sequence
+generator concurrency to slow drastically.</p>
+</section>
+<refsyn><title>Syntax</title>
+<codeblock>BIGINT SYSCS_UTIL.SYSCS_PEEK_AT_IDENTITY(IN SCHEMANAME VARCHAR(128),
+IN TABLENAME VARCHAR(128))</codeblock>
+<p>As with all system functions, schema and object name arguments are
+case-sensitive.</p>
+</refsyn>
+<section><title>Execute privileges</title>
+<p>By default, all users have execute privileges on this function.</p>
+</section>
+<example><title>Example</title>
+<codeblock>VALUES SYSCS_UTIL.SYSCS_PEEK_AT_IDENTITY('APP', 'orders');</codeblock>
+</example>
+</refbody>
+</reference>

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



Mime
View raw message