A user-defined name for a group of options to configure a KMIP server or servers, key settings, and certificates. For each KMIP key server or group of KMIP key servers, you must configure options for a <kmip_groupname> section. 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 Data Definition Language (DDL) statements and other configurations. DDL statements are database schema change commands like CREATE TABLE. Multiple KMIP hosts are supported.

Default: commented out

A comma-separated list of KMIP hosts (<host>[:<port>]) using the FQDN (Fully Qualified Domain Name). Add KMIP hosts in the intended failover sequence because DSE queries the host in the listed order.

For example, if the host list contains kmip1.yourdomain.com, kmip2.yourdomain.com , DSE tries kmip1.yourdomain.com and then kmip2.yourdomain.com .

The path to a Java keystore created from the KMIP agent PEM files.

Default: /etc/dse/conf/KMIP_keystore.jks

The path to a Java truststore that was created using the KMIP root certificate.

Default: /etc/dse/conf/KMIP_truststore.jks

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

Default: 300000

Socket timeout in milliseconds.

Default: 1000

The maximum size of the shared DSE Search decryption cache in megabytes (MB).

Default: 256

A fraction of the system memory. For example, 0.20 allows use up to 20% of system memory. This setting is ignored if max_memory_to_lock_mb is set to a non-zero value.

Default: 0.20

Maximum amount of memory in megabytes (MB) for DSE In-Memory tables.

not set - Use the fraction specified with max_memory_to_lock_fraction .

number greater than 0 - Maximum amount of memory in megabytes (MB).

Node health options are always enabled. Node health is a score-based representation of how healthy a node is to handle search queries. See Collecting node health and indexing status scores .

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.

The historic time window over which the rate of dropped mutations affects the node health score.

Default: 30

Enables node health as a consideration for replication selection for distributed DSE Search queries. Health-based routing enables a trade-off between index consistency and query throughput.

true - Consider node health when multiple candidates exist for a particular token range.

false - Ignore node health for replication selection. 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 log entries related to lease holders.

true - Enable log entries related to lease holders to help monitor performance of the lease subsystem.

false - No not enable log entries.

The number of seconds to delay the first TTL check to speed up start-up time.

Default: 20

The maximum number of documents to check and delete per batch by the TTL rebuild thread. All expired documents are deleted from the index during each check. To avoid memory pressure, their unique keys are retrieved and then deletes are issued in batches.

Default: 4096

The maximum number of search indexes (cores) that can execute TTL cleanup concurrently. Manages system resource consumption and prevents many search cores from executing simultaneous TTL deletes.

Default: 1

true - The node joins the ring immediately after bootstrap and reindexing occurs asynchronously. Do not wait for post-bootstrap reindexing so that the node is not marked down. The dsetool ring command can be used to check the status of the reindexing.

false - The node joins the ring after reindexing the bootstrapped data.

driver - Respects driver paging settings. Uses Solr pagination (cursors) only when the driver uses pagination. Enabled automatically for DSE SearchAnalytics workloads.

off - Paging is off. Ignore driver paging settings for CQL queries and use normal Solr paging unless:

The current workload is an analytics workload, including SearchAnalytics. SearchAnalytics nodes always use driver paging settings.

The cqlsh query parameter paging is set to driver. Even when cql_solr_query_paging: off , paging is dynamically enabled with the "paging":"driver" parameter in JSON queries .

The maximum time in milliseconds to wait for all rows to be read from the database during CQL Solr queries.

Default: 10000 (10 seconds)

Configures the maximum file size of the search index config or schema. Resource files can be uploaded, but the search index config and schema are stored internally in the database after upload.

0 - Disable resource uploading.

upload size - The maximum upload size limit in megabytes (MB) for a DSE Search resource file (search index config or schema).

Timeout behavior during distributed queries. The internal timeout for all search queries to prevent long running queries. The client request timeout is the maximum cumulative time (in milliseconds) that a distributed search request will wait idly for shard responses.

Default: 60000 (1 minute)

# back_pressure_threshold_per_core: 1024
# flush_max_time_per_core: 5
# load_max_time_per_core: 5
# enable_index_disk_failure_policy: false
# solr_data_dir: /MyDir
# solr_field_cache_enabled: false
# ram_buffer_heap_space_in_mb: 1024
# ram_buffer_offheap_space_in_mb: 1024

The maximum number of queued partitions during search index rebuilding and reindexing. This maximum number safeguards against excessive heap use by the indexing queue. If set lower than the number of threads per core (TPC), not all TPC threads can be actively indexing.

Default: 1024

Always set the wait time high enough to ensure flushing completes successfully to fully sync DSE Search indexes with the database data. If the wait time is exceeded, index updates are only partially committed and the commit log is not truncated which can undermine data durability.

When a timeout occurs, this node is typically overloaded and cannot flush in a timely manner. Live indexing increases the time to flush asynchronous index updates.

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

Default: 5

The directory to store index data. See Managing the location of DSE Search data . By default, each DSE Search index is saved in <solr_data_dir>/<keyspace_name>.<table_name> or as specified by the dse.solr.data.dir system property.

Default: A solr.data directory in the cassandra data directory, like /var/lib/cassandra/solr.data

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 search index schema. Then reload the search index and reindex.

Default: false

Global Lucene RAM buffer usage threshold for heap to force segment flush. Setting too low can cause a state of constant flushing during periods of ongoing write activity. For near-real-time (NRT) indexing, forced segment flushes also de-schedule pending auto-soft commits to avoid potentially flushing too many small segments.

Default: 1024

Global Lucene RAM buffer usage threshold for offheap to force segment flush. Setting too low can cause a state of constant flushing during periods of ongoing write activity. For NRT, forced segment flushes also de-schedule pending auto-soft commits to avoid potentially flushing too many small segments. When not set, the default is 1024.

Default: 1024

Configures the thread pool that is used by most plugins. A dropped task warning is issued when the performance service requests more tasks than performance_max_threads + performance_queue_capacity . When a task is dropped, collected statistics might not be current.

# performance_core_threads: 4
# performance_max_threads: 32
# performance_queue_capacity: 32000

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

Default: 4

Maximum number of background threads used by the performance service.

Default: 32

Allowed number of queued tasks in the backlog when the number of performance_max_threads are busy.

Default: 32000

Performance Service

Configures the collection of performance metrics on transactional nodes. Performance metrics are stored in the dse_perf keyspace and can be queried using any CQL-based utility, such as cqlsh or any application using a CQL driver. To temporarily make changes for diagnostics and testing, use the dsetool perf subcommands.

Configures reporting distributed sub-queries for search (query executions on individual shards) that take longer than a specified period of time.

A value greater than 1 is expressed in time and will log queries that take longer than the specified number of milliseconds. For example, 200.0 sets the threshold at 0.2 seconds.

A value of 0 to 1 is expressed as a percentile and will log queries that exceed this percentile. For example, .95 collects information on 5% of the slowest queries.

The initial number of queries before activating the percentile filter.

Default: commented out ( 100 )

Number of seconds a slow log record survives before it is expired.

Default: 259200

Keeps slow queries only in-memory and does not write data to database.

true - Keep slow queries only in-memory. Skip writing to database.

false - Write slow query information in the node_slow_log table. The threshold must be >= 2000 ms to prevent a high load on the database.

Configures collection of system-wide performance information about a cluster.

Enables collection of system-wide performance information about a cluster.

true - Collect metrics.

false - Do not collect metrics.

The length of the sampling period in milliseconds; the frequency to update the performance statistics.

Default: 10000 (10 seconds)

The length of the sampling period in milliseconds; the frequency to update the performance statistics.

Default: 10000 (10 seconds)

The length of the sampling period in milliseconds; the frequency to update the performance statistics.

Default: 10000 (10 seconds)

The length of the sampling period in milliseconds; the frequency to update the performance statistics.

Default: 10000 (10 seconds)

Configures collection of data associated with Spark cluster and Spark applications.

spark_cluster_info_options:
    enabled: false
    refresh_rate_ms: 10000

The length of the sampling period in milliseconds; the frequency to update the performance statistics.

Default: 10000 (10 seconds)

The length of the sampling period in milliseconds; the frequency to update the performance statistics.

Default: 10000 (10 seconds)

Default: 3

The length of the sampling period in milliseconds; the frequency to update the performance statistics.

Default: 10000 (10 seconds)

The maximum number of individual metrics.

Default: 100

Default: false

The number of seconds a record survives before it is expired.

Default: 604800 (about 10 minutes)

The number of server threads dedicated to writing in the log. More than one server thread might degrade performance.

Default: 1

Default: 3000

The length of the sampling period in milliseconds; the frequency to update the performance statistics.

Default: 10000 (10 seconds)

Collection that configures collection of metrics at the Spark Driver.

Enables collecting Spark Cassandra Connector metrics at the Spark Driver.

true - Collect metrics.

false - Do not collect metrics.

spark_shared_secret_bit_length: 256
spark_security_enabled: false
spark_security_encryption_enabled: false
spark_daemon_readiness_assertion_interval: 1000
resource_manager_options:
   worker_options:
       cores_total: 0.7
       memory_total: 0.6
       workpools:
          - name: alwayson_sql
          cores: 0.25
          memory: 0.25

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

When DSE authentication is enabled with authentication_options , Spark security is enabled regardless of this setting.

Default: false

When DSE authentication is enabled with authentication_options , Spark security encryption is enabled regardless of this setting.

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

Default: 1000

Controls the physical resources used by Spark applications on this node. Optionally add named workpools with specific dedicated resources. See Core management .

Configures the amount of system resources that are made available to the Spark Worker.

Setting cores_total or a workpool’s cores to 1.0 is a decimal value, meaning 100% of the available cores will be reserved. Setting cores_total or cores to 1 (no decimal point) is an explicit value, and one core will be reserved.

absolute value - Use standard suffixes like M for megabyte and G for gigabyte. For example, 12G.

decimal value - Maximum fraction of system memory to give all executors for all applications running on a particular node. For example, 0.8.

When the value is expressed as a decimal, the available resources are calculated in the following way:

Spark Worker memory = memory_total x (total system memory - memory assigned to DataStax Enterprise)

The lowest values that you can assign to Spark Worker memory is 64 MB. If the results are lower, no exception is thrown and the values are automatically limited.

A collection of named workpools that can use a portion of the total resources defined under worker_options .

A default workpool named default is used if no workpools are defined in this section. If workpools are defined, the resources allocated to the workpools are taken from the total amount, with the remaining resources available to the default workpool.

The total amount of resources defined in the workpools section must not exceed the resources available to Spark in worker_options .

The name of the workpool. A workpool named alwayson_sql is created by default for AlwaysOn SQL. By default, the alwayson_sql workpool is configured to use 25% of the resources available to Spark.

Default: alwayson_sql

The number of system cores to use in this workpool expressed as an absolute value or a decimal value. This option follows the same rules as cores_total .

The amount of memory to use in this workpool expressed as either an absolute value or a decimal value. This option follows the same rules as memory_total .

inherit - Inherit the SSL settings from the client_encryption_options in cassandra.yaml .

custom - Use the following encryption_options in dse.yaml .

When encryption: custom , configures encryption for HTTPS of Spark Master and Worker UI.

Enables Spark encryption for Spark client-to-Spark cluster and Spark internode communication.

Default: false

The keystore for Spark encryption keys.

The relative filepath 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: resources/dse/conf/.ui-keystore

The password to access the keystore.

Default: cassandra

Enables custom truststore for client authentication.

true - Require custom truststore for client authentication.

false - Do not require custom truststore.

The filepath to the truststore for Spark encryption keys if require_client_auth: true .

The relative filepath 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: resources/dse/conf/.ui-truststore

The password to access the truststore.

Default: cassandra

The Transport Layer Security (TLS) authentication protocol. The TLS protocol must be supported by JVM and Spark. TLS 1.2 is the most common JVM default.

Default: JVM default

The key manager algorithm.

Default: SunX509

Configures how Spark driver and executor processes are created and managed. See Running Spark processes as separate users .

When runner_type: run_as , Spark applications run as a different OS user than the DSE service user.

The list slot users to separate Spark processes users from the DSE service user.

Default: slot1, slot2

true - Enable AlwaysOn SQL for this node. The node must be an analytics node. Set workpools in Spark resource_manager_options .

false - Do not enable AlwaysOn SQL for this node.

The wait time in milliseconds to reserve the thrift_port if it is not available.

Default: 100

The time in milliseconds to wait for a health check status of the AlwaysOn SQL server.

Default: 500

The named workpool used by AlwaysOn SQL.

Default: alwayson_sql

Location in DSEFS of the AlwaysOn SQL log files.

Default: /spark/log/alwayson_sql

The role to use for internal communication by AlwaysOn SQL if authentication is enabled. Custom roles must be created with login=true .

Default: alwayson_sql

The maximum number of errors that can occur during AlwaysOn SQL service runner thread runs before stopping the service. A service stop requires a manual restart.

Default: 10

The time interval to update heartbeat of AlwaysOn SQL. If heartbeat is not updated for more than three times the interval, AlwaysOn SQL automatically restarts.

Default: 30

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.

Default: /var/lib/dsefs

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 native_transport_address .

Mandatory attribute to identify the set of directories. DataStax recommends segregating these data directories on physical devices that are different from the devices that are used for DataStax Enterprise. Using multiple directories on JBOD improves performance and capacity.

