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 "David Van Couvering (JIRA)" <de...@db.apache.org> on 2006/08/10 02:23:13 UTC

[jira] Created: (DERBY-1659) Document describe and show-table functionality

Document describe and show-table functionality
----------------------------------------------

                 Key: DERBY-1659
                 URL: http://issues.apache.org/jira/browse/DERBY-1659
             Project: Derby
          Issue Type: Sub-task
            Reporter: David Van Couvering


Need to add documentation for this new feature

-- 
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

        

[jira] Resolved: (DERBY-1659) Document describe and show tables functionality

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Andrew McIntyre resolved DERBY-1659.
------------------------------------

    Resolution: Fixed

Marking resolved, fixes in trunk and 10.2 branch.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: Andrew McIntyre
>             Fix For: 10.2.1.5, 10.3.0.0
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, derby-1659-views.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Andrew McIntyre updated DERBY-1659:
-----------------------------------

    Component/s: Documentation

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: David Van Couvering
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

David Van Couvering updated DERBY-1659:
---------------------------------------

    Attachment: Describe.html

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>            Reporter: David Van Couvering
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Commented: (DERBY-1659) Document describe and show tables functionality

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1659?page=comments#action_12434078 ] 
            
Andrew McIntyre commented on DERBY-1659:
----------------------------------------

Committed derby-1659-andrew-1 patch with revision 442496. Use of examples can be cleaned up in a followup patch. It would be helpful if someone else more familiar with DITA's use of <example>s could explain the benefit of having a single <example> per <reference>.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: Andrew McIntyre
>             Fix For: 10.2.1.0
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Assigned: (DERBY-1659) Document describe and show tables functionality

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Andrew McIntyre reassigned DERBY-1659:
--------------------------------------

    Assignee: Andrew McIntyre

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: Andrew McIntyre
>             Fix For: 10.2.1.0
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Commented: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1659?page=comments#action_12427059 ] 
            
David Van Couvering commented on DERBY-1659:
--------------------------------------------

This is great functionality to have and it would be really good to have this available in 10.2.  It would be a shame if it were not "officially" available because of lack of documentation.  Is Havard around to write the documentation?  Otherwise, although I know very little about these features, I may jump in and do it.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>            Reporter: David Van Couvering
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Commented: (DERBY-1659) Document describe and show tables functionality

Posted by "Andreas Korneliussen (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1659?page=comments#action_12434702 ] 
            
Andreas Korneliussen commented on DERBY-1659:
---------------------------------------------

I have just a minor comment on the doc: I have been testing this feature, and found that descrbie also can be used for describing views. 

ij> show views;
TABLE_SCHEM         |TABLE_NAME                    |REMARKS             
------------------------------------------------------------------------
MYPP                |V1                            |                    

1 row selected
ij> describe mypp.v1;
COLUMN_NAME         |TYPE_NAME|DEC&|NUM&|COLUM&|COLUMN_DEF|CHAR_OCTE&|IS_NULL&
------------------------------------------------------------------------------
C                   |INTEGER  |0   |10  |10    |NULL      |NULL      |NO      

1 row selected

Therefore, I propose that the doc is modified to say that it can describe views, and the syntax of the describe command could i.e be:
describe <view_name>|<table_name>



> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: Andrew McIntyre
>             Fix For: 10.3.0.0
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

David Van Couvering updated DERBY-1659:
---------------------------------------

    Summary: Document describe and show tables functionality  (was: Document describe and show-table functionality)

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>            Reporter: David Van Couvering
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Andrew McIntyre updated DERBY-1659:
-----------------------------------

    Derby Info:   (was: [Patch Available])

Committed derby-1659-views to docs trunk with revision 448620.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: Andrew McIntyre
>             Fix For: 10.3.0.0
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, derby-1659-views.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

David Van Couvering updated DERBY-1659:
---------------------------------------

    Attachment: ShowProcedures.html

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>            Reporter: David Van Couvering
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

David Van Couvering updated DERBY-1659:
---------------------------------------

    Attachment: ShowTable.html

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>            Reporter: David Van Couvering
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

David Van Couvering updated DERBY-1659:
---------------------------------------

    Attachment: ShowSynonyms.html

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>            Reporter: David Van Couvering
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Closed: (DERBY-1659) Document describe and show tables functionality

Posted by "Kristian Waagan (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Kristian Waagan closed DERBY-1659.
----------------------------------


Verified in alpha (10.3) and 10.2 doc builds.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: Andrew McIntyre
>             Fix For: 10.3.0.0, 10.2.1.6
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, derby-1659-views.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Commented: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1659?page=comments#action_12427331 ] 
            
David Van Couvering commented on DERBY-1659:
--------------------------------------------

