| IMapper Interface |
A client for creating, updating, deleting, and reading POCOs from a Cassandra cluster.
Namespace: Dse.Mapping
Assembly: Dse (in Dse.dll) Version: 2.3.0
SyntaxC#
public interface IMapper : ICqlQueryAsyncClient, ICqlWriteAsyncClient, ICqlQueryClient, ICqlWriteClient
The IMapper type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | ConvertCqlArgumentTValue, TDatabase |
Allows you to convert an argument/bind variable value being used in a CQL statement using the same converters that are being used by the client
internally, including any user-defined conversions if you configured them. Will convert a value of Type TValue to a value of
Type TDatabase or throw an InvalidOperationException if no converter is available.
|
| CreateBatch |
Creates a new batch.
To set the consistency level, timestamp and other batch options, use WithOptions(ActionCqlQueryOptions). Individual options for each query within the batch will be ignored. |
| CreateBatch(BatchType) |
Creates a new batch.
To set the consistency level, timestamp and other batch options, use WithOptions(ActionCqlQueryOptions). Individual options for each query within the batch will be ignored. |
| DeleteT(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.
(Inherited from ICqlWriteClient.) |
| DeleteT(String, 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.
(Inherited from ICqlWriteClient.) |
| DeleteT(T, CqlQueryOptions) |
Deletes the specified POCO from Cassandra.
(Inherited from ICqlWriteClient.) |
| DeleteAsyncT(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.
(Inherited from ICqlWriteAsyncClient.) |
| DeleteAsyncT(String, 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.
(Inherited from ICqlWriteAsyncClient.) |
| DeleteAsyncT(T, CqlQueryOptions) |
Deletes the specified POCO from Cassandra.
(Inherited from ICqlWriteAsyncClient.) |
| DeleteIfT(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. |
| DeleteIfT(String, 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. |
| DeleteIfAsyncT(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. |
| DeleteIfAsyncT(String, 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. |
| Execute(Cql) |
Executes the arbitrary CQL statement specified.
(Inherited from ICqlWriteClient.) |
| Execute(ICqlBatch) |
Executes the batch specfied synchronously.
|
| Execute(String, Object) |
Executes an arbitrary CQL string with the bind variable values specified.
(Inherited from ICqlWriteClient.) |
| ExecuteAsync(Cql) |
Executes an arbitrary CQL statement.
(Inherited from ICqlWriteAsyncClient.) |
| ExecuteAsync(ICqlBatch) |
Executes the batch specified asynchronously.
|
| ExecuteAsync(String, Object) |
Executes an arbitrary CQL string with the bind variable values specified.
(Inherited from ICqlWriteAsyncClient.) |
| ExecuteConditionalT |
Executes a batch that contains a Lightweight transaction.
|
| ExecuteConditionalAsyncT |
Executes a batch that contains a Lightweight transaction.
|
| FetchT(Cql) |
Gets a list of T from Cassandra using the CQL statement specified.
(Inherited from ICqlQueryClient.) |
| FetchT(CqlQueryOptions) |
Gets a list of all T from Cassandra.
(Inherited from ICqlQueryClient.) |
| FetchT(String, Object) |
Gets a list of T from Cassandra using the CQL statement and parameter values specified.
(Inherited from ICqlQueryClient.) |
| FetchAsyncT(Cql) |
Gets a list of T from Cassandra using the CQL statement specified.
(Inherited from ICqlQueryAsyncClient.) |
| FetchAsyncT(CqlQueryOptions) |
Gets a list of all T from Cassandra.
(Inherited from ICqlQueryAsyncClient.) |
| FetchAsyncT(String, Object) |
Gets a list of T from Cassandra using the CQL statement and parameter values specified.
(Inherited from ICqlQueryAsyncClient.) |
| FetchPageT(Cql) |
Gets a paged list of T results from Cassandra.
Suitable for manually page through all the results of a query.
(Inherited from ICqlQueryClient.) |
| FetchPageT(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.
(Inherited from ICqlQueryClient.) |
| FetchPageT(Int32, Byte, String, Object) |
Gets a paged list of T results from Cassandra.
Suitable for manually page through all the results of a query.
(Inherited from ICqlQueryClient.) |
| FetchPageAsyncT(Cql) |
Gets a paged list of T results from Cassandra.
Suitable for manually page through all the results of a query.
(Inherited from ICqlQueryAsyncClient.) |
| FetchPageAsyncT(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.
(Inherited from ICqlQueryAsyncClient.) |
| FetchPageAsyncT(Int32, Byte, String, Object) |
Gets a paged list of T results from Cassandra.
Suitable for manually page through all the results of a query.
(Inherited from ICqlQueryAsyncClient.) |
| FirstT(Cql) |
Gets the first T from Cassandra using the CQL statement specified. Will throw if no records are returned.
(Inherited from ICqlQueryClient.) |
| FirstT(String, Object) |
Gets the first T from Cassandra using the CQL statement and parameter values specified. Will throw if no
records are returned.
(Inherited from ICqlQueryClient.) |
| FirstAsyncT(Cql) |
Gets the first T from Cassandra using the CQL specified. Will throw if no records are returned.
(Inherited from ICqlQueryAsyncClient.) |
| FirstAsyncT(String, Object) |
Gets the first T from Cassandra using the CQL statement and parameter values specified. Will throw if no
records are returned.
(Inherited from ICqlQueryAsyncClient.) |
| FirstOrDefaultT(Cql) |
Gets the first T from Cassandra using the CQL statement specified. Will return the default value of T if
no records are found.
(Inherited from ICqlQueryClient.) |
| FirstOrDefaultT(String, 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.
(Inherited from ICqlQueryClient.) |
| FirstOrDefaultAsyncT(Cql) |
Gets the first T from Cassandra using the CQL specified. Will return the default value of T if no records
are found.
(Inherited from ICqlQueryAsyncClient.) |
| FirstOrDefaultAsyncT(String, 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.
(Inherited from ICqlQueryAsyncClient.) |
| InsertT(T, CqlQueryOptions) |
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteClient.) |
| InsertT(T, Boolean, CqlQueryOptions) |
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteClient.) |
| InsertT(T, Boolean, NullableInt32, CqlQueryOptions) |
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteClient.) |
| InsertAsyncT(T, CqlQueryOptions) |
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteAsyncClient.) |
| InsertAsyncT(T, Boolean, CqlQueryOptions) |
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteAsyncClient.) |
| InsertAsyncT(T, Boolean, NullableInt32, CqlQueryOptions) |
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteAsyncClient.) |
| InsertIfNotExistsT(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. |
| InsertIfNotExistsT(T, Boolean, CqlQueryOptions) |
Inserts the specified POCO in Cassandra, if not exists.
|
| InsertIfNotExistsT(T, Boolean, NullableInt32, CqlQueryOptions) |
Inserts the specified POCO in Cassandra, if not exists.
|
| InsertIfNotExistsAsyncT(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. |
| InsertIfNotExistsAsyncT(T, Boolean, CqlQueryOptions) |
Inserts the specified POCO in Cassandra, if not exists.
|
| InsertIfNotExistsAsyncT(T, Boolean, NullableInt32, CqlQueryOptions) |
Inserts the specified POCO in Cassandra, if not exists.
|
| SingleT(Cql) |
Gets a single T from Cassandra using the CQL statement specified. Will throw if no records or more than
one record is returned.
(Inherited from ICqlQueryClient.) |
| SingleT(String, 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.
(Inherited from ICqlQueryClient.) |
| SingleAsyncT(Cql) |
Gets a single T from Cassandra using the CQL statement specified. Will throw if no records or more than one
record is returned.
(Inherited from ICqlQueryAsyncClient.) |
| SingleAsyncT(String, 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.
(Inherited from ICqlQueryAsyncClient.) |
| SingleOrDefaultT(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.
(Inherited from ICqlQueryClient.) |
| SingleOrDefaultT(String, 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.
(Inherited from ICqlQueryClient.) |
| SingleOrDefaultAsyncT(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.
(Inherited from ICqlQueryAsyncClient.) |
| SingleOrDefaultAsyncT(String, 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.
(Inherited from ICqlQueryAsyncClient.) |
| UpdateT(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.
(Inherited from ICqlWriteClient.) |
| UpdateT(String, 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.
(Inherited from ICqlWriteClient.) |
| UpdateT(T, CqlQueryOptions) |
Updates the POCO specified in Cassandra.
(Inherited from ICqlWriteClient.) |
| UpdateAsyncT(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.
(Inherited from ICqlWriteAsyncClient.) |
| UpdateAsyncT(String, 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.
(Inherited from ICqlWriteAsyncClient.) |
| UpdateAsyncT(T, CqlQueryOptions) |
Updates the POCO specified in Cassandra.
(Inherited from ICqlWriteAsyncClient.) |
| UpdateIfT(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. |
| UpdateIfT(String, 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. |
| UpdateIfAsyncT(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. |
| UpdateIfAsyncT(String, 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. |
See Also