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.11.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
Deletes the specified POCO from Cassandra using the provided execution profile.
Public methodDeleteAsyncT
Deletes the specified POCO from Cassandra using the provided execution profile.
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(ICqlBatch)
Executes the batch specfied synchronously.
Public methodExecute(ICqlBatch, String)
Executes the batch specified synchronously with the provided execution profile.
Public methodExecuteAsync(ICqlBatch)
Executes the batch specified asynchronously.
Public methodExecuteAsync(ICqlBatch, String)
Executes the batch specified asynchronously with the provided execution profile.
Public methodExecuteConditionalT(ICqlBatch)
Executes a batch that contains a Lightweight transaction.
Public methodExecuteConditionalT(ICqlBatch, String)
Executes a batch that contains a Lightweight transaction.
Public methodExecuteConditionalAsyncT(ICqlBatch)
Executes a batch that contains a Lightweight transaction.
Public methodExecuteConditionalAsyncT(ICqlBatch, String)
Executes a batch that contains a Lightweight transaction with the provided execution profile.
Public methodInsertT(T, String, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
Public methodInsertT(T, String, Boolean, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
Public methodInsertT(T, String, Boolean, NullableInt32, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
Public methodInsertAsyncT(T, String, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
Public methodInsertAsyncT(T, String, Boolean, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
Public methodInsertAsyncT(T, String, Boolean, NullableInt32, CqlQueryOptions)
Inserts the specified POCO in Cassandra using the provided execution profile.
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, 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.

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

Public methodInsertIfNotExistsAsyncT(T, Boolean, NullableInt32, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists.
Public methodInsertIfNotExistsAsyncT(T, String, Boolean, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists, with the provided execution profile.
Public methodInsertIfNotExistsAsyncT(T, String, Boolean, NullableInt32, CqlQueryOptions)
Inserts the specified POCO in Cassandra, if not exists, with the provided execution profile.
Public methodUpdateT
Updates the POCO specified in Cassandra using the provided execution profile.
Public methodUpdateAsyncT
Updates the POCO specified in Cassandra using the provided execution profile.
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