dse.yaml configuration file

Options for the DSE Authenticator to authenticate connections. Authenticators other than DSE Authenticator are not supported.

Default: false. Enables user authentication. When false, the DSE Authenticator allows all connections.

Sets the first scheme to validate a user against when the driver does not request a specific scheme.

List of schemes that are also checked if validation against the first scheme fails and no scheme was specified by the driver. Same scheme names as default_scheme.

Only enable (true) when using multiple schemes for authentication. Prevents unintentional role assignment that might occur if user or group names overlap in the authentication service. When true every role requires permissions to a scheme in order to be assigned, see Binding a role to an authentication scheme.

Controls whether DIGEST.adoc5 authentication is also allowed with Kerberos. The DIGEST.adoc5 mechanism is not directly associated with an authentication scheme, but is used by Kerberos to pass credentials between nodes and jobs. In analytics clusters, set to true when using with Spark jobs.

Controls how the DseAuthenticator responds to plain text authentication requests over unencrypted client connections. Set to one of the following values:

For temporary use during authentication setup in an already established environment. Allows access to the database using the anonymous role, which has all permissions except AUTHORIZE.

Options for the DSE Role Manager. To enable role manager, set authorization_options enabled to true and role_manager in cassandra.yaml to com.datastax.bdp.cassandra.auth.DseRoleManager, see Managing roles. When scheme_permissions is enabled, all roles must have permission to execute on the authentication scheme. See Binding a role to an authentication scheme.

Set to one of the following values:

Set to true, to enable logging of DSE role creation and modification events in the dse_security.role_stats system table. All nodes must have the stats option enabled, and must be restarted for the functionality to take effect.

SELECT * FROM dse_security.role_stats;

 role  | created                         | password_changed
-------+---------------------------------+---------------------------------
 user1 | 2020-04-13 00:44:09.221000+0000 |                            null
 user2 | 2020-04-12 23:49:21.457000+0000 | 2020-04-12 23:49:21.457000+0000

(2 rows)

Options for the DSE Authorizer.

Enables the use of DSE Authorizer for role-based access control (RBAC).

Allows the DSE Authorizer to operate in a temporary transitional mode during setup of authorization in a cluster. Set to one of the following values:

Default: false. True enables row-level access control (RLAC) permissions; use the same setting on all nodes.

Configure security for a DataStax Enterprise cluster using Kerberos. See Kerberos guidelines.

The keytab file must contain the credentials for both of the fully resolved principal names, which replace _HOST with the Fully Qualified Domain Name (FQDN) of the host in the service_principal and http_principal settings. The UNIX user running DSE must also have read permissions on the keytab.

The service_principal that the DataStax Enterprise process runs under must use the form dse_user/_HOST@REALM.

The http_principal is used by the Tomcat application container to run DSE Search. The Tomcat web server uses GSS-API mechanism (SPNEGO) to negotiate the GSSAPI security mechanism (Kerberos). Set REALM to the name of your Kerberos realm. In the Kerberos principal, REALM must be uppercase.

A comma-delimited list of Quality of Protection (QOP) values that clients and servers can use for each connection. The client can have multiple QOP values, while the server can have only a single QOP value. The valid values are:

Options to configure LDAP security. See Defining an LDAP scheme.

A comma separated list of LDAP server hosts.

The port on which the LDAP server listens. Default: 389

Enable hostname verification. The following conditions must be met:

Distinguished name (DN) of an account with read access to the user_search_base and group_search_base. Comment out to use an anonymous bind. For example:

The password of the search_dn account.

Set to true to enable SSL connections to the LDAP server. If set to true, change server_port to the SSL port of the LDAP server. Default: false

Set to true to enable TLS connections to the LDAP server. If set to true, change the server_port to the TLS port of the LDAP server. Default: false

The path to the truststore for SSL certificates.

The password to access the trust store.

The type of truststore. Default: jks

The search base for your domain, used to look up users. Set the ou and dc elements for your LDAP domain. Typically this is set to ou=users,dc=domain,dc=top_level_domain. For example, ou=users,dc=example,dc=com.

The search filter for looking up user names. Set the LDAP attribute name of the user identifier equal to {0}. For example AD (Microsoft Active Directory), is typically samAccountName={0}. Default: uid={0}

The attribute on the user entry that contains group membership information. Required when managing roles using group_search_type: memberof_search with LDAP (role_manager.mode:ldap).

Required when managing roles with LDAP (role_manager.mode: ldap). Defines how group membership is looked up for a user. Choose from one of the following values:

The unique distinguished name (DN) of the group record from which to start the group membership search on.

Set to any valid LDAP filter.

The attribute in the group record that contains the LDAP group name. Role names are case sensitive and must match exactly on DSE for assignment. Default: cn

The duration period of the credentials cache.

The duration period in seconds for the search cache. Default: 0

The configuration settings for the connection pool for making LDAP requests.

Controls encryption of sensitive system resources using either a local encryption key or remote KMIP key.

Set to true to enable encryption of system resources that might contain sensitive information, including the system.batchlog and system.paxos tables, hint files, and the database commit log. After enabling system resource encryption in an environment that already has data, encrypt the existing SSTables by running nodetool upgradesstables-a system batchlog paxos

Default: AES. The name of the JCE cipher algorithm used to encrypt system resources.

Default: 128. Length of key to use for the system resources. See Table 1.

Default: 64. Optional. Size of SSTable chunks when data from the system.batchlog or system.paxos are written to disk.

Set to KmipKeyProviderFactory to encrypt sensitive system data with a KMIP key. Comment out this property if using a local encryption key.

Set to the kmip_group_name that defines the KMIP host in kmip_hosts section. DSE requests a key from the KMIP host and uses the key generated by the KMIP provider. Default: none

Path to the directory where local encryption key files are stored, also called system keys. Distribute the system keys to all nodes in the cluster. Ensure that the DSE account is the folder owner and has read/write/execute (700) permissions. Default: /etc/dse/conf

Whether to enable encryption on sensitive data stored in tables and in configuration files.

Default: system_key. The default name is not configurable.

Connection settings for key servers that support the KMIP protocol.

A user-defined name for a group of options to configure a KMIP server or servers, key settings, and certificates. Configure options for a kmip_groupname section for each KMIP key server or group of KMIP key servers. Using separate key server configuration settings allows use of different key servers to encrypt table data, and eliminates the need to enter key server configuration information in DDL statements and other configurations. Multiple KMIP hosts are supported.

A comma-separated list of KMIP hosts using the Fully Qualified Domain Name (FQDN). DSE queries the host in the listed order.

The path to a Java keystore created from the KMIP agent PEM files. For example: /etc/dse/conf/KMIP_keystore.jks

The type of key store. The default value is jks.

The password to access the key store.

The path to a Java truststore created using the KMIP root certificate. For example: /etc/dse/conf/KMIP_truststore.jks

The type of truststore. The default value is jks.

The password to access the truststore.

Milliseconds to locally cache the encryption keys that are read from the KMIP hosts. The longer the encryption keys are cached, the fewer requests are made to the KMIP key server, but the longer it takes for changes, like revocation, to propagate to the DataStax Enterprise node. DataStax Enterprise uses concurrent encryption, so multiple threads fetch the secret key from the KMIP key server at the same time. Default: 300000. DataStax recommends using the default value.

Socket timeout in milliseconds. Default: 1000.

protocol

When not specified, JVM default is used. Examples:

Specify settings to tune encryption of search indexes.

Specify whether to allocate shared DSE Search decryption cache off JVM heap. Default: true

Sets the maximum size of shared DSE Search decryption cache, in megabytes (MB). Default: 256

To use DSE In-Memory, choose one of these options to specify how much system memory to use for all in-memory tables.

Node health options are always enabled for all nodes. Node health is a score-based representation of how fit a node is to handle search queries.