Default: /var/lib/dsefs/data

Weighting factor for this location. Determines 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: 268435456

#     service_startup_timeout_ms: 60000
#     service_close_timeout_ms: 600000
#     server_close_timeout_ms: 2147483647 # Integer.MAX_VALUE
#     compression_frame_max_size: 1048576
#     query_cache_size: 2048
#     query_cache_expire_after_ms: 2000
#     gossip_options:
  #   round_delay_ms: 2000
  #   startup_delay_ms: 5000
  #   shutdown_delay_ms: 10000
# rest_options:
  #   request_timeout_ms: 330000
  #   connection_open_timeout_ms: 55000
  #   client_close_timeout_ms: 60000
  #   server_request_timeout_ms: 300000
  #   idle_connection_timeout_ms: 60000
  #   internode_idle_connection_timeout_ms: 120000
  #   core_max_concurrent_connections_per_host: 8
# transaction_options:
  #   transaction_timeout_ms: 3000
  #   conflict_retry_delay_ms: 200
  #   conflict_retry_count: 40
  #   execution_retry_delay_ms: 1000
  #   execution_retry_count: 3
#     block_allocator_options:
#         overflow_margin_mb: 1024
#         overflow_factor: 1.05

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

Default: 60000

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

Default: 60000

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

Default: 2147483647

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

Configures DSEFS gossip rounds.

The delay in milliseconds between gossip rounds.

Default: 2000

The delay 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

Configures 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 for RestClient to wait before closing an idle connection. If RestClient does not close connection after timeout, the connection is closed after 2 x this wait time.

time - Wait time to close idle connection.

0 - Disable closing idle connections.

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.

Default: 0

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

Default: 8

Configures DSEFS transaction times.

Transaction run time in milliseconds before the transaction is considered for timeout and rollback.

Default: 3000

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

Controls how much additional data can be placed on the local coordinator before the local node overflows to the other nodes. The trade-off is between data locality of writes and balancing the cluster. A local node is preferred for a new block allocation, if:

used_size_on_the_local_node < average_used_size_per_node x overflow_factor + overflow_margin

Directory to store collected metrics.

When data_dir is not explicitly set, the insights_data directory is stored in the same parent directory as the commitlog_directory as defined in cassandra.yaml. If the commitlog_directory uses the package default of /var/lib/cassandra/commitlog, data_dir will default to /var/lib/cassandra/insights_data.

Default: /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.

Default: /var/log/cassandra/

Comma-separated list of keyspaces to exclude. You can also use a regular expression to filter on keyspace name.

Default: exclude no keyspaces

Comma-separated list of the roles for which events are logged.

async - Audit events are queued for writing to the audit table, but are not necessarily logged before the query executes. A pool of writer threads consumes the audit events from the queue, and writes them to the audit table in batch queries.

The maximum number of events the writer dequeues before writing them out to the table. If warnings in the logs reveal that batches are too large, decrease this value or increase the value of batch_size_warn_threshold_in_kb in cassandra.yaml .

Default: 50

Available only when mode: async .

The maximum amount of time in milliseconds before an event is removed from the queue by a writer before being written out. This flush time prevents events from waiting too long before being written to the table when there are not a lot of queries happening.

Default: 500

The size of the queue feeding the asynchronous audit log writer threads.

Number of events - 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.

0 - The queue size is unbounded, which can lead to resource exhaustion under heavy query load.

The directory to store the log file that reports dropped events.

Default: /var/log/cassandra/dropped_audit_events.log

The time interval in milliseconds between changing nodes to spread audit log information across multiple nodes. For example, to change the target node every 12 hours, specify 43200000 milliseconds.

Default: 3600000 (1 hour)

One or more disk configurations for DSE Tiered Storage . Specify multiple disk configurations as unnamed tiers by a collection of paths that are defined in priority order, with the fastest storage media in the top tier. With heterogeneous storage configurations across the cluster, specify each disk configuration with <config_name>:<config_settings>, and then use this configuration in CREATE TABLE or ALTER TABLE statements.

DSE Tiered Storage does not change compaction strategies. To manage compression and compaction options, use the compaction option. See Modifying compression and compaction .

Configures 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 required performance and cost characteristics.

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 configure a storage tier with the paths and filepaths 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 filepaths that define the data directories for this tier of the disk configuration. List the fastest storage media first. These paths are used to store only data that is configured to use tiered storage and are independent of any settings in the cassandra.yaml file.

The filepaths that define the data directories for this tier of the disk configuration.

# advanced_replication_options:
  # enabled: false
  # conf_driver_password_encryption_enabled: false
  # advanced_replication_directory: /var/lib/cassandra/advrep
  # security_base_path: /<base>/<path>/<to>/<advrep>/<security>/<files>/

The directory for storing advanced replication CDC logs. The replication_logs directory will be created in the specified directory.

Default: /var/lib/cassandra/advrep

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/

Configures the internal messaging service used by several components of DataStax Enterprise. All internode messaging requests use this service.

The mandatory port for the internode 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 default is the number of available processors x 8

The maximum number of client connections.

Default: 100

The number of client worker threads.

Default: The default is the number of available processors x 8

Timeout for communication handshake process.

Default: 10

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

Default: 60

Unique generated ID of the physical server in DSE Multi-Instance /etc/<dse-nodeId>/dse.yaml files. 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.

Default: the media access control address (MAC address) of the physical server

The number of worker threads that handle non-blocking read and write (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

This pool represents the workers available to handle blocking operations in Gremlin Server.

0 - the value of the JVM property cassandra.available_processors, if that property is set

positive number - The number of Gremlin threads available to execute actual scripts in a ScriptEngine.

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

The fully qualified class name.

# graph:
    # analytic_evaluation_timeout_in_minutes: 10080
    # realtime_evaluation_timeout_in_seconds: 30
    # schema_agreement_timeout_in_ms: 10000
    # system_evaluation_timeout_in_seconds: 180
    # adjacency_cache_size_in_mb: 128
    # index_cache_size_in_mb: 128
    # max_query_params: 16

System-level configuration options and options that are shared between graph instances. Add an option if it is not present in the provided dse.yaml file.

Option names and values expressed in ISO 8601 format used in earlier DSE 5.0 releases are still valid. The ISO 8601 format is deprecated.

Maximum time to wait for an OLAP analytic (Spark) traversal to evaluate.

Default: 10080 (168 hours)

Maximum time to wait for an OLTP real-time traversal to evaluate.

Default: 30

Maximum time to wait for the database to agree on schema versions before timing out.

Default: 10000

Maximum time to wait for a graph system-based request to execute, like creating a new graph.

Default: 180 (3 minutes)

The amount of ram to allocate to each graph’s adjacency (edge and property) cache.

Default: 128

The amount of ram to allocate to the index cache.

Default: 128

The maximum number of parameters that can be passed on a graph query request for TinkerPop drivers and drivers using the 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: 16

Some graph options in earlier versions of DSE are no longer required. The default settings from the earlier versions of dse.yaml/ are preserved. These advanced settings were removed from dse.yaml , although expert users can manually enter the option to change the default setting.

Generally, the default value is appropriate and does not need adjusting. DataStax recommends contacting the DataStax Services team before changing this value.

graph:
  adjacency_cache_clean_rate: 1024
  adjacency_cache_max_entry_size_in_mb: 0
  adjacency_cache_size_in_mb: 128
  gremlin_server_enabled: true
  index_cache_clean_rate: 1024
  index_cache_max_entry_size_in_mb: 0
  schema_mode: Production
  window_size: 100000

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

Enables Gremlin Server.

true - Enable Gremlin Server.

false - Do not enable Gremlin Server.

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

Default: 1024

Entries that exceed this size are quietly dropped by the cache without producing an explicit error or log message.

0 - Maximum size is based on the cache size and the number of CPUs.

postive integer - The maximum entry size in the index adjacency cache.

Production = Schema must be created before data insertion. Schema cannot be changed after data is inserted. Full graph scans are disallowed unless the option graph.allow_scan is changed to TRUE.

Development = No schema is required to write data to a graph. Schema can be changed after data is inserted. If this option is not present, manually enter it. Full graph scans are allowed unless the option graph.allow_scan is changed to FALSE.

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

Some graph options in earlier versions of DSE are no longer required. The default settings from the earlier versions of dse.yaml are preserved. These advanced settings vertex ID assignment and partitioning strategy options were removed from dse.yaml , although expert users can manually enter the option to change the default setting.

Generally, the default value is appropriate and does not need adjusting. DataStax recommends contacting the DataStax Services team before changing this value.

DSG 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.

DC_LOCAL - The node uses LOCAL_QUORUM when allocating an ID for a graph vertex. The datacenter_id option must be correctly configured on every node in the cluster.

GLOBAL - The node uses QUORUM when allocating an ID for a graph vertex. The datacenter_id option is ignored. This option must have the same value on every node in the cluster and can be changed only when the entire cluster is stopped. This setting has no effect on custom IDs.

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

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.