Click or drag to resize
IMapper Interface
A client for creating, updating, deleting, and reading POCOs from a Cassandra cluster.

Namespace: Cassandra.Mapping
Assembly: Cassandra (in Cassandra.dll) Version: 3.7.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 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
Executes the batch specfied synchronously.
Public methodExecuteAsync
Executes the batch specified asynchronously.
Public methodExecuteConditionalT
Executes a batch that contains a Lightweight transaction.
Public methodExecuteConditionalAsyncT
Executes a batch that contains a Lightweight transaction.
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 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