Default: 60000

Default: 10800 (3 hours). The amount of continuous uptime required for the node’s uptime score to advance the node health score from 0 to 1 (full health), assuming there are no recent dropped mutations. The health score is a composite score based on dropped mutations and uptime.

Default: 30. The historic time window over which the rate of dropped mutations affect the node health score.

Default: true. Enable replication selection for distributed DSE Search queries to consider node health when multiple candidates exist for a particular token range. Health-based routing enables a trade-off between index consistency and query throughput. When the primary concern is performance, do not enable health-based routing.

Lease holder statistics help monitor the lease subsystem for automatic management of Job Tracker and Spark Master nodes.

Enables (true) or disables (false) log entries related to lease holders. Most of the time you do not want to enable logging. Default: false

Defines the time, in milliseconds, to persist the log of lease holder changes. Logging of lease holder changes is always on, and has a very low overhead. Default: 604800

To ensure that records with TTLs are purged from search indexes when they expire, the search indexes are periodically checked for expired documents. The ttl_index_rebuild_options settings control the schedulers in charge of querying for and removing expired records, and the execution of the checks.

Schedules how often to check for expired data in seconds. Default: 300

Speeds startup time by delaying the first TTL checks in seconds. Default: 20

Sets the maximum number of documents to check and delete per batch by the TTL rebuild thread. Default: 4096

To manage system resource consumption and prevent many search cores from executing simultaneous TTL deletes, defines the maximum number of cores that can execute TTL cleanup concurrently. Default: 1

For DSE Search, configure whether to asynchronously reindex bootstrapped data. Default: false

Options to specify the paging behavior.

The maximum time in milliseconds to wait for each row to be read from the database during CQL Solr queries. Default: 10000 (10 seconds).

Default: 10. You can configure the maximum resource file size or disable resource upload Sets the maximum DSE Search resource upload size limit in megabytes (MB). Set to 0 to disable resource uploading.

For inter-node communication between DSE Search nodes.

Default: 60000. The client request timeout is the maximum cumulative time (in milliseconds) that a distributed search request waits idly for shard responses. Defines timeout behavior during distributed queries.

Configures the maximum number of concurrent asynchronous indexing threads per DSE Search index. Default: number_of_available_CPU_cores.

Allows back pressure system to adapt max auto soft commit time (defined per search index config) to the actual load. Setting is respected only for NRT (near real time) cores. When DSE search cores have real-time (RT) live indexing, adaptive commits are disabled regardless of this property value. See live indexing with RT.

The total number of queued asynchronous indexing requests per search core. When this number is exceeded, back pressure prevents excessive resource consumption by throttling new incoming requests. DataStax recommends using a back_pressure_threshold_per_core value of 1000 * max_solr_concurrency_per_core.

The maximum time, in minutes, to wait for the flushing of asynchronous index updates, which occurs at DSE Search commit time or at flush time. Expert level knowledge is required to change this value. Always set the value reasonably high to ensure flushing completes successfully to fully sync DSE Search indexes with the database data. If the configured value is exceeded, index updates are only partially committed, and the commit log is not truncated to ensure data durability.

The maximum time, in minutes, to wait for each DSE Search index to load on startup or create/reload operations, expressed. This advanced option should be changed only if exceptions happen during core loading.

DSE Search activates the configured disk failure policy if IOExceptions occur during index update operations.

The directory to store index data. For example:

The Apache Lucene® field cache is deprecated. Instead, for fields that are sorted, faceted, or grouped by, set docValues="true" on the field in the schema.xml file. Then reload the core and reindex. The default value is false. To override false, set useFieldCache=true in the request.

Number of background threads used by the performance service under normal conditions. Default: 4

Maximum number of background threads used by the performance service. Limited to the value of concurrent_writes in the cassandra.yaml file. Default: The number of cassandra.concurrent_writes.

The number of queued tasks in the backlog when the number of performance_max_threads are busy. Default: 32000

