You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by ch...@apache.org on 2013/10/11 19:04:17 UTC
svn commit: r1531356 - in /db/derby/docs/branches/10.10/src/ref:
refderby.ditamap rrefcrsrgpc1.dita rrefdmdfns1.dita rrefgpc1.dita
rrefjdbc15905.dita rrefpgc1.dita
Author: chaase3
Date: Fri Oct 11 17:04:16 2013
New Revision: 1531356
URL: http://svn.apache.org/r1531356
Log:
DERBY-6376 Revise DatabaseMetaData section of Reference Manual
Merged patch DERBY-6376.diff to 10.10 doc branch from trunk revision 1531348.
Modified:
db/derby/docs/branches/10.10/src/ref/refderby.ditamap
db/derby/docs/branches/10.10/src/ref/rrefcrsrgpc1.dita
db/derby/docs/branches/10.10/src/ref/rrefdmdfns1.dita
db/derby/docs/branches/10.10/src/ref/rrefgpc1.dita
db/derby/docs/branches/10.10/src/ref/rrefjdbc15905.dita
db/derby/docs/branches/10.10/src/ref/rrefpgc1.dita
Modified: db/derby/docs/branches/10.10/src/ref/refderby.ditamap
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/refderby.ditamap?rev=1531356&r1=1531355&r2=1531356&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/refderby.ditamap (original)
+++ db/derby/docs/branches/10.10/src/ref/refderby.ditamap Fri Oct 11 17:04:16 2013
@@ -1055,11 +1055,7 @@ URL syntax"></topicref>
</topicref>
<topicref collection-type="family" href="rrefjdbc15905.dita" navtitle="java.sql.DatabaseMetaData interface">
<topicref href="rrefdmrs.dita" navtitle="DatabaseMetaData result sets"></topicref>
-<topicref href="rrefgpc1.dita" navtitle="java.sql.DatabaseMetaData.getProcedureColumns method">
-</topicref>
-<topicref href="rrefpgc1.dita" navtitle="Parameters to getProcedureColumns">
-</topicref>
-<topicref href="rrefcrsrgpc1.dita" navtitle="Columns in the ResultSet returned by getProcedureColumns">
+<topicref href="rrefcrsrgpc1.dita" navtitle="Columns in the ResultSets returned by getFunctionColumns and getProcedureColumns">
</topicref>
<topicref href="rrefdmdfns1.dita" navtitle="java.sql.DatabaseMetaData.getBestRowIdentifier method">
</topicref>
Modified: db/derby/docs/branches/10.10/src/ref/rrefcrsrgpc1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefcrsrgpc1.dita?rev=1531356&r1=1531355&r2=1531356&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefcrsrgpc1.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefcrsrgpc1.dita Fri Oct 11 17:04:16 2013
@@ -18,14 +18,17 @@ See the License for the specific languag
limitations under the License.
-->
<reference id="rrefcrsrgpc1" xml:lang="en-us">
-<title>Columns in the ResultSet returned by getProcedureColumns</title>
+<title>Columns in the ResultSets returned by getFunctionColumns and getProcedureColumns</title>
<refbody>
-<section><p>Columns in the <i>ResultSet</i> returned by <i>getProcedureColumns</i> are
-as described by the API. Further details for some specific columns are shown
-in the following table.</p>
+<section><p>Columns in the <i>ResultSet</i>s returned by
+<i>getFunctionColumns</i> and <i>getProcedureColumns</i> are
+as described by the API.</p>
+<p>The following table shows
+<ph conref="../conrefs.dita#prod/productshortname"></ph>-specific details for
+some specific columns returned by <i>getFunctionColumns</i>.</p>
<table frame="all"><title>Columns in the <i>ResultSet</i> returned by
-<i>getProcedureColumns</i></title>
-<desc>This table lists and describes the columns in the <i>ResultSet</i> returned by the <i>getProcedureColumns</i> method.</desc>
+<i>getFunctionColumns</i></title>
+<desc>This table lists and describes <ph conref="../conrefs.dita#prod/productshortname"></ph>-specific details for some columns in the <i>ResultSet</i> returned by the <i>getFunctionColumns</i> method.</desc>
<tgroup cols="2" colsep="1" rowsep="1">
<colspec colname="1" colnum="1" colwidth="30*"/>
<colspec colname="2" colnum="2" colwidth="70*"/>
@@ -37,24 +40,64 @@ in the following table.</p>
</thead>
<tbody>
<row>
-<entry colname="1">PROCEDURE_CAT</entry>
-<entry colname="2">Always "null" in
-<ph conref="../conrefs.dita#prod/productshortname"></ph>.</entry>
+<entry colname="1">COLUMN_TYPE</entry>
+<entry colname="2"><i>short</i> indicating what the row describes. Is always
+<i>DatabaseMetaData.functionColumnIn</i> for method parameters, unless the
+parameter is an array. If so, it is <i>DatabaseMetaData.functionColumnInOut</i>.
+It always returns <i>DatabaseMetaData.functionColumnReturn</i> for return
+values.</entry>
</row>
<row>
-<entry colname="1">PROCEDURE_SCHEM</entry>
-<entry colname="2">Schema for a Java procedure.</entry>
+<entry colname="1">TYPE_NAME</entry>
+<entry colname="2"><ph conref="../conrefs.dita#prod/productshortname"></ph>-specific
+name for the type.</entry>
</row>
<row>
-<entry colname="1">PROCEDURE_NAME</entry>
-<entry colname="2">The name of the procedure.</entry>
+<entry colname="1">NULLABLE</entry>
+<entry colname="2">Always returns <i>DatabaseMetaData.functionNoNulls</i> for
+primitive parameters and <i>DatabaseMetaData.functionNullable</i> for object
+parameters.</entry>
</row>
<row>
-<entry colname="1">COLUMN_NAME</entry>
-<entry colname="2">The name of the parameter (see <i>columnNamePattern</i> in
-<xref href="rrefpgc1.dita#rrefpgc1"></xref>).</entry>
+<entry colname="1">REMARKS</entry>
+<entry colname="2">A <i>String</i> which describes the Java type of the method
+parameter.</entry>
</row>
<row>
+<entry colname="1">ORDINAL_POSITION</entry>
+<entry colname="2">The ordinal position, starting from 1, for the input
+and output parameters for the function.</entry>
+</row>
+<row>
+<entry colname="1">METHOD_ID</entry>
+<entry colname="2">A <ph conref="../conrefs.dita#prod/productshortname"></ph>-specific
+column.</entry>
+</row>
+<row>
+<entry colname="1">PARAMETER_ID</entry>
+<entry colname="2">A <ph conref="../conrefs.dita#prod/productshortname"></ph>-specific
+column.</entry>
+</row>
+</tbody>
+</tgroup>
+</table>
+<p>The following table shows
+<ph conref="../conrefs.dita#prod/productshortname"></ph>-specific details for
+some specific columns returned by <i>getProcedureColumns</i>.</p>
+<table frame="all"><title>Columns in the <i>ResultSet</i> returned by
+<i>getProcedureColumns</i></title>
+<desc>This table lists and describes <ph conref="../conrefs.dita#prod/productshortname"></ph>-specific details for some columns in the <i>ResultSet</i> returned by the <i>getProcedureColumns</i> methods.</desc>
+<tgroup cols="2" colsep="1" rowsep="1">
+<colspec colname="1" colnum="1" colwidth="30*"/>
+<colspec colname="2" colnum="2" colwidth="70*"/>
+<thead>
+<row valign="bottom">
+<entry colname="1">Column</entry>
+<entry colname="2">Description</entry>
+</row>
+</thead>
+<tbody>
+<row>
<entry colname="1">COLUMN_TYPE</entry>
<entry colname="2"><i>short</i> indicating what the row describes. Is always
<i>DatabaseMetaData.procedureColumnIn</i> for method parameters, unless the
@@ -79,37 +122,9 @@ parameters.</entry>
parameter.</entry>
</row>
<row>
-<entry colname="1">COLUMN_DEF</entry>
-<entry colname="2">A <i>String</i> which describes the default value for the
-column (may be null).</entry>
-</row>
-<row>
-<entry colname="1">SQL_DATA_TYPE</entry>
-<entry colname="2">Reserved by the JDBC specification for future use.</entry>
-</row>
-<row>
-<entry colname="1">SQL_DATETIME_SUB</entry>
-<entry colname="2">Reserved by the JDBC specification for future use.</entry>
-</row>
-<row>
-<entry colname="1">CHAR_OCTET_LENGTH</entry>
-<entry colname="2">The maximum length of binary and character based columns (for
-any other data type, the returned value is a NULL).</entry>
-</row>
-<row>
<entry colname="1">ORDINAL_POSITION</entry>
<entry colname="2">The ordinal position, starting from 1, for the input
-and output parameters for a procedure.</entry>
-</row>
-<row>
-<entry colname="1">IS_NULLABLE</entry>
-<entry colname="2">A <i>String</i> describing the parameter's nullability
-(YES means the parameter can include NULLs, NO means it cannot).</entry>
-</row>
-<row>
-<entry colname="1">SPECIFIC_NAME</entry>
-<entry colname="2">The name which uniquely identifies this procedure within
-its schema.</entry>
+and output parameters for the procedure.</entry>
</row>
<row>
<entry colname="1">METHOD_ID</entry>
Modified: db/derby/docs/branches/10.10/src/ref/rrefdmdfns1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefdmdfns1.dita?rev=1531356&r1=1531355&r2=1531356&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefdmdfns1.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefdmdfns1.dita Fri Oct 11 17:04:16 2013
@@ -20,21 +20,22 @@ limitations under the License.
-->
<reference id="rrefdmdfns1" xml:lang="en-us">
<title>java.sql.DatabaseMetaData.getBestRowIdentifier method</title>
-<shortdesc>The <varname>java.sql.DatabaseMetaData.getBestRowIdentifier</varname> method
-looks for identifiers in a specific order. This order might not return a unique
-row.</shortdesc>
<prolog><metadata>
<keywords><indexterm>java.sql.DatabaseMetaData.getBestRowIdentifier method</indexterm>
<indexterm>methods<indexterm>java.sql.DatabaseMetaData.getBestRowIdentifier</indexterm></indexterm>
</keywords>
</metadata></prolog>
<refbody>
-<section><p>The <varname>java.sql.DatabaseMetaData.getBestRowIdentifier</varname> method
+<section>
+<p>The <i>java.sql.DatabaseMetaData.getBestRowIdentifier</i> method
+looks for identifiers in a specific order. This order might not return a unique
+row.</p>
+<p>The <i>java.sql.DatabaseMetaData.getBestRowIdentifier</i> method
looks for identifiers in the following order: <ul>
<li>A primary key on the table</li>
<li>A unique constraint or unique index on the table</li>
<li>All of the columns in the table</li>
-</ul></p><note>If the <varname>java.sql.DatabaseMetaData.getBestRowIdentifier</varname> method
+</ul></p><note>If the <i>java.sql.DatabaseMetaData.getBestRowIdentifier</i> method
does not find a primary key, unique constraint, or unique index, the method
must look for identifiers in all of the columns in the table. When the method
looks for identifiers this way, the method will always find a set of columns
Modified: db/derby/docs/branches/10.10/src/ref/rrefgpc1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefgpc1.dita?rev=1531356&r1=1531355&r2=1531356&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefgpc1.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefgpc1.dita Fri Oct 11 17:04:16 2013
@@ -1,38 +0,0 @@
-<?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="rrefgpc1" xml:lang="en-us">
-<title>java.sql.DatabaseMetaData.getProcedureColumns method</title>
-<prolog><metadata>
-<keywords><indexterm>java.sql.DatabaseMetaData.getProcedureColumns method</indexterm></keywords>
-</metadata></prolog>
-<refbody>
-<section><p><ph conref="../conrefs.dita#prod/productshortname"></ph> supports
-Java procedures. <ph conref="../conrefs.dita#prod/productshortname"></ph> allows
-you to call Java procedures within SQL statements. <ph conref="../conrefs.dita#prod/productshortname"></ph> returns
-information about the parameters in the <i>getProcedureColumns</i> call. If
-the corresponding Java method is overloaded, it returns information about
-each signature separately. <ph conref="../conrefs.dita#prod/productshortname"></ph> returns
-information for all Java procedures defined by CREATE PROCEDURE.</p></section>
-<section><p><i>getProcedureColumns</i> returns a <i>ResultSet</i>. Each row
-describes a single parameter or return value.</p></section>
-</refbody>
-</reference>
-
Modified: db/derby/docs/branches/10.10/src/ref/rrefjdbc15905.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefjdbc15905.dita?rev=1531356&r1=1531355&r2=1531356&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefjdbc15905.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefjdbc15905.dita Fri Oct 11 17:04:16 2013
@@ -24,8 +24,13 @@ limitations under the License.
<keywords><indexterm>java.sql.DatabaseMetaData interface</indexterm></keywords>
</metadata></prolog>
<refbody>
-<section><p>This section discusses <codeph>java.sql.DatabaseMetaData</codeph> functionality in <ph conref="../conrefs.dita#prod/productshortname"></ph>.
+<section><p>This section discusses <i>java.sql.DatabaseMetaData</i>
+functionality in <ph conref="../conrefs.dita#prod/productshortname"></ph>.
</p>
+<p>For methods that take a catalog parameter, always specify <i>null</i> for
+this parameter, since <ph conref="../conrefs.dita#prod/productshortname"></ph>
+does not support catalogs. Similarly, methods that return a catalog in the
+<i>ResultSet</i> will always return <i>null</i> in that column.</p>
<p>The <ph conref="../conrefs.dita#prod/productshortname"></ph> implementation
of the <i>getResultSetHoldability</i> method returns
<i>ResultSet.HOLD_CURSORS_OVER_COMMIT</i>.
Modified: db/derby/docs/branches/10.10/src/ref/rrefpgc1.dita
URL: http://svn.apache.org/viewvc/db/derby/docs/branches/10.10/src/ref/rrefpgc1.dita?rev=1531356&r1=1531355&r2=1531356&view=diff
==============================================================================
--- db/derby/docs/branches/10.10/src/ref/rrefpgc1.dita (original)
+++ db/derby/docs/branches/10.10/src/ref/rrefpgc1.dita Fri Oct 11 17:04:16 2013
@@ -1,67 +0,0 @@
-<?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="rrefpgc1" xml:lang="en-us">
-<title>Parameters to getProcedureColumns</title>
-<refbody>
-<section><p>For the <i>getProcedureColumns</i> method, the JDBC API defines the
-parameters shown in the following table.</p></section>
-<section>
-<table frame="all"><title><i>getProcedureColumns</i> method parameters</title>
-<desc>This table lists and describes the parameters of the <i>getProcedureColumns</i> method.</desc>
-<tgroup cols="2" colsep="1" rowsep="1">
-<colspec colname="1" colnum="1" colwidth="30*"/>
-<colspec colname="2" colnum="2" colwidth="70*"/>
-<thead>
-<row valign="bottom">
-<entry colname="1">Parameter</entry>
-<entry colname="2">Description</entry>
-</row>
-</thead>
-<tbody>
-<row>
-<entry colname="1"><i>catalog</i></entry>
-<entry colname="2">Always use <i>null</i> for this parameter in
-<ph conref="../conrefs.dita#prod/productshortname"></ph>.</entry>
-</row>
-<row>
-<entry colname="1"><i>schemaPattern</i></entry>
-<entry colname="2">A <i>String</i> object representing the name pattern of the
-procedure's schema. Java procedures have a schema.</entry>
-</row>
-<row>
-<entry colname="1"><i>procedureNamePattern</i></entry>
-<entry colname="2">A <i>String</i> object representing the name pattern of the
-procedure.</entry>
-</row>
-<row>
-<entry colname="1"><i id="jdbc95532">columnNamePattern</i></entry>
-<entry colname="2">A <i>String</i> object representing the name pattern of the
-parameter names or return value names. Java procedures have parameter names
-matching those defined in the CREATE PROCEDURE statement. Use "%" to find all
-parameter names.</entry>
-</row>
-</tbody>
-</tgroup>
-</table>
-</section>
-</refbody>
-</reference>
-