Package org.apache.cassandra.spark.bulkwriter

Enum WriterOptions

java.lang.Object

java.lang.Enum<WriterOptions>

org.apache.cassandra.spark.bulkwriter.WriterOptions

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<WriterOptions>, WriterOption

public enum WriterOptions
extends java.lang.Enum<WriterOptions>
implements WriterOption

Spark options to configure bulk writer

Enum Constant Summary

Enum Constants

Enum Constant	Description
BULK_WRITER_CL
CASSANDRA_ROLE	Option that specifies cassandra role used for role based access control in Sidecar.
COMMIT_BATCH_SIZE
COMMIT_THREADS_PER_INSTANCE
COORDINATED_WRITE_CONFIG	The option specifies the configuration (in JSON) for coordinated write.
DATA_TRANSPORT	Option to specify the data transport mode.
DATA_TRANSPORT_EXTENSION_CLASS	Option to specify the FQCN of class that implements StorageTransportExtension
DIGEST	Option that specifies the type of digest to compute when uploading SSTables for checksum validation.
JOB_ID
JOB_KEEP_ALIVE_MINUTES	Option to specify the keep alive time in minutes for Sidecar to consider a job has lost/failed after not receiving its heartbeat
JOB_TIMEOUT_SECONDS	Option to specify the timeout in seconds for bulk write jobs.
KEYSPACE
KEYSTORE_BASE64_ENCODED
KEYSTORE_PASSWORD
KEYSTORE_PATH
KEYSTORE_TYPE
LOCAL_DC
MAX_SIZE_PER_SSTABLE_BUNDLE_IN_BYTES_S3_TRANSPORT	Option to specify the maximum size of bundle (s3 object) to upload to s3
NUMBER_SPLITS
QUOTE_IDENTIFIERS	Option that specifies whether the identifiers (i.e.
SIDECAR_CONTACT_POINTS
SIDECAR_INSTANCES	Deprecated.
SIDECAR_PORT
SKIP_EXTENDED_VERIFY
SSTABLE_DATA_SIZE_IN_MB	Deprecated.
SSTABLE_DATA_SIZE_IN_MIB
STORAGE_CLIENT_CONCURRENCY	Option to tune the concurrency of S3 client's worker thread pool
STORAGE_CLIENT_ENDPOINT_OVERRIDE	Option to specify the s3 server endpoint override; it is mostly used for testing
STORAGE_CLIENT_HTTPS_PROXY	Option to specify the https proxy for s3 client
STORAGE_CLIENT_MAX_CHUNK_SIZE_IN_BYTES	Option to specify the max chunk size for the multipart upload to S3
STORAGE_CLIENT_NIO_HTTP_CLIENT_CONNECTION_ACQUISITION_TIMEOUT_SECONDS	Option to tune the connection acquisition timeout for the nio http client employed in s3 client
STORAGE_CLIENT_NIO_HTTP_CLIENT_MAX_CONCURRENCY	Option to tune the concurrency of the nio http client employed in s3 client
STORAGE_CLIENT_THREAD_KEEP_ALIVE_SECONDS	Option to tune the thread keep alive seconds for the thread pool used in s3 client
TABLE
TIMESTAMP
TRUSTSTORE_BASE64_ENCODED
TRUSTSTORE_PASSWORD
TRUSTSTORE_PATH
TRUSTSTORE_TYPE
TTL
WRITE_MODE

Method Summary

Modifier and Type	Method	Description
static WriterOptions	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static WriterOptions[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.cassandra.spark.bulkwriter.WriterOption

name

Enum Constant Detail

SIDECAR_INSTANCES

@Deprecated
public static final WriterOptions SIDECAR_INSTANCES

Deprecated.

SIDECAR_CONTACT_POINTS

public static final WriterOptions SIDECAR_CONTACT_POINTS

COORDINATED_WRITE_CONFIG

public static final WriterOptions COORDINATED_WRITE_CONFIG

The option specifies the configuration (in JSON) for coordinated write. See org.apache.cassandra.spark.bulkwriter.coordinatedwrite.CoordinatedWriteConf. When the option is present, SIDECAR_CONTACT_POINTS, SIDECAR_INSTANCES and LOCAL_DC are ignored if they are present.

KEYSPACE

public static final WriterOptions KEYSPACE

TABLE

public static final WriterOptions TABLE

BULK_WRITER_CL

public static final WriterOptions BULK_WRITER_CL

LOCAL_DC

public static final WriterOptions LOCAL_DC

NUMBER_SPLITS

public static final WriterOptions NUMBER_SPLITS

COMMIT_THREADS_PER_INSTANCE

public static final WriterOptions COMMIT_THREADS_PER_INSTANCE

COMMIT_BATCH_SIZE

public static final WriterOptions COMMIT_BATCH_SIZE

SKIP_EXTENDED_VERIFY

public static final WriterOptions SKIP_EXTENDED_VERIFY

WRITE_MODE

public static final WriterOptions WRITE_MODE

KEYSTORE_PASSWORD

public static final WriterOptions KEYSTORE_PASSWORD

KEYSTORE_PATH

public static final WriterOptions KEYSTORE_PATH

KEYSTORE_BASE64_ENCODED

public static final WriterOptions KEYSTORE_BASE64_ENCODED

KEYSTORE_TYPE

public static final WriterOptions KEYSTORE_TYPE

CASSANDRA_ROLE

public static final WriterOptions CASSANDRA_ROLE

Option that specifies cassandra role used for role based access control in Sidecar.

Role passed is verified on server side if specified role is present among the roles assigned to user in Cassandra database. Once verified, server uses only the permissions associated with this intended role for authorization checks. If role is not set, sidecar uses all assigned roles for user in database for permission evaluation.

TRUSTSTORE_PASSWORD

public static final WriterOptions TRUSTSTORE_PASSWORD

TRUSTSTORE_TYPE

public static final WriterOptions TRUSTSTORE_TYPE

TRUSTSTORE_PATH

public static final WriterOptions TRUSTSTORE_PATH

TRUSTSTORE_BASE64_ENCODED

public static final WriterOptions TRUSTSTORE_BASE64_ENCODED

SIDECAR_PORT

public static final WriterOptions SIDECAR_PORT

SSTABLE_DATA_SIZE_IN_MB

@Deprecated
public static final WriterOptions SSTABLE_DATA_SIZE_IN_MB

Deprecated.

SSTABLE_DATA_SIZE_IN_MIB

public static final WriterOptions SSTABLE_DATA_SIZE_IN_MIB

TTL

public static final WriterOptions TTL

TIMESTAMP

public static final WriterOptions TIMESTAMP

QUOTE_IDENTIFIERS

public static final WriterOptions QUOTE_IDENTIFIERS

Option that specifies whether the identifiers (i.e. keyspace, table name, column names) should be quoted to support mixed case and reserved keyword names for these fields.

DIGEST

public static final WriterOptions DIGEST

Option that specifies the type of digest to compute when uploading SSTables for checksum validation. If unspecified, it defaults to XXHash32 digests. The legacy MD5 digest is also supported.

DATA_TRANSPORT

public static final WriterOptions DATA_TRANSPORT

Option to specify the data transport mode. It accepts either DataTransport.DIRECT or DataTransport.S3_COMPAT Note that if S3_COMPAT is configured, DATA_TRANSPORT_EXTENSION_CLASS must be configured too.

DATA_TRANSPORT_EXTENSION_CLASS

public static final WriterOptions DATA_TRANSPORT_EXTENSION_CLASS

Option to specify the FQCN of class that implements StorageTransportExtension

STORAGE_CLIENT_CONCURRENCY

public static final WriterOptions STORAGE_CLIENT_CONCURRENCY

Option to tune the concurrency of S3 client's worker thread pool

STORAGE_CLIENT_THREAD_KEEP_ALIVE_SECONDS

public static final WriterOptions STORAGE_CLIENT_THREAD_KEEP_ALIVE_SECONDS

Option to tune the thread keep alive seconds for the thread pool used in s3 client

STORAGE_CLIENT_MAX_CHUNK_SIZE_IN_BYTES

public static final WriterOptions STORAGE_CLIENT_MAX_CHUNK_SIZE_IN_BYTES

Option to specify the max chunk size for the multipart upload to S3

STORAGE_CLIENT_HTTPS_PROXY

public static final WriterOptions STORAGE_CLIENT_HTTPS_PROXY

Option to specify the https proxy for s3 client

STORAGE_CLIENT_ENDPOINT_OVERRIDE

public static final WriterOptions STORAGE_CLIENT_ENDPOINT_OVERRIDE

Option to specify the s3 server endpoint override; it is mostly used for testing

MAX_SIZE_PER_SSTABLE_BUNDLE_IN_BYTES_S3_TRANSPORT

public static final WriterOptions MAX_SIZE_PER_SSTABLE_BUNDLE_IN_BYTES_S3_TRANSPORT

Option to specify the maximum size of bundle (s3 object) to upload to s3

JOB_KEEP_ALIVE_MINUTES

public static final WriterOptions JOB_KEEP_ALIVE_MINUTES

Option to specify the keep alive time in minutes for Sidecar to consider a job has lost/failed after not receiving its heartbeat

JOB_ID

public static final WriterOptions JOB_ID

STORAGE_CLIENT_NIO_HTTP_CLIENT_CONNECTION_ACQUISITION_TIMEOUT_SECONDS

public static final WriterOptions STORAGE_CLIENT_NIO_HTTP_CLIENT_CONNECTION_ACQUISITION_TIMEOUT_SECONDS

Option to tune the connection acquisition timeout for the nio http client employed in s3 client

STORAGE_CLIENT_NIO_HTTP_CLIENT_MAX_CONCURRENCY

public static final WriterOptions STORAGE_CLIENT_NIO_HTTP_CLIENT_MAX_CONCURRENCY

Option to tune the concurrency of the nio http client employed in s3 client

JOB_TIMEOUT_SECONDS

public static final WriterOptions JOB_TIMEOUT_SECONDS

Option to specify the timeout in seconds for bulk write jobs. By default, it is disabled. When JOB_TIMEOUT_SECONDS is specified, a job exceeding the timeout is: - successful when the desired consistency level is met - a failure otherwise

Method Detail

values

public static WriterOptions[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WriterOptions c : WriterOptions.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WriterOptions valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null