Attached HTML files for each of the SHOW commands (which all appear to be new - at least, they're not documented) and the DESCRIBE command.

I used StarOffice to create these, sorry if this generated a lot of cruft, but trying to do it in raw HTML was too painful.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>            Reporter: David Van Couvering
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Andrew McIntyre updated DERBY-1659:
-----------------------------------

    Attachment: derby-1659-views.diff

Attaching simple patch to include views in the reference for the new ij describe command.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: Andrew McIntyre
>             Fix For: 10.3.0.0
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, derby-1659-views.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Andrew McIntyre updated DERBY-1659:
-----------------------------------

    Attachment: derby-1659-andrew-1-html.zip

Attaching zip file with the new pages for describe and show.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>             Fix For: 10.2.1.0
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

Re: [jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by Kristian Waagan <Kr...@Sun.COM>.
Andrew McIntyre (JIRA) wrote:

>     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]
>
>Andrew McIntyre updated DERBY-1659:
>-----------------------------------
>
>    Attachment: derby-1659-andrew-1.diff
>
>I hadn't realized Kristian had offered to produce a patch for this, since when I checked earlier today noone was assigned to the issue. So earlier today I started to put together a patch for this issue based on David's HTML files. I cleaned up what I had done so that it builds properly and am attaching the patch here in the hopes of preventing duplication of effort in documenting this.
>
>I expanded and reorganized what David had suggested, but I'm not sure that this is really ready to be committed. I put all of the syntax for SHOW into a single page, with examples for each choice in the next part of the SHOW grammar. This would seem to be slightly at odds with the way DITA organizes examples, which would have one <example> block with all of the examples for the <reference> block for SHOW. 
>
>So, I'd really appreciate it if someone could help review and/or cleanup this patch and make it ready for commit. I'm always happy to hear suggestions as to where to go from here.
>
/Hi Andrew,

I've been down with the flu, that's why I haven't submitted my patch.
I went for the other approach, with a "main page" for SHOW, and then 
subpages (another level) for the various show commands. It worked, but I 
did not know if people would like it, that's why I originally requested 
feedback on the approach (after I submitted the patch, which I never got 
around to do before you did).

Anyway, no need now, as another patch is already ready :)



Regards,
-- 
Kristian
/

>  
>
>>Document describe and show tables functionality
>>-----------------------------------------------
>>
>>                Key: DERBY-1659
>>                URL: http://issues.apache.org/jira/browse/DERBY-1659
>>            Project: Derby
>>         Issue Type: Sub-task
>>         Components: Documentation
>>           Reporter: David Van Couvering
>>            Fix For: 10.2.1.0
>>
>>        Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>>
>>
>>Need to add documentation for this new feature
>>    
>>
>
>  
>


