Merge pull request orbisgis#952 from gpetit/gh-pages

Update some driver docs to take into account new control on input file name
gpetit · Dec 19, 2018 · 34afea9 · 34afea9
2 parents 6051106 + e713624
commit 34afea9
Show file tree

Hide file tree

Showing 6 changed files with 46 additions and 0 deletions.
diff --git a/docs/dev/DBFRead.md b/docs/dev/DBFRead.md
@@ -12,6 +12,7 @@ permalink: /docs/dev/DBFRead/
 ### Signatures
 
 {% highlight mysql %}
+DBFRead(VARCHAR path);
 DBFRead(VARCHAR path, VARCHAR tableName);
 DBFRead(VARCHAR path, VARCHAR tableName, VARCHAR fileEncoding);
 {% endhighlight %}
@@ -23,6 +24,13 @@ copies its contents into a new table `tableName` in the database.
 Define `fileEncoding` to force encoding (useful when the header is
 missing encoding information).
 
+If the `tablename` parameter is not specified, then the resulting table has the same name as the dBase file.
+
+<div class="note">
+  <h5>Warning on the input file name</h5>
+  <p>When a <code>tablename</code> is not specified, special caracters in the input file name are not allowed. The possible caracters are as follow: <code>A to Z</code>, <code>_</code> and <code>0 to 9</code>.</p>
+</div>
+
 ### Examples
 
 {% highlight mysql %}

diff --git a/docs/dev/GPXRead.md b/docs/dev/GPXRead.md
@@ -36,6 +36,11 @@ and may include:
 By default, the `tableName` is the filename given in `path` without
 the extension.
 
+<div class="note">
+  <h5>Warning on the input file name</h5>
+  <p>When a <code>tablename</code> is not specified, special caracters in the input file name are not allowed. The possible caracters are as follow: <code>A to Z</code>, <code>_</code> and <code>0 to 9</code>.</p>
+</div>
+
 ### Examples
 
 {% highlight mysql %}

diff --git a/docs/dev/GeoJsonRead.md b/docs/dev/GeoJsonRead.md
@@ -12,6 +12,7 @@ permalink: /docs/dev/GeoJsonRead/
 ### Signature
 
 {% highlight mysql %}
+GeoJsonRead(VARCHAR path);
 GeoJsonRead(VARCHAR path, VARCHAR tableName);
 {% endhighlight %}
 
@@ -20,12 +21,27 @@ GeoJsonRead(VARCHAR path, VARCHAR tableName);
 Reads a [GeoJSON][wiki] file from `path` and creates the
 corresponding spatial table `tableName`.
 
+If the `tablename` parameter is not specified, then the resulting table has the same name as the GeoJSON file.
+
+<div class="note">
+  <h5>Warning on the input file name</h5>
+  <p>When a <code>tablename</code> is not specified, special caracters in the input file name are not allowed. The possible caracters are as follow: <code>A to Z</code>, <code>_</code> and <code>0 to 9</code>.</p>
+</div>
+
 ### Examples
 
+{% highlight mysql %}
+CALL GeoJsonRead('/home/user/data.geojson');
+{% endhighlight %}
+
+&rarr; Here `data.geojson` will produce a table named `data`.
+
 {% highlight mysql %}
 CALL GeoJsonRead('/home/user/data.geojson', 'NEW_DATA');
 {% endhighlight %}
 
+&rarr; Here `data.geojson` will produce a table named `NEW_DATA`.
+
 ##### See also
 
 * [`GeoJsonWrite`](../GeoJsonWrite), [`ST_AsGeoJson`](../ST_AsGeoJson), [`ST_GeomFromGeoJson`](../ST_GeomFromGeoJson)

diff --git a/docs/dev/OSMRead.md b/docs/dev/OSMRead.md
@@ -38,6 +38,11 @@ Reads a [OSM][wiki] file from `path` and creates several tables prefixed by `tab
 By default, the `tableName` is the filename given in `path` without the extension.
 The OSM driver supports the following zipped extension : osm.gz and osm.bz2.
 
+<div class="note">
+  <h5>Warning on the input file name</h5>
+  <p>When a <code>tablename</code> is not specified, special caracters in the input file name are not allowed. The possible caracters are as follow: <code>A to Z</code>, <code>_</code> and <code>0 to 9</code>.</p>
+</div>
+
 ### Examples
 
 Read OSM file:

diff --git a/docs/dev/SHPRead.md b/docs/dev/SHPRead.md
@@ -24,6 +24,13 @@ contents into a new table `tableName` in the database.
 Define `fileEncoding` to force encoding (useful when the header is
 missing encoding information).
 
+If the `tablename` parameter is not specified, then the resulting table has the same name as the shapefile.
+
+<div class="note">
+  <h5>Warning on the input file name</h5>
+  <p>When a <code>tablename</code> is not specified, special caracters in the input file name are not allowed. The possible caracters are as follow: <code>A to Z</code>, <code>_</code> and <code>0 to 9</code>.</p>
+</div>
+
 ### Examples
 
 {% highlight mysql %}

diff --git a/docs/dev/TSVRead.md b/docs/dev/TSVRead.md
@@ -23,6 +23,11 @@ copies its contents into a new table `tableName` in the database.
 
 If the `tablename` parameter is not specified, then the resulting table has the same name as the TSV file.
 
+<div class="note">
+  <h5>Warning on the input file name</h5>
+  <p>When a <code>tablename</code> is not specified, special caracters in the input file name are not allowed. The possible caracters are as follow: <code>A to Z</code>, <code>_</code> and <code>0 to 9</code>.</p>
+</div>
+
 ### Example
 
 In following example, we have a TSV file, which is stored here : `/home/user/GoT.tsv`. This file is structured as follow.