[jira] Created: (DERBY-3408) Wrong message when using SHOW in ij.

Wrong message when using SHOW in ij.
------------------------------------

                 Key: DERBY-3408
                 URL: https://issues.apache.org/jira/browse/DERBY-3408
             Project: Derby
          Issue Type: Bug
          Components: SQL
            Reporter: Jazarine Jamal


When running the show command using ij, it gives out a wrong message.

eg.:
ij> show schema;
ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.

he message should be something like:
Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Jazarine Jamal updated DERBY-3408:
----------------------------------

    Description:
When running the show command using ij, it gives out a wrong message.

eg.:
ij> show schema;
ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.

The message should be something like:
Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

  was:
When running the show command using ij, it gives out a wrong message.

eg.:
ij> show schema;
ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.

he message should be something like:
Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Jazarine Jamal updated DERBY-3408:
----------------------------------

    Priority: Minor  (was: Major)

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Priority: Minor
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

John H. Embretsen commented on DERBY-3408:
------------------------------------------

Although the current error message is not necessarily wrong, I certainly agree that it is not helpful at all, and should be improved.

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Priority: Minor
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Bryan Pendleton updated DERBY-3408:
-----------------------------------

    Attachment: suggestHelp.diff

One simple approach would be for IJ to notice when message 42X01
(the general all-purpose 'syntax error' message) was issued, and to
follow it up with a simple suggestion that the user might try using the
'help' command for general information about command syntax.

Attached is a simple patch to do this.

The output from IJ would then look like:

ij> show;
ERROR 42X01: Syntax error: Encountered "show" at line 1, column 1.
Issue the 'help' command for general information on IJ command syntax.
ij> show schema;
ERROR 42X01: Syntax error: Encountered "show" at line 1, column 1.
Issue the 'help' command for general information on IJ command syntax.

This may impact some number of regression tests; I haven't
investigated to see what the scope of the impact would be, just
wanted to see what people thought of this approach.

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Priority: Minor
>         Attachments: suggestHelp.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Knut Anders Hatlen commented on DERBY-3408:
-------------------------------------------

This looks like a good improvement to me. The SQL state 42X01 doesn't necessarily mean that the user issued one of the IJ-specific commands, like for instance:

ij> select * from t where x = 4 sort by z;
ERROR 42X01: Syntax error: Encountered "sort" at line 1, column 29.
Issue the 'help' command for general information on IJ command syntax.

Perhaps we should append "or consult the reference manual for the supported SQL syntax" or something to cover what the help command is silent about?

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Priority: Minor
>         Attachments: suggestHelp.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Jazarine Jamal commented on DERBY-3408:
---------------------------------------

Very goood improvement indeed!

Knut's comment is important too.

We could have an another option of including all the errors falling under the category: message 42X01 (the general all-purpose 'syntax error' message) in the help command.

What do everyone think of this?
Will it increase the footprint size considerably?

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Priority: Minor
>         Attachments: suggestHelp.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Knut Anders Hatlen commented on DERBY-3408:
-------------------------------------------

I think 42X01 can be raised for almost any SQL statement if you mistype something, so then we'd basically have to add all the supported SQL syntax to the help text. IJ is meant to work with other JDBC drivers too, so it's probably best not to assume too much about what syntax the underlying SQL engine supports.

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Priority: Minor
>         Attachments: suggestHelp.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Bryan Pendleton reassigned DERBY-3408:
--------------------------------------

    Assignee: Bryan Pendleton

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: suggestHelp.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Bryan Pendleton commented on DERBY-3408:
----------------------------------------

Thanks for the feedback! I like the idea of broadening the suggestion message
to also suggest referring to the reference docs for SQL syntax. I agree that putting
the complete SQL syntax in IJ's help would be problematic; in addition to the
issues mentioned, the IJ client can be used with a range of different versions
of the Derby server, each with its own particular version-specific dialect of
supported SQL.

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: suggestHelp.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Bryan Pendleton updated DERBY-3408:
-----------------------------------

    Attachment: suggestServerDocsToo.diff

Attached is a revised patch with an expanded suggestion message. The new output is as follows:

-bash-2.05b$ java org.apache.derby.tools.ij
ij version 10.5
ij> connect 'jdbc:derby:brydb;create=true';
ij> show;
ERROR 42X01: Syntax error: Encountered "show" at line 1, column 1.
Issue the 'help' command for general information on IJ command syntax. Any unrecognized commands are treated as potential SQL commands and executed directly. Consult your DBMS server reference documentation for details of the SQL syntax supported by your server.

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: suggestHelp.diff, suggestServerDocsToo.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Bryan Pendleton updated DERBY-3408:
-----------------------------------

    Attachment: includeSimpleTest.diff

I updated the patch proposal to include a simple
regression test as part of ij2.sql. Please let me
know of any additional comments regarding the patch.

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: includeSimpleTest.diff, suggestHelp.diff, suggestServerDocsToo.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Knut Anders Hatlen commented on DERBY-3408:
-------------------------------------------

Thanks, Bryan! I think the approach looks very good. Some small comments:

  - The indentation looks wrong in utilMain.java. Probably your editor is configured with tab size 8 instead of 4.

  - In utilMain.handleSQLException() the code that sets syntaxErrorOccurred is placed between a comment and the code that is described by the comment. Perhaps it would be clearer if the new code was placed above the comment?

  - Some of the other tools messages have line breaks so that they look nice in a terminal. Should we do the same for IJ_SuggestHelp?

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: includeSimpleTest.diff, suggestHelp.diff, suggestServerDocsToo.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Bryan Pendleton updated DERBY-3408:
-----------------------------------

    Attachment: afterCodeReview.txt

Thanks for the comments Knut, those are all very useful suggestions.

I tried placing line breaks in the message at the end of each
sentence. Depending on your terminal width the lines will
still wrap, but those seemed like reasonable places to break the lines.

Please have a look at 'afterCodeReview.txt' and tell me what you think.

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: afterCodeReview.txt, includeSimpleTest.diff, suggestHelp.diff, suggestServerDocsToo.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Knut Anders Hatlen commented on DERBY-3408:
-------------------------------------------

Thanks Bryan, it looks much better now. +1 to commit.

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: afterCodeReview.txt, includeSimpleTest.diff, suggestHelp.diff, suggestServerDocsToo.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Bryan Pendleton commented on DERBY-3408:
----------------------------------------

I've run a complete set of regression tests, and, as I suspected, I'm going to have
to update a fair number of test output files.

Before I go propose a big patch to do this, I'd like to respond to any other
feedback regarding the message itself. So if anybody else has any opinions
on the new message, please let me know.

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: afterCodeReview.txt, includeSimpleTest.diff, suggestHelp.diff, suggestServerDocsToo.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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

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

Bryan Pendleton updated DERBY-3408:
-----------------------------------

    Attachment: withUpdatedRegressionTestOutput.diff

Attached 'withUpdatedRegressionTestOutput.diff' patch proposal includes
the same code changes as in the previous patch ('afterCodeReview.txt'),
but also includes changes to all the various regression test output files
to reflect the new IJ output.

The regression test output file changes are simply to add the new text
whenever a 42X01message is emitted.

The regression tests now pass successfully with this patch, review would
be appreciated.

> Wrong message when using SHOW in ij.
> ------------------------------------
>
>                 Key: DERBY-3408
>                 URL: https://issues.apache.org/jira/browse/DERBY-3408
>             Project: Derby
>          Issue Type: Bug
>          Components: SQL
>            Reporter: Jazarine Jamal
>            Assignee: Bryan Pendleton
>            Priority: Minor
>         Attachments: afterCodeReview.txt, includeSimpleTest.diff, suggestHelp.diff, suggestServerDocsToo.diff, withUpdatedRegressionTestOutput.diff
>
>
> When running the show command using ij, it gives out a wrong message.
> eg.:
> ij> show schema;
> ERROR 42X01: Syntax error: Encountered "show" at line 2, column 1.
> The message should be something like:
> Syntax error: Encountered "schema" at line 2,column 1:no such thing as "schema"

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