Codec options

Strategy to use when converting binary data to strings. Only applicable when unloading columns of CQL type blob, or unloading columns of a geometry type, if codec.geo is WKB. For the latter, see the codec.geo section.

Valid codec.binary values are:

Default: BASE64

Set how true and false representations of numbers are interpreted. The representation is of the form true_value,false_value. The mapping is reciprocal, so that numbers are mapping to Boolean and vice versa. All numbers unspecified in this setting are rejected.

Default: [1, 0]

Specify how true and false representations can be used by DataStax Bulk Loader. Each representation is of the form true_value:false_value, case-insensitive. For loading, all representations are honored. For unloading, the first representation is used and all others are ignored.

Ensure that your list of representations is inside quotes as a string. For example:

Default: ["1:0","Y:N","T:F","YES:NO","TRUE:FALSE"]

The temporal pattern to use for String to CQL date conversion. Valid choices:

Default: ISO_LOCAL_DATE

If codec.timestamp, codec.date, or codec.time is set to UNITS_SINCE_EPOCH, the epoch specified here determines the relative point in time to use when converting numeric data to and from temporals for the following cases:

When loading and the target CQL type is numeric, but the input is alphanumeric and represents a temporal literal, the codec.epoch and codec.unit values are used to convert the parsed temporal into a numeric value. For example, if the input is 2020-02-03T19:32:45Z and the epoch specified is 2000-01-01T00:00:00Z, the parsed timestamp is converted to N codec.units since January 1st 2000.

When parsing temporal literals, if the input does not contain a date part, then the date part of the instant specified here is used. For example, if the input is 19:32:45 and the epoch specified is 2000-01-01T00:00:00Z, then the input is interpreted as 2000-01-01T19:32:45Z.

The value must be expressed in ISO_ZONED_DATE_TIME, as covered in the Oracle Java documentation.

Default: "1970-01-01T00:00:00Z"

Whether to use the codec.number pattern to format all numeric output. When set to true, the numeric pattern defined by codec.number is applied. This allows for nicely-formatted output, but may result in rounding (see codec.roundingStrategy, or alteration of the original decimal’s scale. When set to false, numbers are stringified using the toString method, and never result in rounding or scale alteration. Only applicable when unloading, and only if the connector in use requires stringification, because the connector, such as the CSV connector, does not handle raw numeric data; ignored otherwise.

Default: false

Strategy to use when converting geometry types to strings. Geometry types are only available in DataStax Enterprise (DSE) 5.0 or higher. Only applicable when unloading columns of CQL type Point, LineString or Polygon, and only if the connector in use requires stringification. Valid values are:

The locale to use for locale-sensitive conversions.

Default: en_US

Comma-separated list of strings that should be mapped to null. For loading, when a record field value exactly matches one of the specified strings, the value is replaced with null before writing to DSE. For unloading, this setting is only applicable for string-based connectors, such as the CSV connector: the first string specified is used to change a row cell containing null to the specified string when written out. By default, no strings are mapped to null.

This setting is applied before schema.nullToUnset, hence any null produced by a null-string can still be left unset if required.

Default: [ ] (no strings mapped to null)

The DecimalFormat pattern to use for conversion between String and CQL numeric types. See java.text.DecimalFormat for details about the pattern syntax to use. Most inputs are recognized: optional localized thousands separator, localized decimal separator, or optional exponent. Using -locale en_US, 1234, 1,234, 1234.5678, 1,234.5678 and 1,234.5678E2 are all valid. For unloading and formatting, rounding may occur and cause precision loss. See --codec.formatNumbers and --codec.roundingStrategy.

Default: #,###.##

This setting can mean one of three possibilities:

Only applicable for loading, when parsing numeric inputs; it does not apply for unloading, since formatting never results in overflow.

Default: REJECT

The rounding strategy to use for conversions from CQL numeric types to String.

Valid choices: any java.math.RoundingMode enum constant name, including: CEILING, FLOOR, UP, DOWN, HALF_UP, HALF_EVEN, HALF_DOWN, and UNNECESSARY.

The precision used when rounding is inferred from the numeric pattern declared under codec.number. For example, the default codec.number `#,###.##` has a rounding precision of 2, and the number 123.456 is rounded to 123.46 if the --codec.rounding Strategy was set to UP.

The default value results in infinite precision, and ignores the --codec.number setting. Only applicable when unloading, if --codec.formatNumbers is true and if the connector in use requires stringification, because the connector, such as the CSV connector, does not handle raw numeric data; ignored otherwise.

Default: UNECESSARY

The temporal pattern to use for String to CQL time conversion. Valid choices:

Default: ISO_LOCAL_TIME

The temporal pattern to use for String to CQL timestamp conversion. Valid choices:

When parsing, CQL_TIMESTAMP_FORMAT recognizes most CQL temporal literals:

When the input is a local date, the timestamp is resolved at midnight using the specified timeZone. When the input is a local time, the timestamp is resolved using the time zone specified under timeZone, and the date is inferred from the instant specified under epoch (by default, January 1st 1970). When formatting, this format uses the ISO_OFFSET_DATE_TIME pattern, which is compliant with both CQL and ISO-8601.

Default: CQL_TIMESTAMP

The time zone to use for temporal conversions. When loading, the time zone is used to obtain a timestamp from inputs that do not convey any explicit time zone information. When unloading, the time zone is used to format all timestamps.

This option supports all ZoneId (Java Platform SE 8) formats.

Default: UTC

If codec.timestamp, codec.date, or codec.time is set to UNITS_SINCE_EPOCH, the time unit specified here is used to convert numeric data to and from temporals for the following cases:

When loading and the target CQL type is numeric, but the input is alphanumeric and represents a temporal literal, the time unit specified is used to convert the parsed temporal into a numeric value. For example, if the input is 2019-02-03T19:32:45Z and the time unit specified is SECONDS, the parsed temporal is converted into the number of seconds since a given --codec.epoch.

All TimeUnit enum constants are valid choices.

Default: MILLISECONDS

Strategy to use when generating time-based (version 1) UUIDs from timestamps. Clock sequence and node ID parts of generated UUIDs are determined on a best-effort basis and are not fully compliant with RFC 4122. Valid values are:

Default: RANDOM