Fork me on GitHub
Built by Maven

Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal Description
cassandra:cleanup Runs nodetool cleanup on a Cassandra instance.
cassandra:compact Runs nodetool compact on a Cassandra instance.
cassandra:cql-exec Executes cql statements from maven.
cassandra:delete Deletes the Cassandra home directory that we create for running Cassandra.
cassandra:drop Drop the specified ColumnFamilies or, if no arguments are given, the specified Keyspace
cassandra:flush Runs nodetool flush on a Cassandra instance.
cassandra:help Display help information on cassandra-maven-plugin.
Call mvn cassandra:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
cassandra:load Loads a Cassandra CQL script into a Cassandra instance.
cassandra:repair Runs nodetool repair on a Cassandra instance.
cassandra:run Runs Cassandra in the foreground.
cassandra:start Starts a Cassandra instance in the background.
cassandra:start-cluster Starts a Cassandra instance in the background.
cassandra:stop Stops a background Cassandra instance.
cassandra:stop-cluster Stops a background Cassandra instance.
cassandra:truncate Executes the truncate command against the specified keyspace. Currently doing so via StorageProxy as a discussion point.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.6.3
JDK 1.8

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version Maven JDK
from 4.0.0 to 4.1.10.0 3.6.3 8
3.8 3.5.4 8
3.7 2.2.1 8
from 2.1.7-1 to 3.6 2.2.1 7
from 0.7.0-1 to 2.0.0-1 2.2.1 6

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.codehaus.mojo</groupId>
          <artifactId>cassandra-maven-plugin</artifactId>
          <version>4.1.10.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>cassandra-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"