org.apache.polygene.entitystore.cassandra

Interface CassandraEntityStoreConfiguration

public interface CassandraEntityStoreConfiguration

Method Summary

Modifier and Type	Method and Description
Property<String>	clusterName() The name of the cluster to connect to.
Property<Boolean>	createIfMissing() Defines whether a KEYSPACE and entity TABLE should be created if not already present in the Cassandra cluster.
Property<String>	entityTableName() The name of the entity TABLE to be used.
Property<String>	hostnames() A comma or space separated list of hostname:port to the Cassandra cluster.
Property<String>	keySpace() The name of the KEYSPACE to be used.
Property<String>	password() Password for connecting the client to the Cassandra cluster.
Property<Integer>	replicationFactor() The replication factor to be used, if a KEYSPACE is created.
Property<String>	username() Username for connecting the client to the Cassandra cluster.

Method Detail

hostnames

@Optional
Property<String> hostnames()

A comma or space separated list of hostname:port to the Cassandra cluster.

A small list of hostnames should be given, as the client is capable to discover the topology by itself and only need one host that it can connect to.

Also not that Cassandra refuse to bind to all interfaces on a host, so you need to know which hostname corresponds to the interface that Cassandra is bound to. This may not include 'localhost'.

Returns:

A comma or space separated list of hostnames (and port) to use to connect to the Cassandra cluster.

clusterName

@Optional
Property<String> clusterName()

The name of the cluster to connect to.

Returns:

The configured cluster name. Default: "polygene-cluster"

replicationFactor

@Optional
Property<Integer> replicationFactor()

The replication factor to be used, if a KEYSPACE is created.

Returns:

The replication factor to use in the keyspace if a keyspace is created. Default: 3

username

@UseDefaults
Property<String> username()

Username for connecting the client to the Cassandra cluster.

The Cassandra client uses the CQL interface.

Returns:

The Username to use to connect to the Cassandra cluster. If empty, then no user name will be attempted.

password

@UseDefaults
Property<String> password()

Password for connecting the client to the Cassandra cluster.

The Cassandra client uses the CQL interface.

Returns:

The password to use to connect to the Cassandra cluster. If empty, then no password will be attempted.

keySpace

@UseDefaults
Property<String> keySpace()

The name of the KEYSPACE to be used.

Returns:

The name of the KEYSPACE to use If null, then the default KEYSPACE polygene will be used.

entityTableName

@UseDefaults
Property<String> entityTableName()

The name of the entity TABLE to be used.

All entities are stored in the same table, with one entity per row. The required table schema is as follows;

     CREATE TABLE entitystore (
         id text,
         version text,
         appversion text,
         storeversion text,
         modified timestamp,
         usecase text,
         props map<text,text>,
         assocs map<text,text>,
         manyassocs map<text,text>,
         namedassocs map<text,text^gt;,
         PRIMARY KEY (id)
 );

 

Returns:

the name of the Entity table. If it returns null the default name of entitystore will be used.

createIfMissing

@UseDefaults
Property<Boolean> createIfMissing()

Defines whether a KEYSPACE and entity TABLE should be created if not already present in the Cassandra cluster.

The default keyspace that could be created is defined as follows;

     CREATE KEYSPACE sensetif WITH replication = {'class':'SimpleStrategy', 'replication_factor' : $replicationFactor };
 

The $replicationFactor refers to the replicationFactor() configuration property above.

Returns:

true if the KEYSPACE and TABLE should be created, false if an Exception should be thrown if it is missing.