Module com.github.nosan.embedded.cassandra

Package com.github.nosan.embedded.cassandra

Embedded Cassandra provides an easy way to start and stop Apache Cassandra.

The public API includes the following classes and interfaces:

• Cassandra - An interface that represents a Cassandra instance.
• Version - A class that parses and represents a Cassandra version.
• CassandraBuilder - A builder class used to configure and create a Cassandra instance.
• CqlScript - An interface that loads CQL statements from various sources.
• WorkingDirectoryInitializer - A strategy interface to initialize the working directory.
• WorkingDirectoryDestroyer - A strategy interface to destroy the working directory.
• WorkingDirectoryCustomizer - A customizer interface used to modify the working directory.
• CassandraBuilderConfigurator - A callback interface to configure a CassandraBuilder.

Example:

 Cassandra cassandra = new CassandraBuilder().build();
 cassandra.start();
 try {
     Settings settings = cassandra.getSettings();
     try (Cluster cluster = Cluster.builder().addContactPoints(settings.getAddress())
                                    .withPort(settings.getPort()).build()) {
         Session session = cluster.connect();
         CqlScript.ofClassPath("schema.cql").forEachStatement(session::execute);
     }
 } finally {
     cassandra.stop();
 }
 

Interface Summary

Interface	Description
Cassandra	A simple interface that allows Cassandra to be started and stopped.
CassandraBuilderConfigurator	A callback interface to configure a CassandraBuilder.
CassandraDirectoryProvider	Provides the path to the Cassandra directory based on a specified version.
DefaultWorkingDirectoryInitializer.CopyStrategy	Cassandra file copy strategies.
Settings	Cassandra settings.
WorkingDirectoryCustomizer	A callback interface to customize a working directory.
WorkingDirectoryDestroyer	A strategy interface to destroy the working directory.
WorkingDirectoryInitializer	A strategy interface for initializing the working directory.

Class Summary

Class	Description
CassandraBuilder	A builder that can be used to configure and create Cassandra.
DefaultWorkingDirectoryInitializer	The default implementation of WorkingDirectoryInitializer retrieves the Cassandra directory from the CassandraDirectoryProvider and copies all files from the retrieved directory into the working directory, except for the javadoc, doc, and licenses directories.
SimpleSeedProviderConfigurator	A CassandraBuilderConfigurator implementation that configures the `org.apache.cassandra.locator.SimpleSeedProvider` class.
Version	A representation of a Cassandra version.
WebCassandraDirectoryProvider	An implementation of CassandraDirectoryProvider that downloads and extracts a Cassandra archive from well-known URLs into the specified download directory.

Exception Summary

Exception	Description
CassandraException	An exception thrown by a Cassandra.