Skip to content

Commit

Permalink
docs: Regenerate docs with updated help text
Browse files Browse the repository at this point in the history
  • Loading branch information
@jpmckinney
jpmckinney committed Aug 16, 2024
1 parent 7c4478f commit 12d693c
Show file tree
Hide file tree
Showing 15 changed files with 37 additions and 26 deletions.
18 changes: 12 additions & 6 deletions docs/scripts/csvsql.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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".
Expand Down Expand Up @@ -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 <https://www.sqlalchemy.org/docs/dialects/>`_.
Expand Down
2 changes: 1 addition & 1 deletion man/csvclean.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/csvcut.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/csvformat.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/csvgrep.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/csvjoin.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/csvjson.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/csvlook.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/csvpy.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/csvsort.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
19 changes: 12 additions & 7 deletions man/csvsql.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion man/csvstack.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/csvstat.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/in2csv.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion man/sql2csv.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 12d693c

Please sign in to comment.