Graph event information.

Defines the TTL in milliseconds. Default: 600

Report distributed sub-queries for search (query executions on individual shards) that take longer than a specified period of time. See Collecting slow queries.

Enables (true) or disables (false) log entries for slow queries. Default: true

Defines the threshold (in milliseconds or as a percentile). Default: 200.0

Defines the initial number of queries before activating the percentile filter. Default: 100

Defines the time, in milliseconds, to keep the slow query log entries. Default: 259200

Keeps (true) slow queries in-memory only and does not write data to database. Default: true

The number of slow queries to keep in-memory. Default: 5

CQL system information tables settings See Collecting system level diagnostics.

cql_system_info_options:
    enabled: false
    refresh_rate_ms: 10000

Default: false

Default: 10000

Data resource latency tracking settings. See Collecting system level diagnostics.

resource_level_latency_tracking_options:
    enabled: false
    refresh_rate_ms: 10000

Default: false

Default: 10000

Database summary statistics settings. See Collecting database summary diagnostics.

db_summary_stats_options:
    enabled: false
    refresh_rate_ms: 10000

Default: false

Default: 10000

Cluster summary statistics settings. See Collecting cluster summary diagnostics.

cluster_summary_stats_options:
    enabled: false
    refresh_rate_ms: 10000

Default: false

Default: 10000

See Monitoring Spark with Spark Performance Objects.

spark_cluster_info_options:
    enabled: false
    refresh_rate_ms: 10000

Histogram data tables settings. See Collecting histogram diagnostics.

When true, the dropped mutation metrics are stored in the dropped_messages table in the dse_perf keyspace. Default: false

Default: 10000

Default: 3

User-resource latency tracking settings. See Collecting user activity diagnostics.

Default: false

Default: 10000

Default: 100

Default: false

Enable to collect record errors that occur during document indexing.

Default: false

Default: 604800

Defines the number of server threads dedicated to writing in the log. More than one server thread might degrade performance. Default: 1

See Collecting slow search queries.

Default: false

Default: 604800

Defines the number of server threads dedicated to writing in the log. More than one server thread might degrade performance. Default: 1

Default: 100

See Collecting handler statistics.

Determines whether the object is enabled at startup.

How many seconds a record survives before it is expired from the performance object.

Period (in milliseconds) between sample recordings for periodically updating statistics like the solr_result_cache_stats.

Records core-specific direct and request update handler statistics over time.

Default: false

Default: 604800

Default: 60000

See Collecting index statistics.

Default: false

Default: 604800

Default: 60000

See Collecting cache statistics.

Default: false

Default: 604800

Default: 60000

See Collecting Apache Solr performance statistics.

Default: false

Default: 604800

Default: 60000

Statistics options.

Default: false

Default: 10000 milliseconds

Enables collection of the metrics by the Spark Driver.

Enables writing of the metrics collected from the Spark Driver. Default: false

Enables writing of the Spark Cassandra Connector metrics at the Spark Driver. Default: false

Enables JVM heap and GC metrics at the Spark Driver. Default: false

Enables application state metrics. Default: false

Enables collection of the metrics collected at Spark executors. Default: false

Enables writing of the metrics collected at Spark executors. Default: false

Enables writing of the Spark Cassandra Connector metrics at Spark executors. Default: false

Enables JVM heap and GC metrics at Spark executors. Default: false

DataStax Enterprise can control the memory and cores offered by particular Spark Workers in semi-automatic fashion. Specify the fraction of system resources that are made available to the Spark Worker.

The length of a shared secret used to authenticate Spark components and encrypt the connections between them. This value is not the strength of the cipher for encrypting connections. Default: 256

In DSE 5.1.15 and later, when DSE authentication is enabled with authentication_options, Spark security is enabled regardless of this setting.

In DSE 5.1.15 and later, when DSE authentication is enabled with authentication_options, Spark security is enabled regardless of this setting. Uses DIGEST.adoc5 SASL-based encryption mechanism.

