Fork me on GitHub
Built by Maven

cassandra:cql-exec

Full name:

org.codehaus.mojo:cassandra-maven-plugin:4.0.0:cql-exec

Description:

Executes cql statements from maven.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: pre-integration-test.

Required Parameters

Name Type Since Description
<rpcAddress> String - Address to use for the RPC interface. Do not change this unless you really know what you are doing.
Default: 127.0.0.1

Optional Parameters

Name Type Since Description
<addMainClasspath> boolean - Adds the main classpath to cassandra (for example you could use this when you have a custom comparator on your main classpath.
Default: false
<addTestClasspath> boolean - Adds the test classpath to cassandra (for example you could use this when you have a custom comparator on your test classpath.
Default: false
<cassandraDir> File - The directory to hold cassandra's database.
Default: ${project.build.directory}/cassandra
<comparator> String - Expected type of the column name
User Property: cql.comparator
<cqlEncoding> String 3.6 Charset used when loading CQL files. If not specified the system default encoding will be used.
User Property: cql.encoding
<cqlScript> File - The CQL script which will be executed
Default: ${basedir}/src/cassandra/cql/exec.cql
User Property: cassandra.cql.script
<cqlStatement> String - The CQL statement to execute singularly
User Property: cql.statement
<cqlVersion> String 1.2.1-2 Version of CQL to use
Default: 3.11.12
User Property: cql.version
<defaultValidator> String - Expected type of the column value
User Property: cql.defaultValidator
<jmxPort> int - Port to listen to for the JMX interface.
Default: 7199
User Property: cassandra.jmxPort
<keyspace> String - The keyspace against which individual operations will be executed
User Property: cassandra.keyspace
<keyValidator> String - Expected type of the key
User Property: cql.keyValidator
<listenAddress> String -

Address to bind to and tell other Cassandra nodes to connect to. You must change this if you want multiple nodes to be able to communicate!

Leaving it blank leaves it up to InetAddress.getLocalHost(). This will always do the Right Thing if the node is properly configured (hostname, name resolution, etc), and the Right Thing is to use the address associated with the hostname (it might not be).

Setting this to 0.0.0.0 is always wrong. Do not change this unless you really know what you are doing.
Default: 127.0.0.1
<logLevel> String 3.5 Log level of cassandra process. Logging is performed via log4j2.
Default: ERROR
<maxMemory> int - Number of megabytes to limit the cassandra JVM to.
Default: 512
User Property: cassandra.maxMemory
<nativeTransportPort> int 2.0.0-1 Port on which the CQL native transport listens for clients.
Default: 9042
User Property: cassandra.nativeTransportPort
<skip> boolean - Skip the execution.
Default: false
User Property: cassandra.skip
<startNativeTransport> boolean 2.0.0-1 Enable or disable the native transport server. Currently, only the Thrift server is started by default because the native transport is considered beta.
Default: true
User Property: cassandra.startNativeTransport
<stopKey> String - Key to be provided when stopping cassandra
Default: cassandra-maven-plugin
User Property: cassandra.stopKey
<stopPort> int - Port to listen to for receiving the stop command over
Default: 8081
User Property: cassandra.stopPort
<storagePort> int - Port to listen to for the Storage interface.
Default: 7000
User Property: cassandra.storagePort
<systemPropertyVariables> Map<String,String> 1.2.1-2 List of System properties to pass to the JUnit tests.
<useCqlLexer> boolean 3.7 Should we use the CqlLexer when loading the cql file. This should be better than than the default behaviour which is to just split input on ; since it handles ; in comments and strings. It is not enabled by default since has not been extensively tested.
Default: false
<yaml> String - In yaml format any overrides or additional configuration that you want to apply to the server.

Parameter Details

<addMainClasspath>

Adds the main classpath to cassandra (for example you could use this when you have a custom comparator on your main classpath.
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: false

<addTestClasspath>

Adds the test classpath to cassandra (for example you could use this when you have a custom comparator on your test classpath.
  • Type: boolean
  • Required: report.plugin.goal.no
  • Default: false

<cassandraDir>

The directory to hold cassandra's database.
  • Type: java.io.File
  • Required: report.plugin.goal.no
  • Default: ${project.build.directory}/cassandra

<comparator>

Expected type of the column name
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: cql.comparator

<cqlEncoding>

Charset used when loading CQL files. If not specified the system default encoding will be used.
  • Type: java.lang.String
  • Since: 3.6
  • Required: report.plugin.goal.no
  • User Property: cql.encoding

<cqlScript>

The CQL script which will be executed
  • Type: java.io.File
  • Required: report.plugin.goal.no
  • User Property: cassandra.cql.script
  • Default: ${basedir}/src/cassandra/cql/exec.cql

<cqlStatement>

The CQL statement to execute singularly
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: cql.statement

<cqlVersion>

Version of CQL to use
  • Type: java.lang.String
  • Since: 1.2.1-2
  • Required: report.plugin.goal.no
  • User Property: cql.version
  • Default: 3.11.12

<defaultValidator>

Expected type of the column value
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: cql.defaultValidator

<jmxPort>

Port to listen to for the JMX interface.
  • Type: int
  • Required: report.plugin.goal.no
  • User Property: cassandra.jmxPort
  • Default: 7199

<keyspace>

The keyspace against which individual operations will be executed
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: cassandra.keyspace

<keyValidator>

Expected type of the key
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: cql.keyValidator

<listenAddress>

Address to bind to and tell other Cassandra nodes to connect to. You must change this if you want multiple nodes to be able to communicate!

Leaving it blank leaves it up to InetAddress.getLocalHost(). This will always do the Right Thing if the node is properly configured (hostname, name resolution, etc), and the Right Thing is to use the address associated with the hostname (it might not be).

Setting this to 0.0.0.0 is always wrong. Do not change this unless you really know what you are doing.
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • Default: 127.0.0.1

<logLevel>

Log level of cassandra process. Logging is performed via log4j2.
  • Type: java.lang.String
  • Since: 3.5
  • Required: report.plugin.goal.no
  • Default: ERROR

<maxMemory>

Number of megabytes to limit the cassandra JVM to.
  • Type: int
  • Required: report.plugin.goal.no
  • User Property: cassandra.maxMemory
  • Default: 512

<nativeTransportPort>

Port on which the CQL native transport listens for clients.
  • Type: int
  • Since: 2.0.0-1
  • Required: report.plugin.goal.no
  • User Property: cassandra.nativeTransportPort
  • Default: 9042

<rpcAddress>

Address to use for the RPC interface. Do not change this unless you really know what you are doing.
  • Type: java.lang.String
  • Required: report.plugin.goal.yes
  • Default: 127.0.0.1

<skip>

Skip the execution.
  • Type: boolean
  • Required: report.plugin.goal.no
  • User Property: cassandra.skip
  • Default: false

<startNativeTransport>

Enable or disable the native transport server. Currently, only the Thrift server is started by default because the native transport is considered beta.
  • Type: boolean
  • Since: 2.0.0-1
  • Required: report.plugin.goal.no
  • User Property: cassandra.startNativeTransport
  • Default: true

<stopKey>

Key to be provided when stopping cassandra
  • Type: java.lang.String
  • Required: report.plugin.goal.no
  • User Property: cassandra.stopKey
  • Default: cassandra-maven-plugin

<stopPort>

Port to listen to for receiving the stop command over
  • Type: int
  • Required: report.plugin.goal.no
  • User Property: cassandra.stopPort
  • Default: 8081

<storagePort>

Port to listen to for the Storage interface.
  • Type: int
  • Required: report.plugin.goal.no
  • User Property: cassandra.storagePort
  • Default: 7000

<systemPropertyVariables>

List of System properties to pass to the JUnit tests.
  • Type: java.util.Map<java.lang.String, java.lang.String>
  • Since: 1.2.1-2
  • Required: report.plugin.goal.no

<useCqlLexer>

Should we use the CqlLexer when loading the cql file. This should be better than than the default behaviour which is to just split input on ; since it handles ; in comments and strings. It is not enabled by default since has not been extensively tested.
  • Type: boolean
  • Since: 3.7
  • Required: report.plugin.goal.no
  • Default: false

<yaml>

In yaml format any overrides or additional configuration that you want to apply to the server.
  • Type: java.lang.String
  • Required: report.plugin.goal.no