Package com.palantir.atlasdb.keyvalue.cassandra

Interface CassandraClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CassandraClientImpl, InstrumentedCassandraClient, ProfilingCassandraClient, QosCassandraClient, TracingCassandraClient

public interface CassandraClient
extends Closeable

Method Summary

Modifier and Type	Method	Description
void	batch_mutate(String kvsMethodName, Map<ByteBuffer,Map<String,List<org.apache.cassandra.thrift.Mutation>>> mutation_map, org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
org.apache.cassandra.thrift.CASResult	cas(com.palantir.atlasdb.keyvalue.api.TableReference tableReference, ByteBuffer key, List<org.apache.cassandra.thrift.Column> expected, List<org.apache.cassandra.thrift.Column> updates, org.apache.cassandra.thrift.ConsistencyLevel serial_consistency_level, org.apache.cassandra.thrift.ConsistencyLevel commit_consistency_level)
void	close()
org.apache.cassandra.thrift.KsDef	describe_keyspace(String keyspace)
List<org.apache.cassandra.thrift.KsDef>	describe_keyspaces()
String	describe_partitioner()
List<org.apache.cassandra.thrift.TokenRange>	describe_ring(String keyspace)
Map<String,List<String>>	describe_schema_versions()
String	describe_snitch()
String	describe_version()
org.apache.cassandra.thrift.CqlResult	execute_cql3_query(CqlQuery cqlQuery, org.apache.cassandra.thrift.Compression compression, org.apache.cassandra.thrift.ConsistencyLevel consistency)
org.apache.cassandra.thrift.CqlResult	execute_prepared_cql3_query(int intemId, List<ByteBuffer> values, org.apache.cassandra.thrift.ConsistencyLevel consistency)
org.apache.cassandra.thrift.ColumnOrSuperColumn	get(com.palantir.atlasdb.keyvalue.api.TableReference tableReference, ByteBuffer key, byte[] column, org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
List<String>	get_host_ids()
List<org.apache.cassandra.thrift.KeySlice>	get_range_slices(String kvsMethodName, com.palantir.atlasdb.keyvalue.api.TableReference tableRef, org.apache.cassandra.thrift.SlicePredicate predicate, org.apache.cassandra.thrift.KeyRange range, org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
org.apache.thrift.protocol.TProtocol	getInputProtocol()
org.apache.thrift.protocol.TProtocol	getOutputProtocol()
boolean	isValid()	Checks if the client has a valid connection to Cassandra cluster.
Map<ByteBuffer,List<List<org.apache.cassandra.thrift.ColumnOrSuperColumn>>>	multiget_multislice(String kvsMethodName, com.palantir.atlasdb.keyvalue.api.TableReference tableRef, List<org.apache.cassandra.thrift.KeyPredicate> keyPredicates, org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
Map<ByteBuffer,List<org.apache.cassandra.thrift.ColumnOrSuperColumn>>	multiget_slice(String kvsMethodName, com.palantir.atlasdb.keyvalue.api.TableReference tableRef, List<ByteBuffer> keys, org.apache.cassandra.thrift.SlicePredicate predicate, org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
org.apache.cassandra.thrift.CqlPreparedResult	prepare_cql3_query(ByteBuffer query, org.apache.cassandra.thrift.Compression compression)
org.apache.cassandra.thrift.CASResult	put_unless_exists(com.palantir.atlasdb.keyvalue.api.TableReference tableReference, ByteBuffer key, List<org.apache.cassandra.thrift.Column> updates, org.apache.cassandra.thrift.ConsistencyLevel serial_consistency_level, org.apache.cassandra.thrift.ConsistencyLevel commit_consistency_level)
void	remove(String kvsMethodName, com.palantir.atlasdb.keyvalue.api.TableReference tableRef, byte[] row, long timestamp, org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
String	system_add_keyspace(org.apache.cassandra.thrift.KsDef ks_def)
String	system_drop_column_family(String column_family)
String	system_update_column_family(org.apache.cassandra.thrift.CfDef cf_def)
String	system_update_keyspace(org.apache.cassandra.thrift.KsDef ks_def)
ByteBuffer	trace_next_query()
void	truncate(String cfname)

Method Detail

isValid

boolean isValid()

Checks if the client has a valid connection to Cassandra cluster. Can be used by a client pool to eliminate clients in bad state.

Returns:

true if client is in good state.

describe_snitch

String describe_snitch()
                throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

multiget_slice

Map<ByteBuffer,List<org.apache.cassandra.thrift.ColumnOrSuperColumn>> multiget_slice(String kvsMethodName,
                                                                                           com.palantir.atlasdb.keyvalue.api.TableReference tableRef,
                                                                                           List<ByteBuffer> keys,
                                                                                           org.apache.cassandra.thrift.SlicePredicate predicate,
                                                                                           org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
                                                                                    throws org.apache.cassandra.thrift.InvalidRequestException,
                                                                                           org.apache.cassandra.thrift.UnavailableException,
                                                                                           org.apache.cassandra.thrift.TimedOutException,
                                                                                           org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.UnavailableException

org.apache.cassandra.thrift.TimedOutException

org.apache.thrift.TException

multiget_multislice

Map<ByteBuffer,List<List<org.apache.cassandra.thrift.ColumnOrSuperColumn>>> multiget_multislice(String kvsMethodName,
                                                                                                      com.palantir.atlasdb.keyvalue.api.TableReference tableRef,
                                                                                                      List<org.apache.cassandra.thrift.KeyPredicate> keyPredicates,
                                                                                                      org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
                                                                                               throws org.apache.cassandra.thrift.InvalidRequestException,
                                                                                                      org.apache.cassandra.thrift.UnavailableException,
                                                                                                      org.apache.cassandra.thrift.TimedOutException,
                                                                                                      org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.UnavailableException

org.apache.cassandra.thrift.TimedOutException

org.apache.thrift.TException

get_range_slices

List<org.apache.cassandra.thrift.KeySlice> get_range_slices(String kvsMethodName,
                                                            com.palantir.atlasdb.keyvalue.api.TableReference tableRef,
                                                            org.apache.cassandra.thrift.SlicePredicate predicate,
                                                            org.apache.cassandra.thrift.KeyRange range,
                                                            org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
                                                     throws org.apache.cassandra.thrift.InvalidRequestException,
                                                            org.apache.cassandra.thrift.UnavailableException,
                                                            org.apache.cassandra.thrift.TimedOutException,
                                                            org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.UnavailableException

org.apache.cassandra.thrift.TimedOutException

org.apache.thrift.TException

batch_mutate

void batch_mutate(String kvsMethodName,
                  Map<ByteBuffer,Map<String,List<org.apache.cassandra.thrift.Mutation>>> mutation_map,
                  org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
           throws org.apache.cassandra.thrift.InvalidRequestException,
                  org.apache.cassandra.thrift.UnavailableException,
                  org.apache.cassandra.thrift.TimedOutException,
                  org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.UnavailableException

org.apache.cassandra.thrift.TimedOutException

org.apache.thrift.TException

get

org.apache.cassandra.thrift.ColumnOrSuperColumn get(com.palantir.atlasdb.keyvalue.api.TableReference tableReference,
                                                    ByteBuffer key,
                                                    byte[] column,
                                                    org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
                                             throws org.apache.cassandra.thrift.InvalidRequestException,
                                                    org.apache.cassandra.thrift.NotFoundException,
                                                    org.apache.cassandra.thrift.UnavailableException,
                                                    org.apache.cassandra.thrift.TimedOutException,
                                                    org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.NotFoundException

org.apache.cassandra.thrift.UnavailableException

org.apache.cassandra.thrift.TimedOutException

org.apache.thrift.TException

cas

org.apache.cassandra.thrift.CASResult cas(com.palantir.atlasdb.keyvalue.api.TableReference tableReference,
                                          ByteBuffer key,
                                          List<org.apache.cassandra.thrift.Column> expected,
                                          List<org.apache.cassandra.thrift.Column> updates,
                                          org.apache.cassandra.thrift.ConsistencyLevel serial_consistency_level,
                                          org.apache.cassandra.thrift.ConsistencyLevel commit_consistency_level)
                                   throws org.apache.cassandra.thrift.InvalidRequestException,
                                          org.apache.cassandra.thrift.UnavailableException,
                                          org.apache.cassandra.thrift.TimedOutException,
                                          org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.UnavailableException

org.apache.cassandra.thrift.TimedOutException

org.apache.thrift.TException

put_unless_exists

org.apache.cassandra.thrift.CASResult put_unless_exists(com.palantir.atlasdb.keyvalue.api.TableReference tableReference,
                                                        ByteBuffer key,
                                                        List<org.apache.cassandra.thrift.Column> updates,
                                                        org.apache.cassandra.thrift.ConsistencyLevel serial_consistency_level,
                                                        org.apache.cassandra.thrift.ConsistencyLevel commit_consistency_level)
                                                 throws org.apache.cassandra.thrift.InvalidRequestException,
                                                        org.apache.cassandra.thrift.UnavailableException,
                                                        org.apache.cassandra.thrift.TimedOutException,
                                                        org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.UnavailableException

org.apache.cassandra.thrift.TimedOutException

org.apache.thrift.TException

execute_cql3_query

org.apache.cassandra.thrift.CqlResult execute_cql3_query(CqlQuery cqlQuery,
                                                         org.apache.cassandra.thrift.Compression compression,
                                                         org.apache.cassandra.thrift.ConsistencyLevel consistency)
                                                  throws org.apache.cassandra.thrift.InvalidRequestException,
                                                         org.apache.cassandra.thrift.UnavailableException,
                                                         org.apache.cassandra.thrift.TimedOutException,
                                                         org.apache.cassandra.thrift.SchemaDisagreementException,
                                                         org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.UnavailableException

org.apache.cassandra.thrift.TimedOutException

org.apache.cassandra.thrift.SchemaDisagreementException

org.apache.thrift.TException

remove

void remove(String kvsMethodName,
            com.palantir.atlasdb.keyvalue.api.TableReference tableRef,
            byte[] row,
            long timestamp,
            org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
     throws org.apache.cassandra.thrift.InvalidRequestException,
            org.apache.cassandra.thrift.UnavailableException,
            org.apache.cassandra.thrift.TimedOutException,
            org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.UnavailableException

org.apache.cassandra.thrift.TimedOutException

org.apache.thrift.TException

getOutputProtocol

org.apache.thrift.protocol.TProtocol getOutputProtocol()

getInputProtocol

org.apache.thrift.protocol.TProtocol getInputProtocol()

describe_ring

List<org.apache.cassandra.thrift.TokenRange> describe_ring(String keyspace)
                                                    throws org.apache.cassandra.thrift.InvalidRequestException,
                                                           org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.thrift.TException

get_host_ids

List<String> get_host_ids()
                   throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

describe_version

String describe_version()
                 throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

describe_schema_versions

Map<String,List<String>> describe_schema_versions()
                                                 throws org.apache.cassandra.thrift.InvalidRequestException,
                                                        org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.thrift.TException

describe_partitioner

String describe_partitioner()
                     throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

describe_keyspace

org.apache.cassandra.thrift.KsDef describe_keyspace(String keyspace)
                                             throws org.apache.cassandra.thrift.NotFoundException,
                                                    org.apache.cassandra.thrift.InvalidRequestException,
                                                    org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.NotFoundException

org.apache.cassandra.thrift.InvalidRequestException

org.apache.thrift.TException

describe_keyspaces

List<org.apache.cassandra.thrift.KsDef> describe_keyspaces()
                                                    throws org.apache.cassandra.thrift.InvalidRequestException,
                                                           org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.thrift.TException

system_add_keyspace

String system_add_keyspace(org.apache.cassandra.thrift.KsDef ks_def)
                    throws org.apache.cassandra.thrift.InvalidRequestException,
                           org.apache.cassandra.thrift.SchemaDisagreementException,
                           org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.SchemaDisagreementException

org.apache.thrift.TException

system_update_keyspace

String system_update_keyspace(org.apache.cassandra.thrift.KsDef ks_def)
                       throws org.apache.cassandra.thrift.InvalidRequestException,
                              org.apache.cassandra.thrift.SchemaDisagreementException,
                              org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.SchemaDisagreementException

org.apache.thrift.TException

system_update_column_family

String system_update_column_family(org.apache.cassandra.thrift.CfDef cf_def)
                            throws org.apache.cassandra.thrift.InvalidRequestException,
                                   org.apache.cassandra.thrift.SchemaDisagreementException,
                                   org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.SchemaDisagreementException

org.apache.thrift.TException

system_drop_column_family

String system_drop_column_family(String column_family)
                          throws org.apache.cassandra.thrift.InvalidRequestException,
                                 org.apache.cassandra.thrift.SchemaDisagreementException,
                                 org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.SchemaDisagreementException

org.apache.thrift.TException

prepare_cql3_query

org.apache.cassandra.thrift.CqlPreparedResult prepare_cql3_query(ByteBuffer query,
                                                                 org.apache.cassandra.thrift.Compression compression)
                                                          throws org.apache.cassandra.thrift.InvalidRequestException,
                                                                 org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.thrift.TException

execute_prepared_cql3_query

org.apache.cassandra.thrift.CqlResult execute_prepared_cql3_query(int intemId,
                                                                  List<ByteBuffer> values,
                                                                  org.apache.cassandra.thrift.ConsistencyLevel consistency)
                                                           throws org.apache.cassandra.thrift.InvalidRequestException,
                                                                  org.apache.cassandra.thrift.UnavailableException,
                                                                  org.apache.cassandra.thrift.TimedOutException,
                                                                  org.apache.cassandra.thrift.SchemaDisagreementException,
                                                                  org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.UnavailableException

org.apache.cassandra.thrift.TimedOutException

org.apache.cassandra.thrift.SchemaDisagreementException

org.apache.thrift.TException

trace_next_query

ByteBuffer trace_next_query()
                     throws org.apache.thrift.TException

Throws:

org.apache.thrift.TException

truncate

void truncate(String cfname)
       throws org.apache.cassandra.thrift.InvalidRequestException,
              org.apache.cassandra.thrift.UnavailableException,
              org.apache.cassandra.thrift.TimedOutException,
              org.apache.thrift.TException

Throws:

org.apache.cassandra.thrift.InvalidRequestException

org.apache.cassandra.thrift.UnavailableException

org.apache.cassandra.thrift.TimedOutException

org.apache.thrift.TException

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable