Derby
  1. Derby
  2. DERBY-3062

Docn errors in System procedure and Create procedure descriptions

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Minor Minor
    • Resolution: Fixed
    • Affects Version/s: 10.4.1.3
    • Fix Version/s: 10.6.1.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      File: db-derby-10.3.1.4-bin/docs/html/ref/rrefexportproc.html

      1.
      "... uses the current directory and the default drive as the destination."

      Does not make clear that the defaut drive relates to the server process.

      2.
      Says that the file will be overwritten - this is no longer the case:

      java.sql.SQLException: The export operation was not performed, because the specified output file (myfile.del) already exists. Export processing will not overwrite an existing file, even if the process has permissions to write to that file, due to security concerns, and to avoid accidental file damage. Please either change the output file name in the export procedure arguments to specify a file which does not exist, or delete the existing file, then retry the export operation.

      File: db-derby-10.3.1.4-bin/docs/html/ref/rrefcreateprocedurestatement.html

      The text:
      "Statements that are not supported in any stored procedure return a different error."
      appears under the descriptions for:

      CONTAINS SQL
      READS SQL DATA

      This does not make sense.

      1. rrefcreateprocedurestatement.html
        11 kB
        Bryan Pendleton
      2. clarify.diff
        2 kB
        Bryan Pendleton

        Activity

        Hide
        Bryan Pendleton added a comment -

        Thanks Kim for the review. The discussion on derby-dev indicated that we don't currently
        know of any SQL statements that are flatly prohibited in Java store procedures, so I've
        updated the documentation accordingly. Hopefully this new version is simpler and clearer.

        Committed to the documentation trunk as revision 833268.

        Show
        Bryan Pendleton added a comment - Thanks Kim for the review. The discussion on derby-dev indicated that we don't currently know of any SQL statements that are flatly prohibited in Java store procedures, so I've updated the documentation accordingly. Hopefully this new version is simpler and clearer. Committed to the documentation trunk as revision 833268.
        Hide
        Kim Haase added a comment -

        This patch looks great, Bryan. +1 to commit. If you need to incorporate more info, I assume you'll file another patch.

        Thanks for picking up these documentation bugs that you have been working on. I have been too busy with other projects to work on our backlog.

        Show
        Kim Haase added a comment - This patch looks great, Bryan. +1 to commit. If you need to incorporate more info, I assume you'll file another patch. Thanks for picking up these documentation bugs that you have been working on. I have been too busy with other projects to work on our backlog.
        Hide
        Bryan Pendleton added a comment -

        I believe that the problems in the export procedure documentation
        were taken care of some time ago. The current (10.5) documentation
        http://db.apache.org/derby/docs/10.5/ref/rrefexportproc.html
        seems to read correctly.

        I've attached a proposed clarification to the CREATE PROCEDURE
        page to try to clean up the description of the SQL supported parameter.

        I've got an open query to the derby-dev list to try to figure out what
        SQL statements, if any, are simply not supported for a procedure
        which states MODIFIES SQL DATA.

        If there are no such statements, I'll remove the doc that refers to their existence.

        If there are such statements, I'll include explicit examples.

        Show
        Bryan Pendleton added a comment - I believe that the problems in the export procedure documentation were taken care of some time ago. The current (10.5) documentation http://db.apache.org/derby/docs/10.5/ref/rrefexportproc.html seems to read correctly. I've attached a proposed clarification to the CREATE PROCEDURE page to try to clean up the description of the SQL supported parameter. I've got an open query to the derby-dev list to try to figure out what SQL statements, if any, are simply not supported for a procedure which states MODIFIES SQL DATA. If there are no such statements, I'll remove the doc that refers to their existence. If there are such statements, I'll include explicit examples.

          People

          • Assignee:
            Bryan Pendleton
            Reporter:
            Sebb
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development