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 "Kim Haase (Created) (JIRA)" <ji...@apache.org> on 2012/04/19 16:38:43 UTC

[jira] [Created] (DERBY-5696) Documentation on LOBs needs some fixes

Documentation on LOBs needs some fixes
--------------------------------------

                 Key: DERBY-5696
                 URL: https://issues.apache.org/jira/browse/DERBY-5696
             Project: Derby
          Issue Type: Bug
          Components: Documentation
    Affects Versions: 10.8.2.2
            Reporter: Kim Haase
            Assignee: Kim Haase


DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (DERBY-5696) Documentation on LOBs needs some fixes

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

Kim Haase updated DERBY-5696:
-----------------------------

    Attachment: rrefjdbc96386.html
                DERBY-5696-2.diff

Thanks again, Kristian -- attaching a second patch, DERBY-5696-2.diff and the modified rrefjdbc96386.html, that makes the change you suggested.
                
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5696-2.diff, DERBY-5696.diff, rrefjdbc96386.html, rrefjdbc96386.html
>
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (DERBY-5696) Documentation on LOBs needs some fixes

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

Kim Haase commented on DERBY-5696:
----------------------------------

I think the change you suggest is worth making, Kristian -- I'll file another patch. Thanks!
                
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5696.diff, rrefjdbc96386.html
>
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (DERBY-5696) Documentation on LOBs needs some fixes

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

Kim Haase commented on DERBY-5696:
----------------------------------

Thanks very much for that explanation, Kristian. I'll work with it and file a patch that I hope will put things correctly.
                
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (DERBY-5696) Documentation on LOBs needs some fixes

Posted by "Kristian Waagan (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-5696?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13262444#comment-13262444 ] 

Kristian Waagan commented on DERBY-5696:
----------------------------------------

Thanks, Kim.

Is it clear enough that "You can access a LOB column only once" really means "You can access a given LOB column only once within a row"?

With respect to detail, I think this is sufficient for the reference manual.
                
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5696.diff, rrefjdbc96386.html
>
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (DERBY-5696) Documentation on LOBs needs some fixes

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

Kim Haase updated DERBY-5696:
-----------------------------

    Issue & fix info: Patch Available
    
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5696.diff, rrefjdbc96386.html
>
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (DERBY-5696) Documentation on LOBs needs some fixes

Posted by "Kristian Waagan (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-5696?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13261296#comment-13261296 ] 

Kristian Waagan commented on DERBY-5696:
----------------------------------------

Hi Kim,

The base rule is that you can only access a LOB column once. To access a column you invoke a getter on it.
The exceptions to that rule are getBytes and getString, which allow you to invoke those two getters as many times as you like, given none of the other getters has been invoked already, and additionally one other getter as the last invocation.

The reason for the exception to the rule is to avoid breaking existing applications that work correctly. getBytes and getString ([1]) are different because they always materialize the value. With materialized values you don't have the problems with stream positioning that you have [in Derby] when serving content off a store stream.

The fact that you can invoke getBytes/getString multiple times is not really an important thing to note in the manual. What users need to know is that you can only invoke a getter once on a LOB column. If we document the special behavior of getBytes/getString, it is to allow user to understand the behavior they are seeing in their application. Some users may use/abuse that for convenience - that's fine as long as they know their large objects are small object :)

Don't hesitate to ask further questions if my explanation is unclear.


[1] ResultSet.get[Bytes|String] and Blob.getBytes/Clob.getSubString are different as the former alway fetch the whole value, whereas the latter allows for fetching only parts of the value.
                
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Closed] (DERBY-5696) Documentation on LOBs needs some fixes

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

Kim Haase closed DERBY-5696.
----------------------------


Changes have appeared in Latest Alpha Manuals.
                
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>             Fix For: 10.9.0.0
>
>         Attachments: DERBY-5696-2.diff, DERBY-5696.diff, rrefjdbc96386.html, rrefjdbc96386.html
>
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (DERBY-5696) Documentation on LOBs needs some fixes

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

Kim Haase commented on DERBY-5696:
----------------------------------

Sorry, the change is in the attached DERBY-5696.diff and rrefjdbc96386.html.

                
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5696.diff, rrefjdbc96386.html
>
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (DERBY-5696) Documentation on LOBs needs some fixes

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

Kim Haase commented on DERBY-5696:
----------------------------------

I'm trying to figure out how to document the behavior noted in DERBY-5489, but I'm a little confused. I was going to say something like

"If you call one of the ResultSet methods getBytes, getString, or getObject on a LOB after a different getter has already been invoked, an error occurs."

However, that seems to apply to items a, b, d, and e below, but not to c. Why is it okay to call getObject after getBytes, but not the other way around?

 a) OK: getBytes - getBytes
 b) FAILS: getObject - getBytes
 c) OK: getBytes - getObject
 d) FAILS: getBytes - getObject - getBytes
 e) FAILS: getBlob - getBinaryStream

Thanks for any advice.
                
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (DERBY-5696) Documentation on LOBs needs some fixes

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

Kim Haase updated DERBY-5696:
-----------------------------

    Attachment: rrefjdbc96386.html
                DERBY-5696.diff

I think that we can get away with adding just one sentence to the topic, placed reasonably prominently (in a paragraph of its own). I think this covers the main point that needs making and that details are already provided elsewhere.

If this doesn't get it quite right or could use more detail, please let me know.
                
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5696.diff, rrefjdbc96386.html
>
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (DERBY-5696) Documentation on LOBs needs some fixes

Posted by "Kristian Waagan (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-5696?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13267165#comment-13267165 ] 

Kristian Waagan commented on DERBY-5696:
----------------------------------------

Looks good, Kim.
+1 to commit
                
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>         Attachments: DERBY-5696-2.diff, DERBY-5696.diff, rrefjdbc96386.html, rrefjdbc96386.html
>
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Resolved] (DERBY-5696) Documentation on LOBs needs some fixes

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

Kim Haase resolved DERBY-5696.
------------------------------

          Resolution: Fixed
       Fix Version/s: 10.9.0.0
    Issue & fix info:   (was: Patch Available)

Thanks again, Kristian.

Committed patch DERBY-5696-2.diff to documentation trunk at revision 1335100.

                
> Documentation on LOBs needs some fixes
> --------------------------------------
>
>                 Key: DERBY-5696
>                 URL: https://issues.apache.org/jira/browse/DERBY-5696
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>    Affects Versions: 10.8.2.2
>            Reporter: Kim Haase
>            Assignee: Kim Haase
>             Fix For: 10.9.0.0
>
>         Attachments: DERBY-5696-2.diff, DERBY-5696.diff, rrefjdbc96386.html, rrefjdbc96386.html
>
>
> DERBY-5489 points out some issues with multiple getXXX calls on LOBs that are not fully documented. The information should probably be added to "Notes on mapping of java.sql.Blob and java.sql.Clob interfaces". In addition, the topic "Mapping of java.sql.Blob and java.sql.Clob interfaces" has a typo and could probably use some additional information as well.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira