[jira] Created: (DERBY-3062) Docn errors in System procedure and Create procedure descriptions

Docn errors in System procedure and Create procedure descriptions
-----------------------------------------------------------------

                 Key: DERBY-3062
                 URL: https://issues.apache.org/jira/browse/DERBY-3062
             Project: Derby
          Issue Type: Bug
          Components: Documentation
    Affects Versions: 10.3.1.4
            Reporter: Sebb


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.


--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/DERBY-3062?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Sebb updated DERBY-3062:
------------------------

             Priority: Minor  (was: Major)
    Affects Version/s:     (was: 10.3.1.4)
                       10.4.1.3

> Docn errors in System procedure and Create procedure descriptions
> -----------------------------------------------------------------
>
>                 Key: DERBY-3062
>                 URL: https://issues.apache.org/jira/browse/DERBY-3062
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.4.1.3
>            Reporter: Sebb
>            Priority: Minor
>
> 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.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/DERBY-3062?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bryan Pendleton reassigned DERBY-3062:
--------------------------------------

    Assignee: Bryan Pendleton

> Docn errors in System procedure and Create procedure descriptions
> -----------------------------------------------------------------
>
>                 Key: DERBY-3062
>                 URL: https://issues.apache.org/jira/browse/DERBY-3062
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.4.1.3
>            Reporter: Sebb
>            Assignee: Bryan Pendleton
>            Priority: Minor
>
> 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.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/DERBY-3062?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bryan Pendleton updated DERBY-3062:
-----------------------------------

    Attachment: rrefcreateprocedurestatement.html
                clarify.diff

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.

> Docn errors in System procedure and Create procedure descriptions
> -----------------------------------------------------------------
>
>                 Key: DERBY-3062
>                 URL: https://issues.apache.org/jira/browse/DERBY-3062
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.4.1.3
>            Reporter: Sebb
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: clarify.diff, rrefcreateprocedurestatement.html
>
>
> 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.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

    [ https://issues.apache.org/jira/browse/DERBY-3062?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12773966#action_12773966 ]

Kim Haase commented on DERBY-3062:
----------------------------------

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.

> Docn errors in System procedure and Create procedure descriptions
> -----------------------------------------------------------------
>
>                 Key: DERBY-3062
>                 URL: https://issues.apache.org/jira/browse/DERBY-3062
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.4.1.3
>            Reporter: Sebb
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: clarify.diff, rrefcreateprocedurestatement.html
>
>
> 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.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

     [ https://issues.apache.org/jira/browse/DERBY-3062?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Bryan Pendleton resolved DERBY-3062.
------------------------------------

       Resolution: Fixed
    Fix Version/s: 10.6.0.0

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.

> Docn errors in System procedure and Create procedure descriptions
> -----------------------------------------------------------------
>
>                 Key: DERBY-3062
>                 URL: https://issues.apache.org/jira/browse/DERBY-3062
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.4.1.3
>            Reporter: Sebb
>            Assignee: Bryan Pendleton
>            Priority: Minor
>             Fix For: 10.6.0.0
>
>         Attachments: clarify.diff, rrefcreateprocedurestatement.html
>
>
> 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.

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.