Return-Path: X-Original-To: apmail-db-derby-commits-archive@www.apache.org Delivered-To: apmail-db-derby-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 0971210620 for ; Fri, 11 Oct 2013 17:05:10 +0000 (UTC) Received: (qmail 13618 invoked by uid 500); 11 Oct 2013 17:04:47 -0000 Delivered-To: apmail-db-derby-commits-archive@db.apache.org Received: (qmail 13573 invoked by uid 500); 11 Oct 2013 17:04:45 -0000 Mailing-List: contact derby-commits-help@db.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: "Derby Development" List-Id: Delivered-To: mailing list derby-commits@db.apache.org Received: (qmail 13443 invoked by uid 99); 11 Oct 2013 17:04:43 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 11 Oct 2013 17:04:43 +0000 X-ASF-Spam-Status: No, hits=-2000.0 required=5.0 tests=ALL_TRUSTED X-Spam-Check-By: apache.org Received: from [140.211.11.4] (HELO eris.apache.org) (140.211.11.4) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 11 Oct 2013 17:04:39 +0000 Received: from eris.apache.org (localhost [127.0.0.1]) by eris.apache.org (Postfix) with ESMTP id 899D82388906; Fri, 11 Oct 2013 17:04:17 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1531356 - in /db/derby/docs/branches/10.10/src/ref: refderby.ditamap rrefcrsrgpc1.dita rrefdmdfns1.dita rrefgpc1.dita rrefjdbc15905.dita rrefpgc1.dita Date: Fri, 11 Oct 2013 17:04:17 -0000 To: derby-commits@db.apache.org From: chaase3@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20131011170417.899D82388906@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org 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"> - - - - - + 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. --> -Columns in the ResultSet returned by getProcedureColumns +Columns in the ResultSets returned by getFunctionColumns and getProcedureColumns -

Columns in the ResultSet returned by getProcedureColumns are -as described by the API. Further details for some specific columns are shown -in the following table.

+

Columns in the ResultSets returned by +getFunctionColumns and getProcedureColumns are +as described by the API.

+

The following table shows +-specific details for +some specific columns returned by getFunctionColumns.

Columns in the <i>ResultSet</i> returned by -<i>getProcedureColumns</i> -This table lists and describes the columns in the ResultSet returned by the getProcedureColumns method. +getFunctionColumns +This table lists and describes -specific details for some columns in the ResultSet returned by the getFunctionColumns method. @@ -37,24 +40,64 @@ in the following table.

-PROCEDURE_CAT -Always "null" in -. +COLUMN_TYPE +short indicating what the row describes. Is always +DatabaseMetaData.functionColumnIn for method parameters, unless the +parameter is an array. If so, it is DatabaseMetaData.functionColumnInOut. +It always returns DatabaseMetaData.functionColumnReturn for return +values. -PROCEDURE_SCHEM -Schema for a Java procedure. +TYPE_NAME +-specific +name for the type. -PROCEDURE_NAME -The name of the procedure. +NULLABLE +Always returns DatabaseMetaData.functionNoNulls for +primitive parameters and DatabaseMetaData.functionNullable for object +parameters. -COLUMN_NAME -The name of the parameter (see columnNamePattern in -). +REMARKS +A String which describes the Java type of the method +parameter. +ORDINAL_POSITION +The ordinal position, starting from 1, for the input +and output parameters for the function. + + +METHOD_ID +A -specific +column. + + +PARAMETER_ID +A -specific +column. + + + +
+

The following table shows +-specific details for +some specific columns returned by getProcedureColumns.

+Columns in the <i>ResultSet</i> returned by +<i>getProcedureColumns</i> +This table lists and describes -specific details for some columns in the ResultSet returned by the getProcedureColumns methods. + + + + + +Column +Description + + + + COLUMN_TYPE short indicating what the row describes. Is always DatabaseMetaData.procedureColumnIn for method parameters, unless the @@ -79,37 +122,9 @@ parameters. parameter. -COLUMN_DEF -A String which describes the default value for the -column (may be null). - - -SQL_DATA_TYPE -Reserved by the JDBC specification for future use. - - -SQL_DATETIME_SUB -Reserved by the JDBC specification for future use. - - -CHAR_OCTET_LENGTH -The maximum length of binary and character based columns (for -any other data type, the returned value is a NULL). - - ORDINAL_POSITION The ordinal position, starting from 1, for the input -and output parameters for a procedure. - - -IS_NULLABLE -A String describing the parameter's nullability -(YES means the parameter can include NULLs, NO means it cannot). - - -SPECIFIC_NAME -The name which uniquely identifies this procedure within -its schema. +and output parameters for the procedure. METHOD_ID 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. --> java.sql.DatabaseMetaData.getBestRowIdentifier method -The java.sql.DatabaseMetaData.getBestRowIdentifier method -looks for identifiers in a specific order. This order might not return a unique -row. java.sql.DatabaseMetaData.getBestRowIdentifier method methodsjava.sql.DatabaseMetaData.getBestRowIdentifier -

The java.sql.DatabaseMetaData.getBestRowIdentifier method +

+

The java.sql.DatabaseMetaData.getBestRowIdentifier method +looks for identifiers in a specific order. This order might not return a unique +row.

+

The java.sql.DatabaseMetaData.getBestRowIdentifier method looks for identifiers in the following order:

  • A primary key on the table
  • A unique constraint or unique index on the table
  • All of the columns in the table
  • -

If the java.sql.DatabaseMetaData.getBestRowIdentifier method +

If the java.sql.DatabaseMetaData.getBestRowIdentifier 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 @@ - - - - - -java.sql.DatabaseMetaData.getProcedureColumns method - -java.sql.DatabaseMetaData.getProcedureColumns method - - -

supports -Java procedures. allows -you to call Java procedures within SQL statements. returns -information about the parameters in the getProcedureColumns call. If -the corresponding Java method is overloaded, it returns information about -each signature separately. returns -information for all Java procedures defined by CREATE PROCEDURE.

-

getProcedureColumns returns a ResultSet. Each row -describes a single parameter or return value.

-
-
- 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. java.sql.DatabaseMetaData interface -

This section discusses java.sql.DatabaseMetaData functionality in . +

This section discusses java.sql.DatabaseMetaData +functionality in .

+

For methods that take a catalog parameter, always specify null for +this parameter, since +does not support catalogs. Similarly, methods that return a catalog in the +ResultSet will always return null in that column.

The implementation of the getResultSetHoldability method returns ResultSet.HOLD_CURSORS_OVER_COMMIT. 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 @@ - - - - - -Parameters to getProcedureColumns - -

For the getProcedureColumns method, the JDBC API defines the -parameters shown in the following table.

-
-
<i>getProcedureColumns</i> method parameters -This table lists and describes the parameters of the getProcedureColumns method. - - - - - -Parameter -Description - - - - -catalog -Always use null for this parameter in -. - - -schemaPattern -A String object representing the name pattern of the -procedure's schema. Java procedures have a schema. - - -procedureNamePattern -A String object representing the name pattern of the -procedure. - - -columnNamePattern -A String 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. - - - -
-
- - -