Installing DataStax Bulk Loader
Introduction
DataStax Bulk Loader lets you efficiently and reliably load and unload CSV/JSON data in and out of:
-
DataStax Astra DB databases
-
DataStax Enterprise (DSE) 5.1 and 6.8 databases
-
Open source Apache Cassandra@reg; 2.1 and later databases
|
DataStax Bulk Loader is open-source software. Join the community of developers who contribute to the product! See the public GitHub repo: https://github.com/datastax/dsbulk |
DataStax recommends using the latest DataStax Bulk Loader version, which is currently 1.11. DataStax Bulk Loader is supported on Linux, macOS, and Windows platforms.
You can use DataStax Bulk Loader as a standalone tool that connects remotely to a cluster. The tool is not required to run locally on a cluster node, but can be used in this configuration.
Using DataStax Bulk Loader requires a Java executable, as explained in the post-install requirements and recommendations section.
Installation steps
|
Apache-2.0 license agreement. By downloading this DataStax product, you agree to the terms of the open-source Apache-2.0 license agreement. |
-
Download the DataStax Bulk Loader tarball or zip file from the DSBulk Loader’s GitHub repo: https://github.com/datastax/dsbulk/releases/tag/1.11.0
-
Select the package for your OS: A tar file is provided for Linux and macOS; a zip file is provided for Windows.
-
Unpack the downloaded distribution.
Linux example:
tar -xzvf dsbulk-{dsbulk-version}.tar.gz
Post-install requirements and recommendations
Java executable is required.
Using DataStax Bulk Loader requires a Java executable.
On macOS, Linux, and *nix systems, the rules used to find a Java executable are:
-
Use
$JAVAif defined -
Use
${JAVA_HOME}/bin/javaif defined -
Use
$(/usr/libexec/java_home)/bin/javaif defined -
Use the first Java executable found on
$PATH
On Windows systems, the rules used to find a Java executable are:
-
Use
%JAVA_HOME%\bin\javaif defined -
Use the first Java executable found on
$PATH
You can pass system properties to the DataStax Bulk Loader process by exporting the environment variable DSBULK_JAVA_OPTS.
This step can be useful, for example, to configure JMX monitoring, or to configure advanced authentication schemes such as Kerberos.
For example, on a Linux system:
# Remote JMX configuration
export DSBULK_JAVA_OPTS="$DSBULK_JAVA_OPTS -Dcom.sun.management.jmxremote.port=port-number"
# Kerberos configuration
export DSBULK_JAVA_OPTS="$DSBULK_JAVA_OPTS -Djava.security.krb5.conf=configuration-path-and-filename"
# Invoke DSBulk
bin/dsbulk load -h host1.com -k ks1 -t table1 -url data.csvRegarding any prior package installs
If you previously used a package install of DSE on the node where you just installed dsbulk, a prior version of dsbulk was included, such as 1.9.1. After unpacking the latest version of dsbulk from the standalone tarball, update your PATH so that it points to the new version.
For example, on a macOS node, edit your $HOME/.bashrc file, adding a command such as:
export PATH=path-to-unpacked-location/dsbulk-1.11/bin:$PATHFrom the command line, execute your updated .bashrc, and verify the dsbulk version.
Example:
source ~/.bashrcdsbulk --versionDataStax Bulk Loader 1.11What’s next?
Learn how to get started with DataStax Bulk Loader.
