SSTable Tools
A toolkit for parsing, creating, and analyzing Cassandra 3.x SSTables, including an interactive CQL shell.
What is SSTable Tools?
SSTable Tools is a Java toolkit for parsing, creating, and analyzing Apache Cassandra 3.x SSTable files. It enables direct interaction with Cassandra's low-level storage format, allowing users to run CQL queries, inspect metadata, dump hints, and perform offline compaction without a running database cluster. It solves the problem of needing to debug or manipulate SSTable data outside of the standard Cassandra environment.
Cassandra database administrators and developers who need to inspect, debug, or manipulate SSTable files directly, such as for data recovery, performance analysis, or educational exploration of Cassandra's storage layer.
Developers choose SSTable Tools because it provides a unique, standalone suite of utilities for low-level SSTable interaction that isn't fully covered by native Cassandra tools. Its interactive CQL shell and detailed metadata output offer granular control and visibility for advanced troubleshooting and data exploration.
Overview
Tools for parsing, creating and doing other fun stuff with sstables
Use Cases
Best For
- Debugging data issues in Cassandra SSTables offline
- Performing offline compaction of SSTable files
- Inspecting the contents of Cassandra hint files
- Analyzing SSTable metadata and statistics for performance tuning
- Educational exploration of Cassandra's storage format and internals
- Running CQL queries directly against raw SSTable data for validation
Not Ideal For
- Production environments requiring stable, officially-supported diagnostic tools
- Teams using Apache Cassandra 4.x or later versions
- Users preferring graphical interfaces or automated workflows over command-line interaction
- Simple data recovery tasks without deep knowledge of Cassandra's storage format
Pros & Cons
Pros
Enables running CQL queries and dumping raw data directly from SSTable files without a Cassandra cluster, as demonstrated in the interactive cqlsh shell and DUMP command for inspecting tombstones and TTLs.
Provides a cqlsh-like interface with history, autocomplete, and paging features, making it easy to explore and query SSTable data interactively, as shown in the example usage with SELECT and DUMP commands.
The describe command outputs detailed statistics, histograms, and metadata like partition info, compression ratios, and timestamp ranges, essential for performance tuning and debugging.
Allows merging multiple SSTables into a single file without a running Cassandra instance, useful for maintenance or recovery, as illustrated in the compact command example.
Cons
Only supports Cassandra 3.x SSTable formats (ma, mb, mc), and with the project labeled as a proof-of-concept, it hasn't been updated for newer versions like 4.x, limiting its relevance.
The README explicitly states it's under development and not yet stable, making it risky for critical tasks due to potential bugs or missing features.
Requires users to define or import schema files via CREATE TABLE or SCHEMA commands for effective querying, adding complexity compared to integrated tools that auto-detect schema.
Frequently Asked Questions
Related Projects
ZipkinZipkin is a distributed tracing system
PelotonUnified Resource Scheduler to co-schedule mixed types of workloads such as batch, stateless and stateful jobs in a single cluster for better resource utilization.
Netflix: StaashA language-agnostic as well as storage-agnostic web interface for storing data into persistent storage systems, the metadata layer abstracts a lot of storage details and the pattern automation APIs take care of automating common data access patterns.
JanuesGraph-UtilsDevelop a graph database app using JanusGraph
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.