[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Andrew McIntyre updated DERBY-1659:
-----------------------------------

    Attachment: derby-1659-andrew-1.diff

I hadn't realized Kristian had offered to produce a patch for this, since when I checked earlier today noone was assigned to the issue. So earlier today I started to put together a patch for this issue based on David's HTML files. I cleaned up what I had done so that it builds properly and am attaching the patch here in the hopes of preventing duplication of effort in documenting this.

I expanded and reorganized what David had suggested, but I'm not sure that this is really ready to be committed. I put all of the syntax for SHOW into a single page, with examples for each choice in the next part of the SHOW grammar. This would seem to be slightly at odds with the way DITA organizes examples, which would have one <example> block with all of the examples for the <reference> block for SHOW. 

So, I'd really appreciate it if someone could help review and/or cleanup this patch and make it ready for commit. I'm always happy to hear suggestions as to where to go from here.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>             Fix For: 10.2.1.0
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "Jean T. Anderson (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Jean T. Anderson updated DERBY-1659:
------------------------------------

    Fix Version/s: 10.2.1.0

442496 merged to 10.2 branch revision 446722.
448620 merged to 10.2 branch revision 449063.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: Andrew McIntyre
>             Fix For: 10.2.1.0, 10.3.0.0
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, derby-1659-views.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Commented: (DERBY-1659) Document describe and show tables functionality

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1659?page=comments#action_12427079 ] 
            
Andrew McIntyre commented on DERBY-1659:
----------------------------------------

The online help in ij gives a description of the commands that are available. I think a brief description along with some simple examples is all that is necessary. If you don't have time to put together a DITA XML file for it, a simple HTML file can be easily DITAfied.

For whoever takes on the DITA impl, the new describe page should be subtopics of tools/rtoolsijcomref25570.html, and the show connections page tools/rtoolsijcomref17529.html should be made generic to the show command and updated to include the new information for show tables, etc.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>            Reporter: David Van Couvering
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "Andrew McIntyre (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Andrew McIntyre updated DERBY-1659:
-----------------------------------

    Fix Version/s: 10.3.0.0
                       (was: 10.2.1.0)

Marking FixIn 10.3 until this gets merged to 10.2 doc branch. Thanks for the review, Bryan!

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: Andrew McIntyre
>             Fix For: 10.3.0.0
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "Mike Matrigali (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Mike Matrigali updated DERBY-1659:
----------------------------------

    Fix Version/s: 10.2.1.0

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: David Van Couvering
>             Fix For: 10.2.1.0
>
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

David Van Couvering updated DERBY-1659:
---------------------------------------

    Attachment: ShowViews.html

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>            Reporter: David Van Couvering
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "Rick Hillegas (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Rick Hillegas updated DERBY-1659:
---------------------------------

    Urgency: Urgent

Bumping the urgency since the feature has gone in.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>             Fix For: 10.2.1.0
>
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

David Van Couvering updated DERBY-1659:
---------------------------------------

      Assignee:     (was: Kristian Waagan)
    Derby Info: [Patch Available]

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>             Fix For: 10.2.1.0
>
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "Kristian Waagan (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

Kristian Waagan updated DERBY-1659:
-----------------------------------

      Assignee: Kristian Waagan  (was: David Van Couvering)
    Derby Info:   (was: [Patch Available])

Hi David,

I have had a look at this, and can attach a preliminary DITA patch tomorrow. Not sure my approach is totally in line with the Tools manual, so I need some feedback on it.
I'm clearing the patch available flag, and also assigning myself to the issue.

If someone wants to add to the content after the first patch is submitted, feel free to assign yourself to the issue and bring it forward.

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: Kristian Waagan
>             Fix For: 10.2.1.0
>
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

Re: [jira] Commented: (DERBY-1659) Document describe and show tables functionality

Posted by "Jean T. Anderson" <jt...@bristowhill.com>.
Bryan Pendleton (JIRA) wrote:
...
> Andrew, I downloaded your diff and built the docs. They built fine, and the resulting HTML looks great.
...
> I do have one question, though. Why are some doc files named with "descriptive names" and
> some doc files named with "numeric names"? For example, in this change, we have:
> 
> ?      src/tools/rtoolsijcomrefshow.dita
> ?      src/tools/rtoolsijcomrefdescribe.dita
> M      src/tools/rtoolsijcomref17529.dita
> M      src/tools/derbytools.ditamap
> M      src/tools/rtoolsijcomref39198.dita
> 
> I assume this is just a side issue with my lack of understanding of the DITA
> process. Aside from understanding this trivial detail, everything else looks great to me.

Laura mentioned several weeks ago [1] that she thought the numeric
filenames were generated when the docs were converted to dita. She's
been naming new files using general terms.

 -jean


[1]
http://mail-archives.apache.org/mod_mbox/db-derby-dev/200608.mbox/%3c9f40b500608150207j1a5fec86h1a929f28e3dd0298@mail.gmail.com%3e

[jira] Commented: (DERBY-1659) Document describe and show tables functionality

Posted by "Bryan Pendleton (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1659?page=comments#action_12433609 ] 
            
Bryan Pendleton commented on DERBY-1659:
----------------------------------------

Andrew, I think you should mark this issue as assigned to you.

David, the docs you wrote look great. Thanks!

Andrew, I downloaded your diff and built the docs. They built fine, and the resulting HTML looks great.

Note to the committed: there are two new files here that need "svn add" when committing:
?      src/tools/rtoolsijcomrefshow.dita
?      src/tools/rtoolsijcomrefdescribe.dita

I do have one question, though. Why are some doc files named with "descriptive names" and
some doc files named with "numeric names"? For example, in this change, we have:

?      src/tools/rtoolsijcomrefshow.dita
?      src/tools/rtoolsijcomrefdescribe.dita
M      src/tools/rtoolsijcomref17529.dita
M      src/tools/derbytools.ditamap
M      src/tools/rtoolsijcomref39198.dita

I assume this is just a side issue with my lack of understanding of the DITA
process. Aside from understanding this trivial detail, everything else looks great to me.


> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>             Fix For: 10.2.1.0
>
>         Attachments: derby-1659-andrew-1-html.zip, derby-1659-andrew-1.diff, Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

David Van Couvering updated DERBY-1659:
---------------------------------------

      Assignee: David Van Couvering
    Derby Info: [Patch Available]

Not really a "patch", since it needs to be converted to DITA, but you get the idea...

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>            Reporter: David Van Couvering
>         Assigned To: David Van Couvering
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Updated: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
     [ http://issues.apache.org/jira/browse/DERBY-1659?page=all ]

David Van Couvering updated DERBY-1659:
---------------------------------------

    Attachment: ShowSchemas.html

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>            Reporter: David Van Couvering
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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

        

[jira] Commented: (DERBY-1659) Document describe and show tables functionality

Posted by "David Van Couvering (JIRA)" <de...@db.apache.org>.
    [ http://issues.apache.org/jira/browse/DERBY-1659?page=comments#action_12433236 ] 
            
David Van Couvering commented on DERBY-1659:
--------------------------------------------

I've attached the documentation, but it doesn't appear to be getting converted into DITA.  Is anyone going to take this?

> Document describe and show tables functionality
> -----------------------------------------------
>
>                 Key: DERBY-1659
>                 URL: http://issues.apache.org/jira/browse/DERBY-1659
>             Project: Derby
>          Issue Type: Sub-task
>          Components: Documentation
>            Reporter: David Van Couvering
>         Assigned To: David Van Couvering
>             Fix For: 10.2.1.0
>
>         Attachments: Describe.html, ShowProcedures.html, ShowSchemas.html, ShowSynonyms.html, ShowTable.html, ShowViews.html
>
>
> Need to add documentation for this new feature

-- 
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