DataStax Astra is now serverless — get your free Astra database!

Jump to main content

Support
DataStax Home
Downloads

Learn
Drivers
Glossary
Try for free

Getting started with DSE 5.1
Release notes
Installing DSE
Configuration
DSE advanced functionality
Tools
Operations
Studio
CQL

Can't find what you're looking for? Try searching other guides

DSE 5.1 Developer Guide

Getting started with DSE 5.1
Information about developing applications for DataStax Enterprise.
Release notes
DataStax Enterprise release notes cover cluster requirements, upgrade guidance, components, security updates, changes and enhancements, issues, and resolved issues for DataStax Enterprise 5.1.
Installing DSE
DataStax Enterprise can be installed in a number of ways, depending on the purpose of the installation, the type of operating system, and the available permissions.
Configuration
Information about configuring DataStax Enterprise, such as recommended production setting, configuration files, snitch configuration, start-up parameters, heap dump settings, using virtual nodes, and more.
DSE advanced functionality
Information on using DSE Analytics, DSE Search, DSE Graph, DSEFS (DataStax Enterprise file system), and DSE Advance Replication.
Tools
Tools include nodetool, dse commands, dsetool, cfs-stress tool, pre-flight check and yaml_diff tools, and the sstableloader.
- DSE Metrics Collector
  DSE Metrics Collector aggregates DSE metrics and integrates with centralized monitoring solutions to facilitate problem resolution and remediation.
- nodetool
  A list of the available commands for managing a cluster.
- dse commands
  The dse commands for starting the database and connecting an external client to a DataStax Enterprise node and performing common utility tasks.
- dse client-tool
  Connects an external client to a DataStax Enterprise node and performs common utility tasks.
- dsetool
  A list of the available commands for DSE operations.
  - About dsetool
    A command line interface for DSE operations.
  - dsetool connection options
    Options for connecting to your cluster with the dsetool utility.
  - autojt
    This command is deprecated. Job Trackers are managed automatically.
  - checkcfs
    Scans a single Cassandra File System (CFS) file, or the whole CFS, for corrupted files.
  - core_indexing_status
    Retrieves the dynamic indexing status of a search index on a DSE Search node.
  - create_core
    Creates the search index table on the local node.
  - createsystemkey
    Creates an encryption/decryption key for transparent data encryption (TDE).
  - encryptconfigvalue
    Encrypts sensitive configuration information.
  - get_core_config
    Displays the XML for the specified search index config.
  - get_core_schema
    Displays the XML for the pending or sctive search index schema.
  - help
    Provides a listing of dsetool commands and parameters.
  - index_checks
    Optional and experimental. Reads the full index and optionally performs sanity checks. No repairs or fixes occur.
  - infer_solr_schema
    Automatically infers and proposes a schema that is based on the specified keyspace and table. Search indexes are not modified.
  - inmemorystatus
    Provides the memory size, capacity, and percentage for this node and the amount of memory each table is using.
  - insights_config
    Enables and disables DSE Metrics Collector and configures reporting frequency and storage options.
  - insights_filters
    Configures filters to include and exclude specific metrics for DSE Metrics Collector.
  - list_core_properties
    Lists the properties and values in the dse-search.properties resource for the search index.
  - list_index_files
    Lists all index files for a search index on the local node.
  - list_subranges
    Lists the subranges of data in a keyspace to describe a token range by a number of smaller subranges.
  - managekmip list
    Lists encryption/decryption keys on a KMIP server.
  - managekmip expirekey
    Expires encryption/decryption keys on a KMIP server.
  - managekmip revoke
    Permanently disables the key on the KMIP server.
  - managekmip destroy
    Completely removes the key from the KMIP server.
  - node_health
    Retrieves a dynamic score between 0 and 1 that describes the health of a DataStax Enterprise node.
  - partitioner
    Returns the fully qualified classname of the IPartitioner that is in use by the cluster.
  - perf
    Temporarily changes the running parameters for the CQL Performance Service.
  - read_resource
    Reads the specified search index config or schema.
  - rebuild_indexes
    Rebuilds specified secondary indexes for specified keyspace and table.
  - repaircfs
    Repairs the CFS file system from orphan blocks.
  - reload_core
    Reloads the search index to recognize changes to schema or configuration.
  - ring
    Lists the nodes in the ring.
  - set_core_property
    Sets the properties and values in the dse-search.properties resource for the search index.
  - sparkmaster cleanup
    Drops and recreates the Spark Master recovery table.
  - sparkworker restart
    Manually restarts the Spark Worker on the selected node, without restarting the node.
  - status
    Lists the nodes in their ring, including the node type and node health.
  - stop_core_reindex
    Stops reindexing for the specified search index on the node where the command is run. Optionally, specify a timeout in minutes so that the core waits to stop reindexing until the specified timeout is reached, then gracefully stops the indexing. The default timeout is 1 minute.
  - tieredtablestats
    Outputs tiered storage information, including SSTables, tiers, timestamps, and sizes. Provides information on every table that uses tiered storage.
  - tsreload
    Reloads the truststores without a restart.
  - unload_core
    Removes a search index.
  - upgrade_index_files
    Upgrades all DSE Search index files.
  - write_resource
    Uploads the specified search index config or schema.
- Stress tools
  Tools for stress testing DataStax Enterprise.
- SSTable utilities
  Tools for using, upgrading, and changing DataStax Enterprise SSTables.
- Preflight check tool
  The preflight check tool is a collection of tests that detects and optionally fixes configuration settings on DataStax Enterprise nodes.
- cluster_check and yaml_diff tools
  Using the cluster_check and yaml_diff tools to check the differences between cassandra.yaml or dse.yaml files.
Operations
DataStax Enterprise operation topics, such as node and datacenter operations, changing replication strategies, configuring compaction and compression, caching, and tuning Bloom filters.
Studio
An IDE for CQL (Cassandra Query Language) and DSE Graph.
CQL
CQL (Cassandra Query Language) is a query language for the DataStax Enterprise database.

dsetool autojt (deprecated)

This command is deprecated. Job Trackers are managed automatically.

This command is deprecated. Job Trackers are managed automatically.

General Inquiries: +1 (650) 389-6000 info@datastax.com

© DataStax | Privacy policy | Terms of use | Updated: 22 July 2021

Build time: 2021-07-22 08:02:49.664

DataStax, Titan, and TitanDB are registered trademarks of DataStax, Inc. and its subsidiaries in the United States and/or other countries.

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, 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.

dse-dev dsedev51