Common options

Common options for the dsbulk command

Some options are commonly required to use dsbulk. In the following list, required options are designated.

The options can be used in short form (-k keyspace_name) or long form (--schema.keyspace keyspace_name).

-f filename

Load options from the given file rather than from dsbulk_home/conf/application.conf.

Default: unspecified

-c,--connector.name csv | json

The name of the connector to use.

Default: csv

-k,--schema.keyspace string

Keyspace used for loading, unloading, or counting data. Keyspace names should not be quoted and are case-sensitive. MyKeyspace will match a keyspace named MyKeyspace but not mykeyspace. Required option if schema.query is not specified; otherwise, optional.

Default: unspecified

-t,--schema.table string

Table used for loading, unloading, or counting data. Table names should not be quoted and are case-sensitive. MyTable will match a table named MyTable but not mytable. Required option if schema.query is not specified; otherwise, optional.

Default: unspecified

-url,--connector.(csv|json).url string
The URL or path of the resource(s) to read from or wrote to. Possible options are - (representing stdin for reading and stdout for writing) and file (filepath). File URLs can also be expressed as simple paths without the file prefix. A directory of files can also be specified.

Default: -

-delim,--connector.csv.delimiter string

The character to use as field delimiter.

Default: , (a comma)

-header,--connector.csv.header ( true | false )
Enable or disable whether the files to read or write begin with a header line. If enabled for loading, the first non-empty line in every file will assign field names for each record column, in lieu of schema.mapping, fieldA = col1, fieldB = col2, fieldC = col3. If disabled for loading, records will not contain fields names, only field indexes, 0 = col1, 1 = col2, 2 = col3. For unloading, if this setting is enabled, each file will begin with a header line, and if disabled, each file will not contain a header line.
Note: This option will apply to all files loaded or unloaded.

Default: true

-h,--driver.hosts host_name(s)

The contact points to use for the initial connection to the cluster. This must be a comma-separated list of hosts, each specified by a host-name or IP address. If the host is a DNS name that resolves to multiple A-records, all the corresponding addresses will be used. Do not use localhost as a host-name (since it resolves to both IPv4 and IPv6 addresses on some platforms). The port for all hosts must be specified with driver.port.

Default: 127.0.0.1

-port,--driver.port port_number

The port to connect to at initial contact points. Note that all nodes in a cluster must accept connections on the same port number.

Default: 9042