Skip to content

Commit 12d693c

Browse files
jpmckinneyjpmckinney
committed
docs: Regenerate docs with updated help text
1 parent 7c4478f commit 12d693c

15 files changed

+37
-26
lines changed

‎docs/scripts/csvsql.rst

+12-6
Original file line numberDiff line numberDiff line change
@@ -42,19 +42,24 @@ Generate SQL statements for a CSV file or execute those statements directly on a
4242
A keyword argument to SQLAlchemy's create_engine(), as
4343
a space-separated pair. This option can be specified
4444
multiple times. For example: thick_mode True
45-
--query QUERIES Execute one or more SQL queries delimited by ";" and
46-
output the result of the last query as CSV. QUERY may
47-
be a filename. --query may be specified multiple
48-
times.
45+
--query QUERIES Execute one or more SQL queries delimited by --sql-
46+
delimiter, and output the result of the last query as
47+
CSV. QUERY may be a filename. --query may be specified
48+
multiple times.
4949
--insert Insert the data into the table. Requires --db.
5050
--prefix PREFIX Add an expression following the INSERT keyword, like
5151
OR IGNORE or OR REPLACE.
5252
--before-insert BEFORE_INSERT
53-
Execute SQL before the INSERT command. Requires
53+
Before the INSERT command, execute one or more SQL
54+
queries delimited by --sql-delimiter. Requires
5455
--insert.
5556
--after-insert AFTER_INSERT
56-
Execute SQL after the INSERT command. Requires
57+
After the INSERT command, execute one or more SQL
58+
queries delimited by --sql-delimiter. Requires
5759
--insert.
60+
--sql-delimiter SQL_DELIMITER
61+
Delimiter separating SQL queries in --query, --before-
62+
insert, and --after-insert.
5863
--tables TABLE_NAMES A comma-separated list of names of tables to be
5964
created. By default, the tables will be named after
6065
the filenames without extensions or "stdin".
@@ -88,6 +93,7 @@ Generate SQL statements for a CSV file or execute those statements directly on a
8893
Multiply the maximum column length by this multiplier
8994
to accomodate larger values in later runs.
9095
96+
9197
See also: :doc:`../common_arguments`.
9298

9399
For information on connection strings and supported dialects refer to the `SQLAlchemy documentation <https://www.sqlalchemy.org/docs/dialects/>`_.

‎man/csvclean.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVCLEAN" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVCLEAN" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvclean \- csvclean Documentation
3333
.SH DESCRIPTION

‎man/csvcut.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVCUT" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVCUT" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvcut \- csvcut Documentation
3333
.SH DESCRIPTION

‎man/csvformat.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVFORMAT" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVFORMAT" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvformat \- csvformat Documentation
3333
.SH DESCRIPTION

‎man/csvgrep.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVGREP" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVGREP" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvgrep \- csvgrep Documentation
3333
.SH DESCRIPTION

‎man/csvjoin.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVJOIN" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVJOIN" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvjoin \- csvjoin Documentation
3333
.SH DESCRIPTION

‎man/csvjson.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVJSON" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVJSON" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvjson \- csvjson Documentation
3333
.SH DESCRIPTION

‎man/csvlook.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVLOOK" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVLOOK" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvlook \- csvlook Documentation
3333
.SH DESCRIPTION

‎man/csvpy.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVPY" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVPY" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvpy \- csvpy Documentation
3333
.SH DESCRIPTION

‎man/csvsort.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVSORT" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVSORT" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvsort \- csvsort Documentation
3333
.SH DESCRIPTION

‎man/csvsql.1

+12-7
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVSQL" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVSQL" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvsql \- csvsql Documentation
3333
.SH DESCRIPTION
@@ -71,19 +71,24 @@ optional arguments:
7171
A keyword argument to SQLAlchemy\(aqs create_engine(), as
7272
a space\-separated pair. This option can be specified
7373
multiple times. For example: thick_mode True
74-
\-\-query QUERIES Execute one or more SQL queries delimited by \(dq;\(dq and
75-
output the result of the last query as CSV. QUERY may
76-
be a filename. \-\-query may be specified multiple
77-
times.
74+
\-\-query QUERIES Execute one or more SQL queries delimited by \-\-sql\-
75+
delimiter, and output the result of the last query as
76+
CSV. QUERY may be a filename. \-\-query may be specified
77+
multiple times.
7878
\-\-insert Insert the data into the table. Requires \-\-db.
7979
\-\-prefix PREFIX Add an expression following the INSERT keyword, like
8080
OR IGNORE or OR REPLACE.
8181
\-\-before\-insert BEFORE_INSERT
82-
Execute SQL before the INSERT command. Requires
82+
Before the INSERT command, execute one or more SQL
83+
queries delimited by \-\-sql\-delimiter. Requires
8384
\-\-insert.
8485
\-\-after\-insert AFTER_INSERT
85-
Execute SQL after the INSERT command. Requires
86+
After the INSERT command, execute one or more SQL
87+
queries delimited by \-\-sql\-delimiter. Requires
8688
\-\-insert.
89+
\-\-sql\-delimiter SQL_DELIMITER
90+
Delimiter separating SQL queries in \-\-query, \-\-before\-
91+
insert, and \-\-after\-insert.
8792
\-\-tables TABLE_NAMES A comma\-separated list of names of tables to be
8893
created. By default, the tables will be named after
8994
the filenames without extensions or \(dqstdin\(dq.

‎man/csvstack.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVSTACK" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVSTACK" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvstack \- csvstack Documentation
3333
.SH DESCRIPTION

‎man/csvstat.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "CSVSTAT" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "CSVSTAT" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
csvstat \- csvstat Documentation
3333
.SH DESCRIPTION

‎man/in2csv.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "IN2CSV" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "IN2CSV" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
in2csv \- in2csv Documentation
3333
.SH DESCRIPTION

‎man/sql2csv.1

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
2727
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
2828
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
2929
..
30-
.TH "SQL2CSV" "1" "Jul 29, 2024" "2.0.1" "csvkit"
30+
.TH "SQL2CSV" "1" "Aug 16, 2024" "2.0.1" "csvkit"
3131
.SH NAME
3232
sql2csv \- sql2csv Documentation
3333
.SH DESCRIPTION

0 commit comments

Comments
 (0)