From: Karl O. Pinc <kop@karlpinc.com>
Date: Sat, 22 Jun 2024 03:17:12 +0000 (-0500)
Subject: Document use of "trim" keyword in contents.yaml
X-Git-Url: https://papio.biology.duke.edu/gitweb/?a=commitdiff_plain;h=dd183d40498da3f7fd4401b98f4b6dce65fc4695;p=pgwui_bulk_upload

Document use of "trim" keyword in contents.yaml
---

diff --git a/README.rst b/README.rst
index bf8c98c..b37cc9c 100644
--- a/README.rst
+++ b/README.rst
@@ -46,7 +46,9 @@ The map file is in YAML syntax, which for purposes of this document
 can be thought of as a superset of JSON.  It must contain a top-level
 tag, `map_list`, which itself contains a list of maps, each of which
 maps a file to a table or view.  The table (or view) names may,
-optionally, be schema qualified.  An example map file might be::
+optionally, be schema qualified.  The "trim" key is optional, when
+omitted the trim setting from the user interface is applied.  An
+example map file might be::
 
   # This file is contents.yml
   map_list:
@@ -55,14 +57,17 @@ optionally, be schema qualified.  An example map file might be::
         file: foo.csv
         relation: foo_table
     # Load the bar.csv file into the bar_view uploadable-view of the default
-    # schema.
+    # schema.  Always trim leading and trailing whitespace from each column.
     - file_map:
         file: bar.csv
         relation: bar_view
+        trim: true
     # Load the baz.csv file into the baz_table table of the meta schema.
+    # Never trim leading and trailing whitespace from each column.
     - file_map:
         file: baz.csv
         relation: meta.baz_table
+        trim: false
 
 The files within each directory are uploaded in the order in which
 they are listed in the map file.  The directories in the zip file are