db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Laura Stewart (JIRA)" <j...@apache.org>
Subject [jira] Commented: (DERBY-2042) Provide documentation for new RENAME COLUMN statement
Date Mon, 06 Nov 2006 21:06:41 GMT
    [ http://issues.apache.org/jira/browse/DERBY-2042?page=comments#action_12447537 ] 
            
Laura Stewart commented on DERBY-2042:
--------------------------------------

Hi Bryan - 

A couple of comments:

You have a section entitled "Statement dependency system".
This seems like an oddly worded section.
I think that it would be best if the content of the section was moved before the syntax.

You state "If there is an index defined on the column, the column can be renamed."
Does this mean that you can only rename a column that has an index?
If yes then this is a "restriction" to the RENAME COLUMN statement.  
If any column, even those with indexes can be renamed, then you might just want to state that.

The next item "The RENAME COLUMN statement is not allowed if there are any open cursors that
reference the column that is being altered."
is definitely a restriction.  We typically don't add "Restrictions" sections to reference
topics.  But it would be good to use a note.
The tagging is:
<note="restriction">You cannot use the RENAME COLUMN statement if there are open cursors
that reference the column that you want to rename."</note>

You can see an example of using the note tag on the new "Writing Guidelines" page that I added
to the Derby Documentation site:
http://db.apache.org/derby/manuals/guidelines.html#Tagging+examples

Also, it would be helpful if you created a section for the examples entitled "Examples"
See the GRANT statement in the Reference Guide for an example
http://db.apache.org/derby/docs/dev/ref/rrefsqljgrant.html

Finally, I asked on the list a few months ago about using the semi-colon at the end of SQL
statements. 
The Derby community indicated that they did NOT want to use them.  
See this thread:
http://www.nabble.com/Documentation-Style-Issue---semi-colon-at-the-end-of-SQL-statement-examples-tf2141831.html#a5912069


> Provide documentation for new RENAME COLUMN statement
> -----------------------------------------------------
>
>                 Key: DERBY-2042
>                 URL: http://issues.apache.org/jira/browse/DERBY-2042
>             Project: Derby
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: Bryan Pendleton
>         Assigned To: Bryan Pendleton
>            Priority: Minor
>         Attachments: renameColumnDoc_v1.diff, rrefsqljrenamecolumnstatement.html
>
>
> DERBY-1490 proposes to add a new RENAME COLUMN statement. Assuming that such a statement
is added, we need to update the documentation to describe this new statement. DERBY-1490 describes
the behavior of the statement in detail; this issue is just to track the documentation, which
I intend to address separately after the DERBY-1490 changes are committed.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message