Misplaced double quotes in error message

Started by Thomas Kellererover 4 years ago5 messagesgeneral
Jump to latest
#1Thomas Kellerer
shammat@gmx.net

Hello,

consider the following table, query and error message:

create table t
(
"someColumn" int
);

select t.someColumn
from t;

ERROR: column t.somecolumn does not exist
Hint: Perhaps you meant to reference the column "t.someColumn".

For someone proficient in SQL it's pretty clear what the error message means,
but the quotes can be misleading for someone who doesn't really understand
what's going on.

I think if the error message quoted the column name the way it should actually
be used, it would make things easier for someone not used to this, e.g.:

Hint: Perhaps you meant to reference the column t."someColumn".

Because when the user takes the error message literally they might be tempted
to use "t.someColumn" just to be confronted with the same error message again
which then seems even more confusing.

#2Adrian Klaver
adrian.klaver@aklaver.com
In reply to: Thomas Kellerer (#1)
Re: Misplaced double quotes in error message

On 10/6/21 11:17 PM, Thomas Kellerer wrote:

Hello,

consider the following table, query and error message:

create table t
(
"someColumn" int
);

select t.someColumn
from t;

ERROR: column t.somecolumn does not exist
Hint: Perhaps you meant to reference the column "t.someColumn".

For someone proficient in SQL it's pretty clear what the error message means,
but the quotes can be misleading for someone who doesn't really understand
what's going on.

FYI, errors are generically double quoted:

ERROR: invalid input syntax for type integer: "one"

This is not specific to identifier quoting.

I think if the error message quoted the column name the way it should actually
be used, it would make things easier for someone not used to this, e.g.:

Hint: Perhaps you meant to reference the column t."someColumn".

Because when the user takes the error message literally they might be tempted
to use "t.someColumn" just to be confronted with the same error message again
which then seems even more confusing.

--
Adrian Klaver
adrian.klaver@aklaver.com

#3Sunil Thakur
smthakur19@gmail.com
In reply to: Adrian Klaver (#2)
Re: Misplaced double quotes in error message

It means
Error thrown by Postgres: Hint: Perhaps you meant to reference the column
"t.someColumn".
must be Hint: Perhaps you meant to reference the column t."someColumn".

*Thanks and Regards,Sunil M. K. Thakur*
<https://www.linkedin.com/in/smthakur19&gt; *
<https://twitter.com/smthakur19&gt; <https://www.facebook.com/smthakur19&gt;*

On Thu, 7 Oct 2021 at 19:09, Adrian Klaver <adrian.klaver@aklaver.com>
wrote:

Show quoted text

On 10/6/21 11:17 PM, Thomas Kellerer wrote:

Hello,

consider the following table, query and error message:

create table t
(
"someColumn" int
);

select t.someColumn
from t;

ERROR: column t.somecolumn does not exist
Hint: Perhaps you meant to reference the column "t.someColumn".

For someone proficient in SQL it's pretty clear what the error message

means,

but the quotes can be misleading for someone who doesn't really

understand

what's going on.

FYI, errors are generically double quoted:

ERROR: invalid input syntax for type integer: "one"

This is not specific to identifier quoting.

I think if the error message quoted the column name the way it should

actually

be used, it would make things easier for someone not used to this, e.g.:

Hint: Perhaps you meant to reference the column t."someColumn".

Because when the user takes the error message literally they might be

tempted

to use "t.someColumn" just to be confronted with the same error message

again

which then seems even more confusing.

--
Adrian Klaver
adrian.klaver@aklaver.com

#4Tom Lane
tgl@sss.pgh.pa.us
In reply to: Adrian Klaver (#2)
Re: Misplaced double quotes in error message

Adrian Klaver <adrian.klaver@aklaver.com> writes:

On 10/6/21 11:17 PM, Thomas Kellerer wrote:

consider the following table, query and error message:
ERROR: column t.somecolumn does not exist
Hint: Perhaps you meant to reference the column "t.someColumn".

For someone proficient in SQL it's pretty clear what the error message means,
but the quotes can be misleading for someone who doesn't really understand
what's going on.

FYI, errors are generically double quoted:
ERROR: invalid input syntax for type integer: "one"
This is not specific to identifier quoting.

Yeah. This is not as simple as it looks, because per our message
style guidelines, double quotes are used to set off inserted text,
independently of whether it is a SQL identifier or something else.
(There is a style violation in this message: the occurrence of
t.somecolumn in the primary message should've been quoted too.)

In translated error messages, the English double quotes are replaced
with whatever the common quoting marks are in that language. So
for instance in French this becomes

ASTUCE : Peut-être que vous souhaitiez référencer la colonne « t.someColumn ».

where it's at least clearer that the set-off marks are not meant to be
copied into a SQL statement.

In short, what we've got here is unfortunate confusion between the meaning
of double quotes in ordinary English and their meaning in SQL. People
complain about this topic every so often, but I've not yet seen a proposal
that would improve matters.

regards, tom lane

#5Peter J. Holzer
hjp-pgsql@hjp.at
In reply to: Tom Lane (#4)
Re: Misplaced double quotes in error message

On 2021-10-07 10:55:09 -0400, Tom Lane wrote:

Yeah. This is not as simple as it looks, because per our message
style guidelines, double quotes are used to set off inserted text,
independently of whether it is a SQL identifier or something else.
(There is a style violation in this message: the occurrence of
t.somecolumn in the primary message should've been quoted too.)

In translated error messages, the English double quotes are replaced
with whatever the common quoting marks are in that language. So
for instance in French this becomes

ASTUCE : Peut-être que vous souhaitiez référencer la colonne « t.someColumn ».

where it's at least clearer that the set-off marks are not meant to be
copied into a SQL statement.

In short, what we've got here is unfortunate confusion between the meaning
of double quotes in ordinary English and their meaning in SQL. People
complain about this topic every so often, but I've not yet seen a proposal
that would improve matters.

You could use proper typographic quotes in English, too:

ERROR: column “t.somecolumn” does not exist
Hint: Perhaps you meant to reference the column “t.someColumn”.

But that's optically not very different (depends on your font, of
course) and your terminal has to support Unicode (or at least a subset
which includes those quotes).

hp

--
_ | Peter J. Holzer | Story must make more sense than reality.
|_|_) | |
| | | hjp@hjp.at | -- Charles Stross, "Creative writing
__/ | http://www.hjp.at/ | challenge!"