Time interval, in milliseconds, between subsequent retries by the Spark plugin for Spark Master and Worker readiness to start. Default: 1000

Specify the source for SSL settings for Spark Master and Spark Worker UIs. The spark_ui_options apply only to Spark daemon UIs, and do not apply to user applications even when the user applications are run in cluster mode.

Set encryption options for HTTPS of Spark Master and Worker UI. The spark_encryption_options are not valid for DSE 5.1 and later.

Enable (true) or disable (false) Spark encryption for Spark client-to-Spark cluster and Spark internode communication. Default: false

The keystore for Spark encryption keys. The relative file path is the base Spark configuration directory that is defined by the SPARK_CONF_DIR environment variable. The default Spark configuration directory is resources/spark/conf. Default: .keystore

The password to access the key store. Default: cassandra

The truststore for Spark encryption keys. The relative file path is the base Spark configuration directory that is defined by the SPARK_CONF_DIR environment variable. The default Spark configuration directory is resources/spark/conf.

The password to access the truststore. Default: cassandra

Defines the encryption protocol. The TLS protocol must be supported by JVM and Spark.

Defines the key manager algorithm. Default: SunX509

Defines the keystore type. Default: JKS

Defines the cipher suites for Spark encryption. Default:

Define the slot users for separating Spark processes users from the DSE service user. See Running Spark processes as separate users.

DSE File System (DSEFS) options determine whether DSEFS should be enabled on this node.

Enable or disable DSEFS. This parameter takes one of the following values:

The keyspace where the DSEFS metadata is stored. You can optionally configure multiple DSEFS file systems within a single datacenter by specifying different keyspace names for each cluster. Default: dsefs

The local directory for storing the local node metadata, including the node identifier. The volume of data stored in this directory is nominal and does not require configuration for throughput, latency, or capacity. This directory must not be shared by DSEFS nodes.

The public port on which DSEFS listens for clients. DataStax recommends that all nodes in the cluster have the same value. Firewalls must open this port to trusted clients. The service on this port is bound to the RPC address. Default: 5598

The private port for DSEFS inter-node communication. Do not open this port to firewalls; this private port must be not visible from outside of the cluster. Default: 5599

One or more data locations where the DSEFS data is stored.

Mandatory attribute to identify the set of directories. DataStax recommends segregating these data directories on physical devices different than the devices that are used for DataStax Enterprise. Using multiple directories on JBOD improves performance and capacity. Default: /var/lib/dsefs/data

The weighting factor for this location specifies how much data to place in this directory, relative to other directories in the cluster. This soft constraint determines how DSEFS distributes the data. For example, a directory with a value of 3.0 receives about three times more data than a directory with a value of 1.0. Default: 1.0

The reserved space, in bytes, to not use for storing file data blocks. You can use a unit of measure suffix to specify other size units. For example: terabyte (1 TB), gigabyte (10 GB), and megabyte (5000 MB). Default: 5368709120

Wait time, in milliseconds, before the DSEFS server times out while waiting for services to bootstrap. Default: 30000

Wait time, in milliseconds, before the DSEFS server times out while waiting for services to close. Default: 600000

Wait time, in milliseconds, that the DSEFS server waits during shutdown before closing all pending connections.

The maximum accepted size of a compression frame defined during file upload. Default: 1048576

Maximum number of elements in a single DSEFS Server query cache. Default: 2048

The time to retain the DSEFS Server query cache element in cache. The cache element expires when this time is exceeded. Default: 2000

Options to configure DSEFS gossip rounds.

The delay, in milliseconds, between gossip rounds. Default: 5000

The delay time, in milliseconds, between registering the location and reading back all other locations from the database. Default: 5000

The delay time, in milliseconds, between announcing shutdown and shutting down the node. Default: 30000

Options to configure DSEFS rest times.

The time, in milliseconds, that the client waits for a response that corresponds to a given request. Default: 330000

