From 12d693c5a07b69695163f4c0c94f9d2da1576c60 Mon Sep 17 00:00:00 2001 From: James McKinney <26463+jpmckinney@users.noreply.github.com> Date: Fri, 16 Aug 2024 16:03:34 -0400 Subject: [PATCH] docs: Regenerate docs with updated help text --- docs/scripts/csvsql.rst | 18 ++++++++++++------ man/csvclean.1 | 2 +- man/csvcut.1 | 2 +- man/csvformat.1 | 2 +- man/csvgrep.1 | 2 +- man/csvjoin.1 | 2 +- man/csvjson.1 | 2 +- man/csvlook.1 | 2 +- man/csvpy.1 | 2 +- man/csvsort.1 | 2 +- man/csvsql.1 | 19 ++++++++++++------- man/csvstack.1 | 2 +- man/csvstat.1 | 2 +- man/in2csv.1 | 2 +- man/sql2csv.1 | 2 +- 15 files changed, 37 insertions(+), 26 deletions(-) diff --git a/docs/scripts/csvsql.rst b/docs/scripts/csvsql.rst index 08b81306..ac7c11b7 100644 --- a/docs/scripts/csvsql.rst +++ b/docs/scripts/csvsql.rst @@ -42,19 +42,24 @@ Generate SQL statements for a CSV file or execute those statements directly on a A keyword argument to SQLAlchemy's create_engine(), as a space-separated pair. This option can be specified multiple times. For example: thick_mode True - --query QUERIES Execute one or more SQL queries delimited by ";" and - output the result of the last query as CSV. QUERY may - be a filename. --query may be specified multiple - times. + --query QUERIES Execute one or more SQL queries delimited by --sql- + delimiter, and output the result of the last query as + CSV. QUERY may be a filename. --query may be specified + multiple times. --insert Insert the data into the table. Requires --db. --prefix PREFIX Add an expression following the INSERT keyword, like OR IGNORE or OR REPLACE. --before-insert BEFORE_INSERT - Execute SQL before the INSERT command. Requires + Before the INSERT command, execute one or more SQL + queries delimited by --sql-delimiter. Requires --insert. --after-insert AFTER_INSERT - Execute SQL after the INSERT command. Requires + After the INSERT command, execute one or more SQL + queries delimited by --sql-delimiter. Requires --insert. + --sql-delimiter SQL_DELIMITER + Delimiter separating SQL queries in --query, --before- + insert, and --after-insert. --tables TABLE_NAMES A comma-separated list of names of tables to be created. By default, the tables will be named after the filenames without extensions or "stdin". @@ -88,6 +93,7 @@ Generate SQL statements for a CSV file or execute those statements directly on a Multiply the maximum column length by this multiplier to accomodate larger values in later runs. + See also: :doc:`../common_arguments`. For information on connection strings and supported dialects refer to the `SQLAlchemy documentation `_. diff --git a/man/csvclean.1 b/man/csvclean.1 index 3557d3f4..46f367ac 100644 --- a/man/csvclean.1 +++ b/man/csvclean.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVCLEAN" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVCLEAN" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvclean \- csvclean Documentation .SH DESCRIPTION diff --git a/man/csvcut.1 b/man/csvcut.1 index 2be63443..bc2aff10 100644 --- a/man/csvcut.1 +++ b/man/csvcut.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVCUT" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVCUT" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvcut \- csvcut Documentation .SH DESCRIPTION diff --git a/man/csvformat.1 b/man/csvformat.1 index d7a1fb0e..58ed8bdb 100644 --- a/man/csvformat.1 +++ b/man/csvformat.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVFORMAT" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVFORMAT" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvformat \- csvformat Documentation .SH DESCRIPTION diff --git a/man/csvgrep.1 b/man/csvgrep.1 index b7ff2a78..6768e749 100644 --- a/man/csvgrep.1 +++ b/man/csvgrep.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVGREP" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVGREP" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvgrep \- csvgrep Documentation .SH DESCRIPTION diff --git a/man/csvjoin.1 b/man/csvjoin.1 index 15057a27..fd44eda1 100644 --- a/man/csvjoin.1 +++ b/man/csvjoin.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVJOIN" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVJOIN" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvjoin \- csvjoin Documentation .SH DESCRIPTION diff --git a/man/csvjson.1 b/man/csvjson.1 index db1cc265..928899f9 100644 --- a/man/csvjson.1 +++ b/man/csvjson.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVJSON" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVJSON" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvjson \- csvjson Documentation .SH DESCRIPTION diff --git a/man/csvlook.1 b/man/csvlook.1 index 7a8f94bd..ec88ba34 100644 --- a/man/csvlook.1 +++ b/man/csvlook.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVLOOK" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVLOOK" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvlook \- csvlook Documentation .SH DESCRIPTION diff --git a/man/csvpy.1 b/man/csvpy.1 index 051ce11d..f27efbf1 100644 --- a/man/csvpy.1 +++ b/man/csvpy.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVPY" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVPY" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvpy \- csvpy Documentation .SH DESCRIPTION diff --git a/man/csvsort.1 b/man/csvsort.1 index 90c3a00c..db196389 100644 --- a/man/csvsort.1 +++ b/man/csvsort.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVSORT" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVSORT" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvsort \- csvsort Documentation .SH DESCRIPTION diff --git a/man/csvsql.1 b/man/csvsql.1 index 377748e3..ee5e766c 100644 --- a/man/csvsql.1 +++ b/man/csvsql.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVSQL" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVSQL" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvsql \- csvsql Documentation .SH DESCRIPTION @@ -71,19 +71,24 @@ optional arguments: A keyword argument to SQLAlchemy\(aqs create_engine(), as a space\-separated pair. This option can be specified multiple times. For example: thick_mode True - \-\-query QUERIES Execute one or more SQL queries delimited by \(dq;\(dq and - output the result of the last query as CSV. QUERY may - be a filename. \-\-query may be specified multiple - times. + \-\-query QUERIES Execute one or more SQL queries delimited by \-\-sql\- + delimiter, and output the result of the last query as + CSV. QUERY may be a filename. \-\-query may be specified + multiple times. \-\-insert Insert the data into the table. Requires \-\-db. \-\-prefix PREFIX Add an expression following the INSERT keyword, like OR IGNORE or OR REPLACE. \-\-before\-insert BEFORE_INSERT - Execute SQL before the INSERT command. Requires + Before the INSERT command, execute one or more SQL + queries delimited by \-\-sql\-delimiter. Requires \-\-insert. \-\-after\-insert AFTER_INSERT - Execute SQL after the INSERT command. Requires + After the INSERT command, execute one or more SQL + queries delimited by \-\-sql\-delimiter. Requires \-\-insert. + \-\-sql\-delimiter SQL_DELIMITER + Delimiter separating SQL queries in \-\-query, \-\-before\- + insert, and \-\-after\-insert. \-\-tables TABLE_NAMES A comma\-separated list of names of tables to be created. By default, the tables will be named after the filenames without extensions or \(dqstdin\(dq. diff --git a/man/csvstack.1 b/man/csvstack.1 index 7f09171d..dbc023be 100644 --- a/man/csvstack.1 +++ b/man/csvstack.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVSTACK" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVSTACK" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvstack \- csvstack Documentation .SH DESCRIPTION diff --git a/man/csvstat.1 b/man/csvstat.1 index 9772937c..5159c32e 100644 --- a/man/csvstat.1 +++ b/man/csvstat.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "CSVSTAT" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "CSVSTAT" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME csvstat \- csvstat Documentation .SH DESCRIPTION diff --git a/man/in2csv.1 b/man/in2csv.1 index 9e522e9a..2b07a6af 100644 --- a/man/in2csv.1 +++ b/man/in2csv.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "IN2CSV" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "IN2CSV" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME in2csv \- in2csv Documentation .SH DESCRIPTION diff --git a/man/sql2csv.1 b/man/sql2csv.1 index 2deb9a24..1528b75e 100644 --- a/man/sql2csv.1 +++ b/man/sql2csv.1 @@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. -.TH "SQL2CSV" "1" "Jul 29, 2024" "2.0.1" "csvkit" +.TH "SQL2CSV" "1" "Aug 16, 2024" "2.0.1" "csvkit" .SH NAME sql2csv \- sql2csv Documentation .SH DESCRIPTION