[MCOL-1191] Missing details or default values of cpimport in the command helper and in the docs Created: 2018-02-01  Updated: 2022-11-05  Resolved: 2022-11-05

Status: Closed
Project: MariaDB ColumnStore
Component/s: Documentation
Affects Version/s: None
Fix Version/s: Icebox

Type: Task Priority: Minor
Reporter: Zdravelina Sokolovska (Inactive) Assignee: Unassigned
Resolution: Won't Do Votes: 0
Labels: None

Issue Links:
Relates
relates to MCOL-4948 config file for cpimport options if u... Open

 Description   

Missing details or default values of cpimport in the command helper and in the docs

1.In the docs as well in the helper are missing details about some option values of cpimport
2.it's not clear also if use cpimport with colxml job
what's the correlation of colxml options and cpimport options
for example is the -r option of cpimport the same as the -r of colxml ?
if it's the same , but issue colxml and then cpimport with diffrent values of the same option which will be overruled ?

for example
from cpimport
-b Number of read buffers
-c Application read buffer size(in bytes)
-r Number of readers.
-e Max number of allowable error per table per PM
-q Batch Quantity, Number of rows distributed per batch in Mode 1
-B I/O library read buffer size (in bytes)
-w Number of parsers.
etc

 
[root@um1 ~]# cpimport -h
Simple usage using positional parameters (no XML job file):
        cpimport dbName tblName [loadFile] [-h] [-m mode]
                 [-f path] [-d debugLevel] [-c readbufSize] [-b readBufs]
                 [-r readers] [-j JobID] [-e maxErrs] [-B libBufSize] [-w parsers]
                 [-s c] [-E enclosedChar] [-C escapeChar] [-n NullOption]
                 [-q batchQty] [-p jobPath] [-P list of PMs] [-S] [-i] [-v verbose]
                 [-I binaryOpt]
Traditional usage without positional parameters (XML job file required):
        cpimport -j jobID
                 [-h] [-m mode] [-r readers] [-w parsers] [-s c] [-f path]
                 [-b readBufs] [-p path] [-c readBufSize] [-e maxErrs] [-B libBufSize]
                 [-n NullOption] [-E encloseChar] [-C escapeChar] [-i] [-v verbose]
                 [-d debugLevel] [-q batchQty] [-l loadFile] [-P list of PMs] [-S]
                 [-I binaryOpt]
 
 
Positional parameters:
        dbName     Name of the database to load
        tblName    Name of table to load
        loadFile   Optional input file name in current directory,
                        unless a fully qualified name is given.
                        If not given, input read from STDIN.
 
 
Options:
        -b      Number of read buffers
        -c      Application read buffer size(in bytes)
        -d      Print different level(1-3) debug message
        -e      Max number of allowable error per table per PM
        -f      Data file directory path.
                        Default is current working directory.
                        In Mode 1, -f represents the local input file path.
                        In Mode 2, -f represents the PM based input file path.
                        In Mode 3, -f represents the local input file path.
        -l      Name of import file to be loaded, relative to -f path,
        -h      Print this message.
        -q      Batch Quantity, Number of rows distributed per batch in Mode 1
        -i      Print extended info to console in Mode 3.
        -j      Job ID. In simple usage, default is the table OID.
                        unless a fully qualified input file name is given.
        -n      NullOption (0-treat the string NULL as data (default);
                        1-treat the string NULL as a NULL value)
        -p      Path for XML job description file.
        -r      Number of readers.
        -s      'c' is the delimiter between column values.
        -B      I/O library read buffer size (in bytes)
        -w      Number of parsers.
        -E      Enclosed by character if field values are enclosed.
        -C      Escape character used in conjunction with 'enclosed by'
                        character, or as part of NULL escape sequence ('\N');
                        default is '\'
        -I      Import binary data; how to treat NULL values:
                        1 - import NULL values
                        2 - saturate NULL values
        -P      List of PMs ex: -P 1,2,3. Default is all PMs.
        -S      Treat string truncations as errors.
        -m      mode
                        1 - rows will be loaded in a distributed manner across PMs.
                        2 - PM based input files loaded onto their respective PM.
                        3 - input files will be loaded on the local PM.
 
Example1: Traditional usage
        cpimport -j 1234
Example2: Some column values are enclosed within double quotes.
        cpimport -j 3000 -E '"'
Example3: Import a nation table without a Job XML file
        cpimport -j 301 tpch nation nation.tbl
Example4: Import a nation table to all PMs in Mode 1
        cpimport -m 1 tpch nation nation.tbl
Example4: Import a nation table to only PM1 and PM2 in Mode 1
        cpimport -m 1 -P 1,2 tpch nation nation.tbl
Example5: Import nation.tbl from PMs to nation table in Mode 2
        cpimport -m 2 tpch nation -l nation.tbl
Example6: Import nation.tbl in mode 3
        cpimport -m 3 tpch nation nation.tbl
 
[root@um1 ~]#

cpimport dbName tblName [loadFile]
[-h] [-m mode] [-f filepath] [-d DebugLevel]
[-c readBufferSize] [-b numBuffers] [-r numReaders]
[-e maxErrors] [-B libBufferSize] [-s colDelimiter] [-E EnclosedByChar]
[-C escChar] [-j jobID] [-p jobFilePath] [-w numParsers]
[-n nullOption] [-P pmList] [-i] [-S] [-q batchQty]
 
positional parameters:
	dbName     Name of the database to load
	tblName    Name of table to load
	loadFile   Optional input file name in current directory,
			unless a fully qualified name is given.
			If not given, input read from STDIN.
Options:
	-b	Number of read buffers
	-c	Application read buffer size(in bytes)
	-d	Print different level(1-3) debug message
	-e	Max number of allowable error per table per PM
	-f	Data file directory path.
			Default is current working directory.
			In Mode 1, -f represents the local input file path.
			In Mode 2, -f represents the PM based input file path.
			In Mode 3, -f represents the local input file path.
	-l	Name of import file to be loaded, relative to -f path,
	-h	Print this message.
	-q	Batch Quantity, Number of rows distributed per batch in Mode 1
	-i	Print extended info to console in Mode 3.
	-j	Job ID. In simple usage, default is the table OID.
			unless a fully qualified input file name is given.
	-n	NullOption (0-treat the string NULL as data (default);
			1-treat the string NULL as a NULL value)
	-p	Path for XML job description file.
	-r	Number of readers.
	-s	'c' is the delimiter between column values.
	-B	I/O library read buffer size (in bytes)
	-w	Number of parsers.
	-E	Enclosed by character if field values are enclosed.
	-C	Escape character used in conjunction with 'enclosed by'
			character, or as part of NULL escape sequence ('\N');
			default is '\'
	-I	Import binary data; how to treat NULL values:
			1 - import NULL values
			2 - saturate NULL values
	-P	List of PMs ex: -P 1,2,3. Default is all PMs.
	-S	Treat string truncations as errors.
	-m	mode
			1 - rows will be loaded in a distributed manner across PMs.
			2 - PM based input files loaded onto their respective PM.
			3 - input files will be loaded on the local PM.



 Comments   
Comment by Todd Stoffel (Inactive) [ 2022-11-05 ]

This item is being closed because it was well passed the expiration date with no activity. If you suspect this was done in error please create a new ticket.

Generated at Thu Feb 08 02:26:53 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.