Package com.palantir.atlasdb.keyvalue.cassandra

Interface CassandraClient

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

CassandraClientImpl, InstrumentedCassandraClient, ProfilingCassandraClient, QosCassandraClient, TracingCassandraClient

public interface CassandraClient
extends java.io.Closeable

Method Summary

Modifier and Type	Method	Description
void	batch_mutate(java.lang.String kvsMethodName, java.util.Map<java.nio.ByteBuffer,java.util.Map<java.lang.String,java.util.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, java.nio.ByteBuffer key, java.util.List<org.apache.cassandra.thrift.Column> expected, java.util.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(java.lang.String keyspace)
java.util.List<org.apache.cassandra.thrift.KsDef>	describe_keyspaces()
java.lang.String	describe_partitioner()
java.util.List<org.apache.cassandra.thrift.TokenRange>	describe_ring(java.lang.String keyspace)
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	describe_schema_versions()
java.lang.String	describe_snitch()
java.lang.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, java.util.List<java.nio.ByteBuffer> values, org.apache.cassandra.thrift.ConsistencyLevel consistency)
org.apache.cassandra.thrift.ColumnOrSuperColumn	get(com.palantir.atlasdb.keyvalue.api.TableReference tableReference, java.nio.ByteBuffer key, byte[] column, org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
java.util.List<java.lang.String>	get_host_ids()
java.util.List<org.apache.cassandra.thrift.KeySlice>	get_range_slices(java.lang.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.
java.util.Map<java.nio.ByteBuffer,java.util.List<java.util.List<org.apache.cassandra.thrift.ColumnOrSuperColumn>>>	multiget_multislice(java.lang.String kvsMethodName, com.palantir.atlasdb.keyvalue.api.TableReference tableRef, java.util.List<org.apache.cassandra.thrift.KeyPredicate> keyPredicates, org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
java.util.Map<java.nio.ByteBuffer,java.util.List<org.apache.cassandra.thrift.ColumnOrSuperColumn>>	multiget_slice(java.lang.String kvsMethodName, com.palantir.atlasdb.keyvalue.api.TableReference tableRef, java.util.List<java.nio.ByteBuffer> keys, org.apache.cassandra.thrift.SlicePredicate predicate, org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
org.apache.cassandra.thrift.CqlPreparedResult	prepare_cql3_query(java.nio.ByteBuffer query, org.apache.cassandra.thrift.Compression compression)
org.apache.cassandra.thrift.CASResult	put_unless_exists(com.palantir.atlasdb.keyvalue.api.TableReference tableReference, java.nio.ByteBuffer key, java.util.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(java.lang.String kvsMethodName, com.palantir.atlasdb.keyvalue.api.TableReference tableRef, byte[] row, long timestamp, org.apache.cassandra.thrift.ConsistencyLevel consistency_level)
java.lang.String	system_add_keyspace(org.apache.cassandra.thrift.KsDef ks_def)
java.lang.String	system_drop_column_family(java.lang.String column_family)
java.lang.String	system_update_column_family(org.apache.cassandra.thrift.CfDef cf_def)
java.lang.String	system_update_keyspace(org.apache.cassandra.thrift.KsDef ks_def)
java.nio.ByteBuffer	trace_next_query()
void	truncate(java.lang.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

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

Throws:

org.apache.thrift.TException

multiget_slice

java.util.Map<java.nio.ByteBuffer,java.util.List<org.apache.cassandra.thrift.ColumnOrSuperColumn>> multiget_slice(java.lang.String kvsMethodName,
                                                                                                                        com.palantir.atlasdb.keyvalue.api.TableReference tableRef,
                                                                                                                        java.util.List<java.nio.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

java.util.Map<java.nio.ByteBuffer,java.util.List<java.util.List<org.apache.cassandra.thrift.ColumnOrSuperColumn>>> multiget_multislice(java.lang.String kvsMethodName,
                                                                                                                                             com.palantir.atlasdb.keyvalue.api.TableReference tableRef,
                                                                                                                                             java.util.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

java.util.List<org.apache.cassandra.thrift.KeySlice> get_range_slices(java.lang.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(java.lang.String kvsMethodName,
                  java.util.Map<java.nio.ByteBuffer,java.util.Map<java.lang.String,java.util.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,
                                                    java.nio.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,
                                          java.nio.ByteBuffer key,
                                          java.util.List<org.apache.cassandra.thrift.Column> expected,
                                          java.util.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,
                                                        java.nio.ByteBuffer key,
                                                        java.util.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(java.lang.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

java.util.List<org.apache.cassandra.thrift.TokenRange> describe_ring(java.lang.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

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

Throws:

org.apache.thrift.TException

describe_version

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

Throws:

org.apache.thrift.TException

describe_schema_versions

java.util.Map<java.lang.String,java.util.List<java.lang.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

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

Throws:

org.apache.thrift.TException

describe_keyspace

org.apache.cassandra.thrift.KsDef describe_keyspace(java.lang.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

java.util.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

java.lang.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

java.lang.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

java.lang.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

java.lang.String system_drop_column_family(java.lang.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(java.nio.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,
                                                                  java.util.List<java.nio.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

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

Throws:

org.apache.thrift.TException

truncate

void truncate(java.lang.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 java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable