You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "A B (JIRA)" <ji...@apache.org> on 2007/05/15 19:45:16 UTC

[jira] Created: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
--------------------------------------------------------------------------------

                 Key: DERBY-2654
                 URL: https://issues.apache.org/jira/browse/DERBY-2654
             Project: Derby
          Issue Type: Sub-task
          Components: Documentation
    Affects Versions: 10.3.0.0
            Reporter: A B


Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


Re: [jira] Commented: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by Myrna van Lunteren <m....@gmail.com>.
On 5/29/07, A B (JIRA) <ji...@apache.org> wrote:
>
>    [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12499835 ]
>
> A B commented on DERBY-2654:
> ----------------------------
>
> Thank you for committing this, Myrna.
>
> When I saw the commit message in my Inbox the parenthetical "(in embedded mode)" jumped out at me--and only then did I realize that the documation as committed doesn't mention that the relevant APIs only (currently) work in embedded mode.  That was my mistake--I completely forgot to include that info in my original draft.
>
> Kim, would it be possible to post a follow-up patch to address this?  We would have to add something to indicate that the following six methods are not suppoted in client/server mode?
>
>  connection30.html:
>
>    prepareStatement(String sql, int [] columnIndexes)
>    prepareStatement(String sql, String [] columnNames)
>
>  statement30.html:
>
>    execute(String sql, int [] columnIndexes)
>    execute(String sql, String [] columnNames)
>    executeUpdate(String sql, int [] columnIndexes)
>    executeUpdate(String sql, String [] columnNames)
>
> Maybe the best place to put this is on the crefjavstateautogen.html page, where we now have:
>
> <begin>
>
> Users can indicate that auto-generated columns should be made available for retrieval by passing one of the following values as a second argument to the Connection.prepareStatement, Statement.execute, or Statement.executeUpdate methods:
>
>    * A constant indicating that auto-generated keys should be made available. The specific constant to use is Statement.RETURN_GENERATED_KEYS.
>    * An array of the names of the columns in the inserted row that should be made available. If any column name in the array does not designate an auto-increment column, Derby will throw an error.
>    * An array of the positions of the columns in the inserted row that should be made available. If any column position in the array does not correlate to an auto-increment column, Derby will throw an error.
>
> <end>
>
> Would it be possible to add a note at the end of the second and third bullets?  Maybe something like:  "Note: this is currently only supported when running in embedded mode."
>
> That's just a quick suggestion, though.  If there's a better way to relay this info, feel free to go with it.
> Sorry for missing this earlier...
>

Maybe in addition, this could be added to the server guide where some
differences between client and server are documented? Or can we refer
in those docs to a bug? If so, we could refer to DERBY-310...

Myrna

[jira] Updated: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-2654:
-----------------------------

    Derby Info: [Patch Available]

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>         Assigned To: Kim Haase
>         Attachments: changes.txt, changes.txt, DERBY-2654.diff, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Updated: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-2654:
-----------------------------

    Attachment: DERBY-2654-2.zip
                DERBY-2654-2.diff

Thanks, Army! It turned out to be easy to imitate the look of the automatic link at the bottom of the Statement topic. So instead of having a "Related Concepts" link for the whole group that only applies to two of the topics, I've got two similar links in the Connection and Statement topics. See what you think.

I've put the corrections in DERBY-2654-2.diff and DERBY-2654-2.zip. Hope they are okay this time.

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>         Assigned To: Kim Haase
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654.diff, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Resolved: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Myrna van Lunteren (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Myrna van Lunteren resolved DERBY-2654.
---------------------------------------

       Resolution: Fixed
    Fix Version/s: 10.3.0.0
       Derby Info:   (was: [Patch Available])

committed with http://svn.apache.org/viewvc?view=rev&revision=542150.

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654.diff, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Commented: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "A B (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12501616 ] 

A B commented on DERBY-2654:
----------------------------

To be clear, the patch to be committed is DERBY-2654-v4.diff, which I have reviewed with +1.

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654-3.diff, DERBY-2654-4.diff, DERBY-2654-4.zip, DERBY-2654.diff, DERBY-2654.zip, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Updated: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-2654:
-----------------------------

    Attachment: DERBY-2654.zip
                DERBY-2654-3.diff

No problem -- I hope this is okay. I think it makes sense to put the information in all 3 files. My only question has to do with the exact phrasing. When we say "when running in embedded mode" I always wonder ,"when what is running in embedded mode?" These clauses do need a subject. So I made a guess that I hope is correct. I think the full statement is needed only in the autogen file. Let me know if it needs fixing!


> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654-3.diff, DERBY-2654.diff, DERBY-2654.zip, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Updated: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-2654:
-----------------------------

    Attachment: DERBY-2654-4.zip
                DERBY-2654-4.diff

Thanks for the suggestions, Army. I hope I've incorporated them suitably. For the new topic I created a topic named cadminappsjdbcdiffs and called it "Differences in JDBC 3.0 methods" to try to give a clear idea of what it was about. The ditamap change should show where I put it -- just before the topic "Differences using the Connection.setReadOnly method".

The changes are in DERBY-2654-4.diff and DERBY-2654-4.zip.

I also remembered to use the conrefs phrase for "Derby" in the autogen file -- I'd forgotten before.

Let me know if more changes are needed.

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654-3.diff, DERBY-2654-4.diff, DERBY-2654-4.zip, DERBY-2654.diff, DERBY-2654.zip, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Commented: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12498707 ] 

Kim Haase commented on DERBY-2654:
----------------------------------

I can handle this, since it's Java-related. Thanks for the VERY detailed and helpful changes, Army.


> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>         Assigned To: Kim Haase
>         Attachments: changes.txt, changes.txt
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Reopened: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "A B (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

A B reopened DERBY-2654:
------------------------


Reopening since there is another patch waiting to be committed.

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654-3.diff, DERBY-2654-4.diff, DERBY-2654-4.zip, DERBY-2654.diff, DERBY-2654.zip, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Commented: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12499150 ] 

Kim Haase commented on DERBY-2654:
----------------------------------

Thanks, Army! I will make the first two fixes. The third is an interesting problem. If you look at http://db.apache.org/derby/docs/dev/ref/, you can see that the "Autogenerated keys" topic is actually a subtopic under the "java.sql.Statement interface: supported JDBC 3.0 methods" topic. This means that in this topic, the "Autogenerated keys" topic is automatically placed in a bullet list by the DITA processor. But for other topics that need to refer to it I need to create a reference. I could try to make it look like the one under Statement, but I'm not sure I could duplicate this exactly.

The other option is to make it a subsection at the same level as the other JDBC 3.0 topics. This can be done just by fiddling with the map file. I think in that case it would show up in the Related Reference list along with the other topics in this part of the hierarchy. Would that be preferable? 

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>         Assigned To: Kim Haase
>         Attachments: changes.txt, changes.txt, DERBY-2654.diff, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Assigned: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase reassigned DERBY-2654:
--------------------------------

    Assignee: Kim Haase

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>         Assigned To: Kim Haase
>         Attachments: changes.txt, changes.txt
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Updated: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "A B (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

A B updated DERBY-2654:
-----------------------

    Attachment: changes.txt

Attaching "changes.txt", which is an outline of the changes that I think would be necessary for this issue.

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>         Attachments: changes.txt
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Commented: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "A B (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12499245 ] 

A B commented on DERBY-2654:
----------------------------

The *-2 changes look good to me.  +1 to commit derby-2654-2.diff.

Thanks for your work on this, Kim!

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>         Assigned To: Kim Haase
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654.diff, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Closed: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "A B (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

A B closed DERBY-2654.
----------------------


Many thanks to Kim for the doc changes and to Myrna for the commits.  Closing this issue as I don't think there's anything else to do here.

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654-3.diff, DERBY-2654-4.diff, DERBY-2654-4.zip, DERBY-2654.diff, DERBY-2654.zip, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Commented: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "A B (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12499166 ] 

A B commented on DERBY-2654:
----------------------------

Thank you for looking into this, Kim.  If it's okay, I'll leave it up to you to decide on the best way to handle the "auto-generated keys" link.  I just thought I'd bring it up as something I noticed, but I didn't realize it was an artifact of dita.  So feel free to handle it (or it ignore) as you see fit :)  In any event, I wouldn't let that block the rest of the patch...

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>         Assigned To: Kim Haase
>         Attachments: changes.txt, changes.txt, DERBY-2654.diff, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Resolved: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Myrna van Lunteren (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Myrna van Lunteren resolved DERBY-2654.
---------------------------------------

    Resolution: Fixed
    Derby Info:   (was: [Patch Available])

Committed patch 4 with revision 544686.

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654-3.diff, DERBY-2654-4.diff, DERBY-2654-4.zip, DERBY-2654.diff, DERBY-2654.zip, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Commented: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "A B (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12499928 ] 

A B commented on DERBY-2654:
----------------------------

Hi Kim,

Thanks for addressing this so quickly!

Regarding:

  "This argument is supported only when the application is running in embedded mode".

I think one of two options might be better here.  Either:

  1. "This argument is supported only when Derby is running in embedded mode".

or

  2. "This argument is only supported with the Derby embedded driver".

My inclination is toward the latter, but whichever you think works better is fine.

Also, Myrna commented on derby-dev as follows:

> Maybe in addition, this could be added to the server guide where some
> differences between client and server are documented? Or can we refer
> in those docs to a bug? If so, we could refer to DERBY-310...

If you feel like tackling this as well, I think one approach would be to create a new page and link to it from:

   http://db.apache.org/derby/docs/dev/adminguide/cadminapps.html 

The new page could be as simple as:

<begin>

JDBC 3 Autogenerated Keys

The following JDBC 3 methods are only supported with the Derby embedded driver.  Attempts to call these methods with the network client driver will result in a "not implemented" error.

  Connection.prepareStatement(String sql, String[] columnNames);
  Connection.prepareStatement(String sql, int[] columnIndexes);

  Statement.execute(String sql, String[] columNames);
  Statement.execute(String sql, int[] columIndexes);
  Statement.executeUpdate(String sql, String[] columnNames);
  Statement.executeUpdate(String sql, int[] columnIndexes);

For more on the use of these methods, see <link to crefjavstateautogen.html>.

<end>

Does that sound okay?

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654-3.diff, DERBY-2654.diff, DERBY-2654.zip, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Updated: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-2654:
-----------------------------

    Attachment: DERBY-2654.zip
                DERBY-2654.diff

Attaching DERBY-2654.zip and DERBY-2654.diff. The files in DERBY-2654.zip are the HTML versions of the following source files:

M      src/ref/rrefjdbcjavasqlconnection30.dita
M      src/ref/rrefjdbcjavasqlstatement30.dita
M      src/ref/crefjavstateautogen.dita

Please let me know if anything isn't quite right.


> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>         Assigned To: Kim Haase
>         Attachments: changes.txt, changes.txt, DERBY-2654.diff, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Commented: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "A B (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12500226 ] 

A B commented on DERBY-2654:
----------------------------

Thank you, Kim!  The changes look good to me.  +1 to commit.

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654-3.diff, DERBY-2654-4.diff, DERBY-2654-4.zip, DERBY-2654.diff, DERBY-2654.zip, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Updated: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "A B (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

A B updated DERBY-2654:
-----------------------

    Attachment: changes.txt

Re-attaching after fixing some typos.  Sorry for the noise.

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>         Attachments: changes.txt, changes.txt
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Commented: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "A B (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12498870 ] 

A B commented on DERBY-2654:
----------------------------

Thanks for picking this one up, Kim.  The changes look good.  Just three minor comments:

1) rrefjdbcjavasqlconnection30.html:

There's a slight glitch in the last row.  I think "Column indexes" should be replaced with "Column names".

2) rrefjdbcjavasqlstatement30.html:

I had a typo in my original changes.  Can you replace "columns" with "keys" in the following
sentence (first row of the table):

  "If the user has indicated that auto-generated columns ..."

