jdbc-driver-csv icon indicating copy to clipboard operation
jdbc-driver-csv copied to clipboard

Documentation for url syntax is minimal and confusing

Open davidmichaelkarr opened this issue 7 years ago • 1 comments

The entire documentation for the format of the connection URL is the following:

The URL syntax for the driver URL is as follows

    jdbc:xbib:csv:<foldername>[?<property=value]",

File names are mapped to table names. By default, the extension .csv is assumed. Example:

    "jdbc:xbib:csv:myDataFolder?quotechar=~",

This has a few problems. Just reading through this carefully, they should be obvious.

Despite the ambiguity in the first example, designed to show the syntax abstractly, the actual example does help a bit, but even that is ambiguous. The second example has quotes and ends with a comma after the quotes. I'm sure that can't be right.

The documentation also needs more explanation of how the "MyDatFolder" value is used. Is that intended to be an absolute path? The example makes it seem like it's just a folder name, not a path.

davidmichaelkarr avatar Feb 23 '18 16:02 davidmichaelkarr

And now I see after stepping into the code, that it doesn't even mention or show the case where you have to set multiple properties (almost a sure thing for any set of real tables). The implication from what I read is that it uses "," to separate properties, but it actually uses "&". That is logical from a URL point of view, but that's not obvious from this.

davidmichaelkarr avatar Feb 23 '18 20:02 davidmichaelkarr