Thread: Documentation for jdbc escapes

I just wrote my first piece of docbook to document the jdbc escaped
functions supported by the driver.
Don't hesitate to comment.
I didn't write about the procedure calls since I don't know the current
state of the driver for this part.
I hope this could be included in the driver documentation.

Xavier Poinsard.

On Fri, 21 Jan 2005, Xavier Poinsard wrote:

> I just wrote my first piece of docbook to document the jdbc escaped
> functions supported by the driver. Don't hesitate to comment. I didn't
> write about the procedure calls since I don't know the current state of
> the driver for this part. I hope this could be included in the driver
> documentation.

If you are soliciting general comments it would help to make it available
in a more accessible format:

http://www.ejurka.com/pgsql/docs/escfunc/

For general feedback it seems a little too table oriented with not enough
accompanying text.  Describing what the argument reordering and duplicate
problem actually is would be helpful.  Also an example including Java code
would help the understanding process of how to actually call these
functions.  Mentioning Connection.nativeSQL() seems appropriate.

In terms of specific feedback:
 - it should mention outer join escapes
 - the translation of dayname is in the wrong column (Table 1.3)
 - The comments should be full sentences, starting with a capital letter
   ending with a period.
 - Section titles should get some captialization.
 - Provide html link to referenced JDBC Technology guide
 - A number of typos/grammatical errors:
   - First paragraph
     - of of
     - had to specify way -> had to speciy a way
   - Second section (escaped scalar functions)
     - tables are showing -> tables show
     - The driver support -> The driver supports
     - specification describe the -> specification describes the

Kris Jurka

I updated the my documentation attempt with your remarks and added
mention for escape char escape.

Kris Jurka wrote:
> If you are soliciting general comments it would help to make it available
> in a more accessible format:

http://poinsarx.free.fr/pgsql/

>
> http://www.ejurka.com/pgsql/docs/escfunc/
>
> For general feedback it seems a little too table oriented with not enough
> accompanying text.  Describing what the argument reordering and duplicate
> problem actually is would be helpful.  Also an example including Java code
> would help the understanding process of how to actually call these
> functions.  Mentioning Connection.nativeSQL() seems appropriate.

done.

>
> In terms of specific feedback:
>  - it should mention outer join escapes
done.
>  - the translation of dayname is in the wrong column (Table 1.3)
done.
>  - The comments should be full sentences, starting with a capital letter
>    ending with a period.
done.
>  - Section titles should get some captialization.
done.
>  - Provide html link to referenced JDBC Technology guide
done.
>  - A number of typos/grammatical errors:
>    - First paragraph
>      - of of
>      - had to specify way -> had to speciy a way
>    - Second section (escaped scalar functions)
>      - tables are showing -> tables show
>      - The driver support -> The driver supports
>      - specification describe the -> specification describes the
Corrected.

On Tue, 25 Jan 2005, Xavier Poinsard wrote:

> I updated the my documentation attempt with your remarks and added
> mention for escape char escape.
>

Applied.

Kris Jurka