Click or drag to resize
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
Syntax
C#
public interface IMapper : ICqlQueryAsyncClient, 
	ICqlWriteAsyncClient, ICqlQueryClient, ICqlWriteClient

The IMapper type exposes the following members.

Methods
  NameDescription
Public methodConvertCqlArgumentTValue, 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.
Public methodCreateBatch
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.

Public methodCreateBatch(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.

Public methodDeleteT(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.)
Public methodDeleteT(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.)
Public methodDeleteT(T, CqlQueryOptions)
Deletes the specified POCO from Cassandra.
(Inherited from ICqlWriteClient.)
Public methodDeleteAsyncT(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.)
Public methodDeleteAsyncT(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.)
Public methodDeleteAsyncT(T, CqlQueryOptions)
Deletes the specified POCO from Cassandra.
(Inherited from ICqlWriteAsyncClient.)
Public methodDeleteIfT(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.

Public methodDeleteIfT(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.

Public methodDeleteIfAsyncT(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.

Public methodDeleteIfAsyncT(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.

Public methodExecute(Cql)
Executes the arbitrary CQL statement specified.
(Inherited from ICqlWriteClient.)
Public methodExecute(ICqlBatch)
Executes the batch specfied synchronously.
Public methodExecute(String, Object)
Executes an arbitrary CQL string with the bind variable values specified.
(Inherited from ICqlWriteClient.)
Public methodExecuteAsync(Cql)
Executes an arbitrary CQL statement.
(Inherited from ICqlWriteAsyncClient.)
Public methodExecuteAsync(ICqlBatch)
Executes the batch specified asynchronously.
Public methodExecuteAsync(String, Object)
Executes an arbitrary CQL string with the bind variable values specified.
(Inherited from ICqlWriteAsyncClient.)
Public methodExecuteConditionalT
Executes a batch that contains a Lightweight transaction.
Public methodExecuteConditionalAsyncT
Executes a batch that contains a Lightweight transaction.
Public methodFetchT(Cql)
Gets a list of T from Cassandra using the CQL statement specified.
(Inherited from ICqlQueryClient.)
Public methodFetchT(CqlQueryOptions)
Gets a list of all T from Cassandra.
(Inherited from ICqlQueryClient.)
Public methodFetchT(String, Object)
Gets a list of T from Cassandra using the CQL statement and parameter values specified.
(Inherited from ICqlQueryClient.)
Public methodFetchAsyncT(Cql)
Gets a list of T from Cassandra using the CQL statement specified.
(Inherited from ICqlQueryAsyncClient.)
Public methodFetchAsyncT(CqlQueryOptions)
Gets a list of all T from Cassandra.
(Inherited from ICqlQueryAsyncClient.)
Public methodFetchAsyncT(String, Object)
Gets a list of T from Cassandra using the CQL statement and parameter values specified.
(Inherited from ICqlQueryAsyncClient.)
Public methodFetchPageT(Cql)
Gets a paged list of T results from Cassandra. Suitable for manually page through all the results of a query.
(Inherited from ICqlQueryClient.)
Public methodFetchPageT(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.)
Public methodFetchPageT(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.)
Public methodFetchPageAsyncT(Cql)
Gets a paged list of T results from Cassandra. Suitable for manually page through all the results of a query.
(Inherited from ICqlQueryAsyncClient.)
Public methodFetchPageAsyncT(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.)
Public methodFetchPageAsyncT(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.)
Public methodFirstT(Cql)
Gets the first T from Cassandra using the CQL statement specified. Will throw if no records are returned.
(Inherited from ICqlQueryClient.)
Public methodFirstT(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.)
Public methodFirstAsyncT(Cql)
Gets the first T from Cassandra using the CQL specified. Will throw if no records are returned.
(Inherited from ICqlQueryAsyncClient.)
Public methodFirstAsyncT(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.)
Public methodFirstOrDefaultT(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.)
Public methodFirstOrDefaultT(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.)
Public methodFirstOrDefaultAsyncT(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.)
Public methodFirstOrDefaultAsyncT(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.)
Public methodInsertT(T, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteClient.)
Public methodInsertT(T, Boolean, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteClient.)
Public methodInsertT(T, Boolean, NullableInt32, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteClient.)
Public methodInsertAsyncT(T, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteAsyncClient.)
Public methodInsertAsyncT(T, Boolean, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteAsyncClient.)
Public methodInsertAsyncT(T, Boolean, NullableInt32, CqlQueryOptions)
Inserts the specified POCO in Cassandra.
(Inherited from ICqlWriteAsyncClient.)
Public methodInsertIfNotExistsT(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.

Public methodInsertIfNotExistsT(T, Boolean, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists.
Public methodInsertIfNotExistsT(T, Boolean, NullableInt32, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists.
Public methodInsertIfNotExistsAsyncT(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.

Public methodInsertIfNotExistsAsyncT(T, Boolean, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists.
Public methodInsertIfNotExistsAsyncT(T, Boolean, NullableInt32, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists.
Public methodSingleT(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.)
Public methodSingleT(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.)
Public methodSingleAsyncT(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.)
Public methodSingleAsyncT(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.)
Public methodSingleOrDefaultT(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.)
Public methodSingleOrDefaultT(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.)
Public methodSingleOrDefaultAsyncT(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.)
Public methodSingleOrDefaultAsyncT(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.)
Public methodUpdateT(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.)
Public methodUpdateT(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.)
Public methodUpdateT(T, CqlQueryOptions)
Updates the POCO specified in Cassandra.
(Inherited from ICqlWriteClient.)
Public methodUpdateAsyncT(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.)
Public methodUpdateAsyncT(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.)
Public methodUpdateAsyncT(T, CqlQueryOptions)
Updates the POCO specified in Cassandra.
(Inherited from ICqlWriteAsyncClient.)
Public methodUpdateIfT(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.

Public methodUpdateIfT(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.

Public methodUpdateIfAsyncT(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.

Public methodUpdateIfAsyncT(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.

Top
See Also