Class Mapper
The default CQL client implementation which uses the DataStax driver ISession provided in the constructor
for running queries against a Cassandra cluster.
Inheritance
object
Mapper
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Assembly: Cassandra.dll
Syntax
public class Mapper : IMapper, ICqlQueryAsyncClient, ICqlWriteAsyncClient, ICqlQueryClient, ICqlWriteClient
Constructors
Mapper(ISession, MappingConfiguration)
Creates a new instance of the mapper using the configuration provided
Declaration
public Mapper(ISession session, MappingConfiguration config)
Parameters
| Type |
Name |
Description |
| ISession |
session |
Session to be used to execute the statements
|
| MappingConfiguration |
config |
Mapping definitions for the POCOs
|
See Also
Mapper(ISession)
Creates a new instance of the mapper using Global mapping definitions.
Declaration
public Mapper(ISession session)
Parameters
See Also
Methods
ConvertCqlArgument<TValue, TDatabase>(TValue)
Declaration
public TDatabase ConvertCqlArgument<TValue, TDatabase>(TValue value)
Parameters
| Type |
Name |
Description |
| TValue |
value |
|
Returns
| Type |
Description |
| TDatabase |
|
Type Parameters
| Name |
Description |
| TValue |
|
| TDatabase |
|
See Also
CreateBatch()
Creates a new batch.
To set the consistency level, timestamp and other batch options, use
WithOptions(Action<CqlQueryOptions>). Individual options for each
query within the batch will be ignored.
Declaration
public ICqlBatch CreateBatch()
Returns
See Also
CreateBatch(BatchType)
Creates a new batch.
To set the consistency level, timestamp and other batch options, use
WithOptions(Action<CqlQueryOptions>). Individual options for each
query within the batch will be ignored.
Declaration
public ICqlBatch CreateBatch(BatchType batchType)
Parameters
Returns
See Also
Delete<T>(T, CqlQueryOptions)
Deletes the specified POCO from Cassandra.
Declaration
public void Delete<T>(T poco, CqlQueryOptions queryOptions = null)
Parameters
Type Parameters
See Also
Delete<T>(T, string, CqlQueryOptions)
Deletes the specified POCO from Cassandra using the provided execution profile.
Declaration
public void Delete<T>(T poco, string executionProfile, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
|
| string |
executionProfile |
|
| CqlQueryOptions |
queryOptions |
|
Type Parameters
See Also
Delete<T>(Cql)
Deletes from the table for the POCO type specified (T) using the CQL string specified. Prepends "DELETE FROM tablename " to the CQL statement you
specify, getting the tablename appropriately from the POCO Type T.
Declaration
public void Delete<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Type Parameters
See Also
Delete<T>(string, params object[])
Deletes from the table for the POCO type specified (T) using the CQL string and bind variable values specified. Prepends "DELETE FROM tablname " to
the CQL string you specify, getting the tablename appropriately from the POCO Type T.
Declaration
public void Delete<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Type Parameters
See Also
DeleteAsync<T>(T, CqlQueryOptions)
Deletes the specified POCO from Cassandra.
Declaration
public Task DeleteAsync<T>(T poco, CqlQueryOptions queryOptions = null)
Parameters
Returns
Type Parameters
See Also
DeleteAsync<T>(T, string, CqlQueryOptions)
Deletes the specified POCO from Cassandra using the provided execution profile.
Declaration
public Task DeleteAsync<T>(T poco, string executionProfile, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
|
| string |
executionProfile |
|
| CqlQueryOptions |
queryOptions |
|
Returns
Type Parameters
See Also
DeleteAsync<T>(Cql)
Deletes from the table for the POCO type specified (T) using the CQL statement specified. Prepends "DELETE FROM tablename " to the CQL statement you
specify, getting the tablename appropriately from the POCO Type T.
Declaration
public Task DeleteAsync<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
DeleteAsync<T>(string, params object[])
Deletes from the table for the POCO type specified (T) using the CQL string and bind variable values specified. Prepends "DELETE FROM tablname " to
the CQL string you specify, getting the tablename appropriately from the POCO Type T.
Declaration
public Task DeleteAsync<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
DeleteIf<T>(Cql)
Deletes from the table for the POCO type specified (T) using the Cql query specified.
Prepends "DELETE FROM tablename " to the CQL statement you specify, getting the tablename appropriately from the POCO Type T.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public AppliedInfo<T> DeleteIf<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
DeleteIf<T>(string, params object[])
Deletes from the table for the POCO type specified (T) using the CQL string specified and query parameters specified.
Prepends "DELETE FROM tablename " to the CQL statement you specify, getting the tablename appropriately from the POCO Type T.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public AppliedInfo<T> DeleteIf<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
DeleteIfAsync<T>(Cql)
Deletes from the table for the POCO type specified (T) using the Cql query specified.
Prepends "DELETE FROM tablename " to the CQL statement you specify, getting the tablename appropriately from the POCO Type T.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public Task<AppliedInfo<T>> DeleteIfAsync<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
DeleteIfAsync<T>(string, params object[])
Deletes from the table for the POCO type specified (T) using the CQL string specified and query parameters specified.
Prepends "DELETE FROM tablename " to the CQL statement you specify, getting the tablename appropriately from the POCO Type T.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public Task<AppliedInfo<T>> DeleteIfAsync<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
Execute(Cql)
Executes the arbitrary CQL statement specified.
Declaration
public void Execute(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
See Also
Execute(ICqlBatch, string)
Executes the batch specified synchronously with the provided execution profile.
Declaration
public void Execute(ICqlBatch batch, string executionProfile)
Parameters
| Type |
Name |
Description |
| ICqlBatch |
batch |
|
| string |
executionProfile |
|
Remarks
See Also
Execute(ICqlBatch)
Executes the batch specfied synchronously.
Declaration
public void Execute(ICqlBatch batch)
Parameters
Remarks
See Also
Execute(string, params object[])
Executes an arbitrary CQL string with the bind variable values specified.
Declaration
public void Execute(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
See Also
ExecuteAsync(Cql)
Executes an arbitrary CQL statement.
Declaration
public Task ExecuteAsync(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
See Also
ExecuteAsync(ICqlBatch, string)
Executes the batch specified asynchronously with the provided execution profile.
Declaration
public Task ExecuteAsync(ICqlBatch batch, string executionProfile)
Parameters
| Type |
Name |
Description |
| ICqlBatch |
batch |
|
| string |
executionProfile |
|
Returns
Remarks
See Also
ExecuteAsync(ICqlBatch)
Executes the batch specified asynchronously.
Declaration
public Task ExecuteAsync(ICqlBatch batch)
Parameters
Returns
Remarks
See Also
ExecuteAsync(string, params object[])
Executes an arbitrary CQL string with the bind variable values specified.
Declaration
public Task ExecuteAsync(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
See Also
ExecuteConditional<T>(ICqlBatch, string)
Executes a batch that contains a Lightweight transaction.
Declaration
public AppliedInfo<T> ExecuteConditional<T>(ICqlBatch batch, string executionProfile)
Parameters
| Type |
Name |
Description |
| ICqlBatch |
batch |
|
| string |
executionProfile |
|
Returns
Type Parameters
Remarks
See Also
ExecuteConditional<T>(ICqlBatch)
Executes a batch that contains a Lightweight transaction.
Declaration
public AppliedInfo<T> ExecuteConditional<T>(ICqlBatch batch)
Parameters
Returns
Type Parameters
Remarks
See Also
ExecuteConditionalAsync<T>(ICqlBatch, string)
Executes a batch that contains a Lightweight transaction with the provided execution profile.
Declaration
public Task<AppliedInfo<T>> ExecuteConditionalAsync<T>(ICqlBatch batch, string executionProfile)
Parameters
| Type |
Name |
Description |
| ICqlBatch |
batch |
|
| string |
executionProfile |
|
Returns
Type Parameters
Remarks
See Also
ExecuteConditionalAsync<T>(ICqlBatch)
Executes a batch that contains a Lightweight transaction.
Declaration
public Task<AppliedInfo<T>> ExecuteConditionalAsync<T>(ICqlBatch batch)
Parameters
Returns
Type Parameters
Remarks
See Also
Fetch<T>(Cql)
Gets a list of T from Cassandra using the CQL statement specified.
Declaration
public IEnumerable<T> Fetch<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
| Type |
Description |
| IEnumerable<T> |
|
Type Parameters
See Also
Fetch<T>(CqlQueryOptions)
Gets a list of all T from Cassandra.
Declaration
public IEnumerable<T> Fetch<T>(CqlQueryOptions queryOptions = null)
Parameters
Returns
| Type |
Description |
| IEnumerable<T> |
|
Type Parameters
See Also
Fetch<T>(string, params object[])
Gets a list of T from Cassandra using the CQL statement and parameter values specified.
Declaration
public IEnumerable<T> Fetch<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
| Type |
Description |
| IEnumerable<T> |
|
Type Parameters
See Also
FetchAsync<T>(Cql)
Gets a list of T from Cassandra using the CQL statement specified.
Declaration
public Task<IEnumerable<T>> FetchAsync<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
| Type |
Description |
| Task<IEnumerable<T>> |
|
Type Parameters
See Also
FetchAsync<T>(CqlQueryOptions)
Gets a list of all T from Cassandra.
Declaration
public Task<IEnumerable<T>> FetchAsync<T>(CqlQueryOptions options = null)
Parameters
Returns
| Type |
Description |
| Task<IEnumerable<T>> |
|
Type Parameters
See Also
FetchAsync<T>(string, params object[])
Gets a list of T from Cassandra using the CQL statement and parameter values specified.
Declaration
public Task<IEnumerable<T>> FetchAsync<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
| Type |
Description |
| Task<IEnumerable<T>> |
|
Type Parameters
See Also
FetchPage<T>(Cql)
Gets a paged list of T results from Cassandra.
Suitable for manually page through all the results of a query.
Declaration
public IPage<T> FetchPage<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
| Type |
Description |
| IPage<T> |
|
Type Parameters
See Also
FetchPage<T>(CqlQueryOptions)
Gets a paged list of T results from Cassandra using the CQL statement specified.
Suitable for manually page through all the results of a query.
Declaration
public IPage<T> FetchPage<T>(CqlQueryOptions queryOptions = null)
Parameters
Returns
| Type |
Description |
| IPage<T> |
|
Type Parameters
See Also
FetchPage<T>(int, byte[], string, params object[])
Gets a paged list of T results from Cassandra.
Suitable for manually page through all the results of a query.
Declaration
public IPage<T> FetchPage<T>(int pageSize, byte[] pagingState, string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| int |
pageSize |
Amount of items to return
|
| byte[] |
pagingState |
The token representing the state of the result page. To get the first page, use a null value.
|
| string |
cql |
|
| object[] |
args |
Query parameters
|
Returns
| Type |
Description |
| IPage<T> |
|
Type Parameters
See Also
FetchPageAsync<T>(Cql)
Gets a paged list of T results from Cassandra.
Suitable for manually page through all the results of a query.
Declaration
public Task<IPage<T>> FetchPageAsync<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
| Type |
Description |
| Task<IPage<T>> |
|
Type Parameters
See Also
FetchPageAsync<T>(CqlQueryOptions)
Gets a paged list of T results from Cassandra using the CQL statement specified.
Suitable for manually page through all the results of a query.
Declaration
public Task<IPage<T>> FetchPageAsync<T>(CqlQueryOptions options = null)
Parameters
Returns
| Type |
Description |
| Task<IPage<T>> |
|
Type Parameters
See Also
FetchPageAsync<T>(int, byte[], string, object[])
Gets a paged list of T results from Cassandra.
Suitable for manually page through all the results of a query.
Declaration
public Task<IPage<T>> FetchPageAsync<T>(int pageSize, byte[] pagingState, string query, object[] args)
Parameters
| Type |
Name |
Description |
| int |
pageSize |
Amount of items to return
|
| byte[] |
pagingState |
The token representing the state of the result page. To get the first page, use a null value.
|
| string |
query |
Cql query
|
| object[] |
args |
Query parameters
|
Returns
| Type |
Description |
| Task<IPage<T>> |
|
Type Parameters
See Also
First<T>(Cql)
Gets the first T from Cassandra using the CQL statement specified. Will throw if no records are returned.
Declaration
public T First<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
First<T>(string, params object[])
Gets the first T from Cassandra using the CQL statement and parameter values specified. Will throw if no
records are returned.
Declaration
public T First<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
FirstAsync<T>(Cql)
Gets the first T from Cassandra using the CQL specified. Will throw if no records are returned.
Declaration
public Task<T> FirstAsync<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
FirstAsync<T>(string, params object[])
Gets the first T from Cassandra using the CQL statement and parameter values specified. Will throw if no
records are returned.
Declaration
public Task<T> FirstAsync<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
FirstOrDefault<T>(Cql)
Gets the first T from Cassandra using the CQL statement specified. Will return the default value of T if
no records are found.
Declaration
public T FirstOrDefault<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
FirstOrDefault<T>(string, params object[])
Gets the first T from Cassandra using the CQL statement and parameter values specified. Will return the
default value of T is no records are found.
Declaration
public T FirstOrDefault<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
FirstOrDefaultAsync<T>(Cql)
Gets the first T from Cassandra using the CQL specified. Will return the default value of T if no records
are found.
Declaration
public Task<T> FirstOrDefaultAsync<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
FirstOrDefaultAsync<T>(string, params object[])
Gets the first T from Cassandra using the CQL statement and parameter values specified. Will return the
default value of T is no records are found.
Declaration
public Task<T> FirstOrDefaultAsync<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
Insert<T>(T, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
Declaration
public void Insert<T>(T poco, CqlQueryOptions queryOptions = null)
Parameters
Type Parameters
See Also
Insert<T>(T, bool, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
Declaration
public void Insert<T>(T poco, bool insertNulls, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Type Parameters
See Also
Insert<T>(T, bool, int?, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
Declaration
public void Insert<T>(T poco, bool insertNulls, int? ttl, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| int? |
ttl |
Time to live (in seconds) for the inserted values. If set, the inserted values are automatically removed
from the database after the specified time.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Type Parameters
See Also
Insert<T>(T, string, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
Declaration
public void Insert<T>(T poco, string executionProfile, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
|
| string |
executionProfile |
|
| CqlQueryOptions |
queryOptions |
|
Type Parameters
See Also
Insert<T>(T, string, bool, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
Declaration
public void Insert<T>(T poco, string executionProfile, bool insertNulls, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| string |
executionProfile |
The execution profile to use when executing the request.
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Type Parameters
See Also
Insert<T>(T, string, bool, int?, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
Declaration
public void Insert<T>(T poco, string executionProfile, bool insertNulls, int? ttl, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| string |
executionProfile |
The execution profile to use when executing the request.
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| int? |
ttl |
Time to live (in seconds) for the inserted values. If set, the inserted values are automatically removed
from the database after the specified time.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Type Parameters
See Also
InsertAsync<T>(T, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
Declaration
public Task InsertAsync<T>(T poco, CqlQueryOptions queryOptions = null)
Parameters
Returns
Type Parameters
See Also
InsertAsync<T>(T, bool, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
Declaration
public Task InsertAsync<T>(T poco, bool insertNulls, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
InsertAsync<T>(T, bool, int?, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
Declaration
public Task InsertAsync<T>(T poco, bool insertNulls, int? ttl, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| int? |
ttl |
Time to live (in seconds) for the inserted values. If set, the inserted values are automatically removed
from the database after the specified time.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
InsertAsync<T>(T, string, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
Declaration
public Task InsertAsync<T>(T poco, string executionProfile, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
|
| string |
executionProfile |
|
| CqlQueryOptions |
queryOptions |
|
Returns
Type Parameters
See Also
InsertAsync<T>(T, string, bool, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
Declaration
public Task InsertAsync<T>(T poco, string executionProfile, bool insertNulls, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| string |
executionProfile |
The execution profile to use when executing the request.
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
InsertAsync<T>(T, string, bool, int?, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
Declaration
public Task InsertAsync<T>(T poco, string executionProfile, bool insertNulls, int? ttl, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| string |
executionProfile |
The execution profile to use when executing the request.
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| int? |
ttl |
Time to live (in seconds) for the inserted values. If set, the inserted values are automatically removed
from the database after the specified time.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
InsertIfNotExists<T>(T, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public AppliedInfo<T> InsertIfNotExists<T>(T poco, CqlQueryOptions queryOptions = null)
Parameters
Returns
Type Parameters
See Also
InsertIfNotExists<T>(T, bool, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists.
Declaration
public AppliedInfo<T> InsertIfNotExists<T>(T poco, bool insertNulls, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
InsertIfNotExists<T>(T, bool, int?, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists.
Declaration
public AppliedInfo<T> InsertIfNotExists<T>(T poco, bool insertNulls, int? ttl, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| int? |
ttl |
Time to live (in seconds) for the inserted values. If set, the inserted values are automatically removed
from the database after the specified time.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
InsertIfNotExists<T>(T, string, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists, with the provided execution profile.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public AppliedInfo<T> InsertIfNotExists<T>(T poco, string executionProfile, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
|
| string |
executionProfile |
|
| CqlQueryOptions |
queryOptions |
|
Returns
Type Parameters
See Also
InsertIfNotExists<T>(T, string, bool, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists, with the provided execution profile.
Declaration
public AppliedInfo<T> InsertIfNotExists<T>(T poco, string executionProfile, bool insertNulls, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| string |
executionProfile |
The execution profile to use when executing the request.
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
InsertIfNotExists<T>(T, string, bool, int?, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists, with the provided execution profile.
Declaration
public AppliedInfo<T> InsertIfNotExists<T>(T poco, string executionProfile, bool insertNulls, int? ttl, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| string |
executionProfile |
The execution profile to use when executing the request.
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| int? |
ttl |
Time to live (in seconds) for the inserted values. If set, the inserted values are automatically removed
from the database after the specified time.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
InsertIfNotExistsAsync<T>(T, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public Task<AppliedInfo<T>> InsertIfNotExistsAsync<T>(T poco, CqlQueryOptions queryOptions = null)
Parameters
Returns
Type Parameters
See Also
InsertIfNotExistsAsync<T>(T, bool, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists.
Declaration
public Task<AppliedInfo<T>> InsertIfNotExistsAsync<T>(T poco, bool insertNulls, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
InsertIfNotExistsAsync<T>(T, bool, int?, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists.
Declaration
public Task<AppliedInfo<T>> InsertIfNotExistsAsync<T>(T poco, bool insertNulls, int? ttl, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| int? |
ttl |
Time to live (in seconds) for the inserted values. If set, the inserted values are automatically removed
from the database after the specified time.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
InsertIfNotExistsAsync<T>(T, string, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists, with the provided execution profile.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public Task<AppliedInfo<T>> InsertIfNotExistsAsync<T>(T poco, string executionProfile, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
|
| string |
executionProfile |
|
| CqlQueryOptions |
queryOptions |
|
Returns
Type Parameters
See Also
InsertIfNotExistsAsync<T>(T, string, bool, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists, with the provided execution profile.
Declaration
public Task<AppliedInfo<T>> InsertIfNotExistsAsync<T>(T poco, string executionProfile, bool insertNulls, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| string |
executionProfile |
The execution profile to use when executing the request.
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
InsertIfNotExistsAsync<T>(T, string, bool, int?, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists, with the provided execution profile.
Declaration
public Task<AppliedInfo<T>> InsertIfNotExistsAsync<T>(T poco, string executionProfile, bool insertNulls, int? ttl, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
The POCO instance
|
| string |
executionProfile |
The execution profile to use when executing the request.
|
| bool |
insertNulls |
Determines if the query must be generated using NULL values for null POCO
members.
Use false if you don't want to consider null values for the INSERT
operation (recommended).
Use true if you want to override all the values in the table,
generating tombstones for null values.
|
| int? |
ttl |
Time to live (in seconds) for the inserted values. If set, the inserted values are automatically removed
from the database after the specified time.
|
| CqlQueryOptions |
queryOptions |
Optional query options
|
Returns
Type Parameters
See Also
Single<T>(Cql)
Gets a single T from Cassandra using the CQL statement specified. Will throw if no records or more than
one record is returned.
Declaration
public T Single<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
Single<T>(string, params object[])
Gets a single T from Cassandra using the CQL statement and parameter values specified. Will throw if
no records or more than one record is returned.
Declaration
public T Single<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
SingleAsync<T>(Cql)
Gets a single T from Cassandra using the CQL statement specified. Will throw if no records or more than one
record is returned.
Declaration
public Task<T> SingleAsync<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
SingleAsync<T>(string, params object[])
Gets a single T from Cassandra using the CQL statement and parameter values specified. Will throw if
no records or more than one record is returned.
Declaration
public Task<T> SingleAsync<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
SingleOrDefault<T>(Cql)
Gets a single T from Cassandra using the CQL statement specified. Will return the default value of T if
no records are found. Will throw if more than one record is returned.
Declaration
public T SingleOrDefault<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
SingleOrDefault<T>(string, params object[])
Gets a single T from Cassandra using the CQL statement and parameter values specified. Will return the
default value of T if no records are found. Will throw if more than one record is returned.
Declaration
public T SingleOrDefault<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
SingleOrDefaultAsync<T>(Cql)
Gets a single T from Cassandra using the CQL statement specified. Will return the default value of T if no
records are found. Will throw if more than one record is returned.
Declaration
public Task<T> SingleOrDefaultAsync<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
SingleOrDefaultAsync<T>(string, params object[])
Gets a single T from Cassandra using the CQL statement and parameter values specified. Will return the
default value of T if no records are found. Will throw if more than one record is returned.
Declaration
public Task<T> SingleOrDefaultAsync<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
Update<T>(T, CqlQueryOptions)
Updates the POCO specified in Cassandra.
Declaration
public void Update<T>(T poco, CqlQueryOptions queryOptions = null)
Parameters
Type Parameters
See Also
Update<T>(T, string, CqlQueryOptions)
Updates the POCO specified in Cassandra using the provided execution profile.
Declaration
public void Update<T>(T poco, string executionProfile, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
|
| string |
executionProfile |
|
| CqlQueryOptions |
queryOptions |
|
Type Parameters
See Also
Update<T>(Cql)
Updates the table for the POCO type specified (T) using the CQL statement specified. Prepends "UPDATE tablename" to the CQL statement you specify,
getting the tablename appropriately from the POCO Type T.
Declaration
public void Update<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Type Parameters
See Also
Update<T>(string, params object[])
Updates the table for the POCO type specified (T) using the CQL string and bind variable values specified. Prepends "UPDATE tablename " to the CQL
string you specify, getting the tablename appropriately from the POCO Type T.
Declaration
public void Update<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Type Parameters
| Name |
Description |
| T |
The POCO Type being updated.
|
See Also
UpdateAsync<T>(T, CqlQueryOptions)
Updates the POCO specified in Cassandra.
Declaration
public Task UpdateAsync<T>(T poco, CqlQueryOptions queryOptions = null)
Parameters
Returns
Type Parameters
See Also
UpdateAsync<T>(T, string, CqlQueryOptions)
Updates the POCO specified in Cassandra using the provided execution profile.
Declaration
public Task UpdateAsync<T>(T poco, string executionProfile, CqlQueryOptions queryOptions = null)
Parameters
| Type |
Name |
Description |
| T |
poco |
|
| string |
executionProfile |
|
| CqlQueryOptions |
queryOptions |
|
Returns
Type Parameters
See Also
UpdateAsync<T>(Cql)
Updates the table for the poco type specified (T) using the CQL statement specified. Prepends "UPDATE tablename" to the CQL statement you specify,
getting the tablename appropriately from the POCO Type T.
Declaration
public Task UpdateAsync<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
UpdateAsync<T>(string, params object[])
Updates the table for the POCO type specified (T) using the CQL string and bind variable values specified. Prepends "UPDATE tablename " to the CQL
string you specify, getting the tablename appropriately from the POCO Type T.
Declaration
public Task UpdateAsync<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
| Name |
Description |
| T |
The POCO Type being updated.
|
See Also
UpdateIf<T>(Cql)
Updates the table for the poco type specified (T) using the CQL statement specified, using lightweight transactions.
Prepends "UPDATE tablename" to the CQL statement you specify, getting the table name appropriately from the POCO Type T.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public AppliedInfo<T> UpdateIf<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
UpdateIf<T>(string, params object[])
Updates the table for the poco type specified (T) using the CQL statement specified, using lightweight transactions.
Prepends "UPDATE tablename" to the CQL statement you specify, getting the table name appropriately from the POCO Type T.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public AppliedInfo<T> UpdateIf<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
UpdateIfAsync<T>(Cql)
Updates the table for the poco type specified (T) using the CQL statement specified, using lightweight transactions.
Prepends "UPDATE tablename" to the CQL statement you specify, getting the table name appropriately from the POCO Type T.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public Task<AppliedInfo<T>> UpdateIfAsync<T>(Cql cql)
Parameters
| Type |
Name |
Description |
| Cql |
cql |
|
Returns
Type Parameters
See Also
UpdateIfAsync<T>(string, params object[])
Updates the table for the poco type specified (T) using the CQL statement specified, using lightweight transactions.
Prepends "UPDATE tablename" to the CQL statement you specify, getting the table name appropriately from the POCO Type T.
Returns information whether it was applied or not. If it was not applied, it returns details of the existing values.
Declaration
public Task<AppliedInfo<T>> UpdateIfAsync<T>(string cql, params object[] args)
Parameters
| Type |
Name |
Description |
| string |
cql |
|
| object[] |
args |
|
Returns
Type Parameters
See Also
Implements
See Also