The time, in milliseconds, that the client waits to establish a new connection. Default: 55000

The time, in milliseconds, that the client waits for pending transfer to complete before closing a connection. Default: 60000

The time, in milliseconds, to wait for the server rest call to complete. Default: 300000

The time, in milliseconds, to wait before closing an idle connection. Closing idle connections is disabled by default. Default: 0 (disabled)

Wait time, in milliseconds, before closing idle internode connection. The internode connections are primarily used to exchange data during replication. Do not set lower than the default value for heavily utilized DSEFS clusters.

Maximum number of connections to a given host per single CPU core. DSEFS keeps a connection pool for each CPU core.

Wait time, in milliseconds, before retrying a transaction that was ended due to a conflict. Default: 200

The number of times to retry a transaction before giving up. Default: 40

Wait time, in milliseconds, before retrying a failed transaction payload execution. Default: 1000

The number of payload execution retries before signaling the error to the application. Default: 3

Options for DSE Metrics Collector.

Directory to store collected metrics. When not set, the default directory is /var/lib/cassandra/insights_data.

Directory to store logs for collected metrics. The log file is dse-collectd.log. The file with the collectd PID is dse-collectd.pid. When not set, the default directory is /var/log/cassandra/.

To get the maximum information from data auditing, turn on data auditing on every node. See Enabling data auditing in DataStax Enterprise and Configuring audit logging.

Default: false

Default: SLF4JAuditWriterfalse

The default is to include all categories. Specify either included or excluded categories.

The default is to include all keyspaces. Specify either included or excluded keyspaces. Specifying both is an error.

The amount of time, in hours, that audit events are retained by supporting loggers. Only CassandraAuditWriter supports retention time. Values of 0 or less retain events forever. Default: 0

Configuration options for CassandraAuditWriter.

cassandra_audit_writer_options:
    mode: sync
    batch_size: 50
    flush_time: 500
    num_writers: 10
    queue_size: 10000
    write_consistency: QUORUM
    # dropped_event_log: /var/log/cassandra/dropped_audit_events.log
    # day_partition_millis: 3600000

Sets the mode the writer runs in. Default: sync

Available only when mode: async.

Available only when mode: async.

Available only when mode: async.

The size of the queue feeding the asynchronous audit log writer threads. When there are more events being produced than the writers can write out, the queue fills up, and newer queries are blocked until there is space on the queue. If a value of 0 is used, the queue size is unbounded, which can lead to resource exhaustion under heavy query load. Default: 10000

The consistency level that is used to write audit events. Default: QUORUM

The directory to store the log file that reports dropped events. Default: /var/log/cassandra/dropped_audit_events.log

To spread audit log information across multiple nodes, specify the interval, in milliseconds, between changing nodes. For example, specify 43200000 milliseconds to change the target node every 12 hours. Default: 3600000 (1 hour)

Options to configure the smart movement of data across different types of storage media so that data is matched to the most suitable drive type, according to the performance and cost characteristics it requires

The first disk configuration strategy. Create a strategy2, strategy3, and so on. In this example, strategy1 is the configurable name of the tiered storage configuration strategy.

The unnamed tiers in this section define a storage tier with the paths and file paths that define the priority order.

Local configuration options overwrite the tiered storage settings for the table schema in the local dse.yaml file. See Testing DSE Tiered Storage configurations.

The section of file paths that define the data directories for this tier of the disk configuration. Typically list the fastest storage media first. These paths are used only to store data that is configured to use tiered storage. These paths are independent of any settings in the cassandra.yaml file.

Specific file paths to define the data directories for this tier of the disk configuration.

Options to enable DSE Advanced Replication.

Set enabled:true on an edge node to collect data in the replication log. Default: false.

Enable or disable encryption of driver passwords. When enabled, the stored driver password is expected to be encrypted with the system key. After you create the system key, you must copy the same system key to every node in the cluster.

Set the directory for storing advanced replication CDC logs. Default is /var/lib/cassandra/advrep. A directory replication_logs will be created within the specified directory.

The base path to prepend to paths in the Advanced Replication configuration locations, including locations to SSL keystore, SSL truststore, and so on. Default: /base/path/to/advrep/security/files/

Configuration options for inter-node messaging.

The mandatory port for the inter-node messaging service. Default: 8609

Maximum message frame length. Default: 256

The number of server acceptor threads. Default: the number of available processors.

The number of server worker threads. Default: the number of available processors * 8.

The maximum number of client connections. Default: 100

The number of client worker threads. Default: the number of available processors * 8.

Timeout for communication handshake process. Default: 10

Timeout for non-query search requests like core creation and distributed deletes. Default: 60

In DSE Multi-Instance /etc/dse-nodeId/dse.yaml files, the server_id option is generated to uniquely identify the physical server on which multiple instances are running. The server_id default value is the media access control address (MAC address) of the physical server. You can change server_id when the MAC address is not unique, such as a virtualized server where the host’s physical MAC is cloned.

These graph options are system-level configuration options and options that are shared between graph instances.

The number of stale rows per second to clean from each graph’s adjacency cache. Default: 1024.

The maximum entry size in each graph’s adjacency cache. When set to zero, the default is calculated based on the cache size and the number of CPUs. Entries that exceed this size are quietly dropped by the cache without producing an explicit error or log message. Default: 0.

The amount of RAM to allocate to each graph’s adjacency (edge and property) cache. Default: 128.

Maximum time to wait for an analytic (Spark) traversal to evaluate. Default: 10080 (7 days).

Enables or disables Gremlin Server. Default: true.

The number of stale entries per second to clean from the adjacency cache. Default: 1024.

The maximum entry size in the index adjacency cache. When set to zero, the default is based on the cache size and the number of CPUs. Value: integer. + # default is calculated based on the cache size and the number of CPUs. Entries that exceed this size are quietly dropped by the cache without producing an explicit error or log message. Default: 0.

The amount of ram to allocate to the index cache. Default: 128.

The maximum number of CQL queries that can be queued as a result of Gremlin requests. Incoming queries are rejected if the queue size exceeds this setting. Default: 10000.

The maximum number of threads to use for queries to the database. When this option is not set, the default is:

Maximum time to wait for a real-time traversal to evaluate. Default: 30 seconds.

Maximum time to wait for cassandra to agree on schema versions before timing out. Default: 10000

Controls the way that the schemas are handled. Valid values:

Maximum time to wait for a system-based request to execute. Default: 180 (3 minutes).

The number of samples to keep when aggregating log events. Only a small subset of graph’s log events use this system. Modifying this setting is rarely necessary or helpful. Default: 100000.

The maximum number of parameters that can be passed on a graph query request for TinkerPop drivers and drivers using Cassandra native protocol. Passing very large numbers of parameters on requests is an anti-pattern, because the script evaluation time increases proportionally. DataStax recommends reducing the number of parameters to speed up script compilation times. Before you increase this value, consider alternate methods for parameterizing scripts, like passing a single map. If the graph query request requires many arguments, pass a list. Default: 256

DSE Graph configuration options for standard vertex ID assignment and partitioning strategies.

The graph standard vertex ID allocator operates on blocks of contiguous IDs. Each block is allocated using a database lightweight transaction that requires coordination latency. To hide the cost of allocating a standard ID block, the allocator begins asynchronously buffering a replacement block whenever a current block is nearly empty. This block_renew parameter defines "nearly empty" as a floating point number between 0 and 1. The value is how much of a standard ID block can be used before graph starts asynchronously allocating its replacement. This setting has no effect on custom IDs. Value must be between 0 and 1. Default: 0.8.

For graphs using standard vertex IDs, if a transaction creates multiple vertices, the allocator attempts to assign vertex IDs that colocate vertices on the same database replicas. If an especially large vertex cohort is created, the allocator chunks the vertex creation and assigns a random target location to avoid load hotspotting. This setting controls the vertex chunk size and has no effect on custom IDs. Default: 28.

Must be set to DC_LOCAL or GLOBAL.

Applies only when consistency_mode is DC_LOCAL. Set to an arbitrary value between 1 and 127, inclusive. This setting has no effect on custom IDs.

An integer between 1 and 2^24 (both inclusive) that affects maximum ID capacity and the maximum storage space used by ID allocations. Lower values reduce the storage space consumed and the lightweight transaction overhead imposed at startup. Lower values also reduce the total number of IDs that can be allocated over the life of a graph, because this parameter is proportional to the allocatable ID space. However, the proportion coefficient is Long.MAX_VALUE (2^63-1), so ID headroom should be sufficient, practically speaking, even if this is set to 1. This setting has no effect on custom IDs. Default: 20.

The graph standard vertex ID allocator claims uniformly-sized blocks of contiguous IDs using lightweight transactions on the database. This setting controls the size of each block. This setting has no effect on custom IDs. Default: 512.

Options that contain all registered state listeners identified by their name.

Replace listener_name with a string that identifies the listener. The string must begin with a lower case letter and can be composed of lowercase letters, numbers, and underscores.

The names of state types that are ignored. All state types but those given are listened to. Default: (empty).

The interval in which the state values are logged. Default: 3600

The type of the state listener. Must be one of the following values: slf4j. Default: slf4j.

The names of state types that should be listened. Only those state types are listened to and all others ignored. Default: (empty).

Options to configure DSE Graph internal query and lightweight messaging system.

Graph messages must be acknowledged within this interval, or else the message is assumed dropped/failed. Graph retries the message or fails the responsible request if the retry limit is exceeded. Default: 5000

Options to configure all registered event observers identified by their name.

Replace observer_name with a string that identifies the event observers. This string is the names of event types that are ignored. All event types but those given are observed. The string must begin with a lower case letter and can be composed of lowercase letters, numbers, and underscores. Value: YAML-formatted list of strings.

The names of event types that are ignored. All event types but those given are observed. Value: YAML-formatted list of strings. Default: (empty).

The names of the graphs for which events are observed. Value: YAML-formatted list of strings. Default: (empty).

The names of the graphs for which slow transactions are monitored. Default: (empty).

Threshold at which slow queries get reported. Default: 300000

The type of the event observer. Must be one of the following values: slf4j, slow_request. Default: slf4j.

The names of event types that should be observed. Only those event types are observed and all others ignored. Value: YAML-formatted list of strings. Default: (empty).

Options for shared data in DSE Graph.

The interval between refreshes in which the graph schema is reread from the database tables. Note that schema is also immediately updated when schema changes occur, so this parameter is a fail safe to poll for schema changes periodically. Default: 60000

The top-level configurations in Gremlin Server.

The port value identifies the available communications port for Gremlin Server. Default: 8182

The number of worker threads that handle requests and responses on the Gremlin Server channel, including routing requests to the right server operations, handling scheduled jobs on the server, and writing serialized responses back to the client. Default: 2

The number of Gremlin threads available to execute actual scripts in a ScriptEngine. This pool represents the workers available to handle blocking operations in Gremlin Server. Default: 8

Section to configure gremlin server scripts.

Section for gremlin-groovy scripts.

Sandbox is enabled by default. To disable the gremlin groovy sandbox entirely, set to false.

Section for sandbox rules.

List of packages, one package per line, to whitelist.

Retain the hyphen before the fully qualified package name.

List of types, one type per line, to whitelist.

Retain the hyphen before the fully qualified type name.

List of super classes, one class per line, to whitelist. Retain the hyphen before the fully qualified class name.

Retain the hyphen before the fully qualified class name.

List of packages, one package per line, to blacklist.

Retain the hyphen before the fully qualified package name.

List of super classes, one class per line, to blacklist. Retain the hyphen before the fully qualified class name.

Retain the hyphen before the fully qualified class name.