.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
.TH CSVJOIN "1" "March 2023" "csvjoin 1.1.1" "User Commands"
.SH NAME
csvjoin \- manual page for csvjoin 1.1.1
.SH DESCRIPTION
usage: csvjoin [\-h] [\-d DELIMITER] [\-t] [\-q QUOTECHAR] [\-u {0,1,2,3}] [\-b]
.IP
[\-p ESCAPECHAR] [\-z FIELD_SIZE_LIMIT] [\-e ENCODING] [\-L LOCALE]
[\-S] [\-\-blanks] [\-\-date\-format DATE_FORMAT]
[\-\-datetime\-format DATETIME_FORMAT] [\-H] [\-K SKIP_LINES] [\-v]
[\-l] [\-\-zero] [\-V] [\-c COLUMNS] [\-\-outer] [\-\-left] [\-\-right]
[\-y SNIFF_LIMIT] [\-I]
[FILE ...]
.PP
Execute a SQL\-like join to merge CSV files on a specified column or columns.
.SS "positional arguments:"
.TP
FILE
The CSV files to operate on. If only one is specified,
it will be copied to STDOUT.
.SS "options:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-d\fR DELIMITER, \fB\-\-delimiter\fR DELIMITER
Delimiting character of the input CSV file.
.TP
\fB\-t\fR, \fB\-\-tabs\fR
Specify that the input CSV file is delimited with
tabs. Overrides "\-d".
.TP
\fB\-q\fR QUOTECHAR, \fB\-\-quotechar\fR QUOTECHAR
Character used to quote strings in the input CSV file.
.TP
\fB\-u\fR {0,1,2,3}, \fB\-\-quoting\fR {0,1,2,3}
Quoting style used in the input CSV file. 0 = Quote
Minimal, 1 = Quote All, 2 = Quote Non\-numeric, 3 =
Quote None.
.TP
\fB\-b\fR, \fB\-\-no\-doublequote\fR
Whether or not double quotes are doubled in the input
CSV file.
.TP
\fB\-p\fR ESCAPECHAR, \fB\-\-escapechar\fR ESCAPECHAR
Character used to escape the delimiter if \fB\-\-quoting\fR 3
("Quote None") is specified and to escape the
QUOTECHAR if \fB\-\-no\-doublequote\fR is specified.
.TP
\fB\-z\fR FIELD_SIZE_LIMIT, \fB\-\-maxfieldsize\fR FIELD_SIZE_LIMIT
Maximum length of a single field in the input CSV
file.
.TP
\fB\-e\fR ENCODING, \fB\-\-encoding\fR ENCODING
Specify the encoding of the input CSV file.
.TP
\fB\-L\fR LOCALE, \fB\-\-locale\fR LOCALE
Specify the locale (en_US) of any formatted numbers.
.TP
\fB\-S\fR, \fB\-\-skipinitialspace\fR
Ignore whitespace immediately following the delimiter.
.TP
\fB\-\-blanks\fR
Do not convert "", "na", "n/a", "none", "null", "." to
NULL.
.TP
\fB\-\-date\-format\fR DATE_FORMAT
Specify a strptime date format string like "%m/%d/%Y".
.TP
\fB\-\-datetime\-format\fR DATETIME_FORMAT
Specify a strptime datetime format string like
"%m/%d/%Y %I:%M %p".
.TP
\fB\-H\fR, \fB\-\-no\-header\-row\fR
Specify that the input CSV file has no header row.
Will create default headers (a,b,c,...).
.TP
\fB\-K\fR SKIP_LINES, \fB\-\-skip\-lines\fR SKIP_LINES
Specify the number of initial lines to skip before the
header row (e.g. comments, copyright notices, empty
rows).
.TP
\fB\-v\fR, \fB\-\-verbose\fR
Print detailed tracebacks when errors occur.
.TP
\fB\-l\fR, \fB\-\-linenumbers\fR
Insert a column of line numbers at the front of the
output. Useful when piping to grep or as a simple
primary key.
.TP
\fB\-\-zero\fR
When interpreting or displaying column numbers, use
zero\-based numbering instead of the default 1\-based
numbering.
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version information and exit.
.TP
\fB\-c\fR COLUMNS, \fB\-\-columns\fR COLUMNS
The column name(s) on which to join. Should be either
one name (or index) or a comma\-separated list with one
name (or index) per file, in the same order in which
the files were specified. If not specified, the two
files will be joined sequentially without matching.
.TP
\fB\-\-outer\fR
Perform a full outer join, rather than the default
inner join.
.TP
\fB\-\-left\fR
Perform a left outer join, rather than the default
inner join. If more than two files are provided this
will be executed as a sequence of left outer joins,
starting at the left.
.TP
\fB\-\-right\fR
Perform a right outer join, rather than the default
inner join. If more than two files are provided this
will be executed as a sequence of right outer joins,
starting at the right.
.TP
\fB\-y\fR SNIFF_LIMIT, \fB\-\-snifflimit\fR SNIFF_LIMIT
Limit CSV dialect sniffing to the specified number of
bytes. Specify "0" to disable sniffing entirely, or
"\-1" to sniff the entire file.
.TP
\fB\-I\fR, \fB\-\-no\-inference\fR
Disable type inference when parsing CSV input.
.PP
Note that the join operation requires reading all files into memory. Don't try
this on very large files.
.SH "SEE ALSO"
The full documentation for
.B csvjoin
is maintained as a Texinfo manual.  If the
.B info
and
.B csvjoin
programs are properly installed at your site, the command
.IP
.B info csvjoin
.PP
should give you access to the complete manual.