And once that's done, can we link "auto-generated keys" to the relevant page, i.e. to
crefjavstateautogen.html?  Or would that be too many redundant links for one page?

3) The "Connection" page ends with:

  For more information, see Autogenerated keys.

while the "Statement" page ends with a simple bullet:

  * Autogenerated keys

Is it be possible to make the two consistent? Or perhaps this link should just go under the "Related reference" list?  I'm not sure what the best approach is, but I do think it'd be nice to have consistency between the two pages.

Other than that I have no other comments.  Thanks again for your quick work on this!

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>         Assigned To: Kim Haase
>         Attachments: changes.txt, changes.txt, DERBY-2654.diff, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Commented: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "A B (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12499835 ] 

A B commented on DERBY-2654:
----------------------------

Thank you for committing this, Myrna.

When I saw the commit message in my Inbox the parenthetical "(in embedded mode)" jumped out at me--and only then did I realize that the documation as committed doesn't mention that the relevant APIs only (currently) work in embedded mode.  That was my mistake--I completely forgot to include that info in my original draft.

Kim, would it be possible to post a follow-up patch to address this?  We would have to add something to indicate that the following six methods are not suppoted in client/server mode?

  connection30.html:

    prepareStatement(String sql, int [] columnIndexes)
    prepareStatement(String sql, String [] columnNames)

  statement30.html:

    execute(String sql, int [] columnIndexes)
    execute(String sql, String [] columnNames)
    executeUpdate(String sql, int [] columnIndexes)
    executeUpdate(String sql, String [] columnNames)

Maybe the best place to put this is on the crefjavstateautogen.html page, where we now have:

<begin>

Users can indicate that auto-generated columns should be made available for retrieval by passing one of the following values as a second argument to the Connection.prepareStatement, Statement.execute, or Statement.executeUpdate methods:

    * A constant indicating that auto-generated keys should be made available. The specific constant to use is Statement.RETURN_GENERATED_KEYS.
    * An array of the names of the columns in the inserted row that should be made available. If any column name in the array does not designate an auto-increment column, Derby will throw an error.
    * An array of the positions of the columns in the inserted row that should be made available. If any column position in the array does not correlate to an auto-increment column, Derby will throw an error.

<end>

Would it be possible to add a note at the end of the second and third bullets?  Maybe something like:  "Note: this is currently only supported when running in embedded mode."

That's just a quick suggestion, though.  If there's a better way to relay this info, feel free to go with it.
Sorry for missing this earlier...

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654.diff, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Updated: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kim Haase updated DERBY-2654:
-----------------------------

    Derby Info: [Patch Available]

> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654-3.diff, DERBY-2654.diff, DERBY-2654.zip, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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


[jira] Commented: (DERBY-2654) Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.

Posted by "Kim Haase (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-2654?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_12500221 ] 

Kim Haase commented on DERBY-2654:
----------------------------------

Just realized I forgot to provide the revised "svn stat" output:

M      src/adminguide/derbyadmin.ditamap
A      src/adminguide/cadminappsjdbcdiffs.dita
M      src/ref/rrefjdbcjavasqlconnection30.dita
M      src/ref/rrefjdbcjavasqlstatement30.dita
M      src/ref/crefjavstateautogen.dita


> Document newly-supported (in embedded mode) JDBC methods for autogenerated keys.
> --------------------------------------------------------------------------------
>
>                 Key: DERBY-2654
>                 URL: https://issues.apache.org/jira/browse/DERBY-2654
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>    Affects Versions: 10.3.0.0
>            Reporter: A B
>            Assignee: Kim Haase
>             Fix For: 10.3.0.0
>
>         Attachments: changes.txt, changes.txt, DERBY-2654-2.diff, DERBY-2654-2.zip, DERBY-2654-3.diff, DERBY-2654-4.diff, DERBY-2654-4.zip, DERBY-2654.diff, DERBY-2654.zip, DERBY-2654.zip
>
>
> Several JDBC methods for specifying auto-generated key columns were implemented in embedded mode as part of DERBY-2631. Derby documentation should be updated to reflect those changes.

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