public interface

Cluster

com.netflix.astyanax.Cluster
Known Indirect Subclasses

Class Overview

Interface for cluster operations. Use the Keyspace interface to perform keyspace query and mutation operations.

Summary

Public Methods
abstract String addColumnFamily(ColumnFamilyDefinition def)
Add a column family to an existing keyspace@return
abstract String addKeyspace(KeyspaceDefinition def)
Add a new keyspace to the cluster.
abstract String describeClusterName()
The cluster name is completely arbitrary@return
abstract KeyspaceDefinition describeKeyspace(String ksName)
Describe a single keyspace@return
abstract List<KeyspaceDefinition> describeKeyspaces()
Return details about all keyspaces in the cluster@return
abstract String describePartitioner()
Describe the partitioner used by the cluster@return
abstract Map<String, List<String>> describeSchemaVersions()
abstract String describeSnitch()
Describe the snitch name used on the cluster@return
abstract String dropColumnFamily(String keyspaceName, String columnFamilyName)
Delete the column family from the keyspace@return
abstract String dropKeyspace(String keyspaceName)
Delete a keyspace from the cluster@return
abstract AstyanaxConfiguration getConfig()
Configuration object for this Cluster
abstract Keyspace getKeyspace(String keyspace)
Return a keyspace client.
abstract String getVersion()
Return version of cassandra running on the cluster@return
abstract ColumnDefinition makeColumnDefinition()
Make a column definitio to be added to a ColumnFamilyDefinition
abstract ColumnFamilyDefinition makeColumnFamilyDefinition()
Prepare a column family definition.
abstract KeyspaceDefinition makeKeyspaceDefinition()
Prepare a keyspace definition.
abstract String updateColumnFamily(ColumnFamilyDefinition def)
Update an existing column family@return
abstract String updateKeyspace(KeyspaceDefinition def)
Update a new keyspace in the cluster.

Public Methods

public abstract String addColumnFamily (ColumnFamilyDefinition def)

Add a column family to an existing keyspace@return

Parameters
def - Created by calling prepareColumnFamilyDefinition();
Throws
ConnectionException

public abstract String addKeyspace (KeyspaceDefinition def)

Add a new keyspace to the cluster. The keyspace object may include column families as well. Create a KeyspaceDefinition object by calling prepareKeyspaceDefinition().

Throws
ConnectionException

public abstract String describeClusterName ()

The cluster name is completely arbitrary@return

Throws
ConnectionException

public abstract KeyspaceDefinition describeKeyspace (String ksName)

Describe a single keyspace@return

Throws
ConnectionException

public abstract List<KeyspaceDefinition> describeKeyspaces ()

Return details about all keyspaces in the cluster@return

Throws
ConnectionException

public abstract String describePartitioner ()

Describe the partitioner used by the cluster@return

Throws
ConnectionException

public abstract Map<String, List<String>> describeSchemaVersions ()

Throws
ConnectionException

public abstract String describeSnitch ()

Describe the snitch name used on the cluster@return

Throws
ConnectionException

public abstract String dropColumnFamily (String keyspaceName, String columnFamilyName)

Delete the column family from the keyspace@return

Throws
OperationException
ConnectionException

public abstract String dropKeyspace (String keyspaceName)

Delete a keyspace from the cluster@return

Throws
OperationException
ConnectionException

public abstract AstyanaxConfiguration getConfig ()

Configuration object for this Cluster

public abstract Keyspace getKeyspace (String keyspace)

Return a keyspace client. Note that this keyspace will use the same connection pool as the cluster and any other keyspaces created from this cluster instance. As a result each keyspace operation is likely to have some overhead for switching keyspaces.

public abstract String getVersion ()

Return version of cassandra running on the cluster@return

Throws
ConnectionException

public abstract ColumnDefinition makeColumnDefinition ()

Make a column definitio to be added to a ColumnFamilyDefinition

public abstract ColumnFamilyDefinition makeColumnFamilyDefinition ()

Prepare a column family definition. Call execute() on the returned object to create the column family.

public abstract KeyspaceDefinition makeKeyspaceDefinition ()

Prepare a keyspace definition. Call execute() on the returned object to create the keyspace. Not that column families can be added the keyspace definition here instead of calling prepareColumnFamilyDefinition separately.

public abstract String updateColumnFamily (ColumnFamilyDefinition def)

Update an existing column family@return

Parameters
def - Created by calling prepareColumnFamilyDefinition();
Throws
ConnectionException

public abstract String updateKeyspace (KeyspaceDefinition def)

Update a new keyspace in the cluster. The keyspace object may include column families as well. Create a KeyspaceDefinition object by calling prepareKeyspaceDefinition().

Throws
ConnectionException