• DataStax Enterprise C# Driver API Documentation

    Show / Hide Table of Contents
    • Dse
      • AggregateMetadata
      • AlreadyExistsException
      • AtomicMonotonicTimestampGenerator
      • AtomicMonotonicWinApiTimestampGenerator
      • AuthenticationException
      • BatchStatement
      • BatchType
      • BigIntegerTypeAdapter
      • BoundStatement
      • Builder
      • BusyPoolException
      • CassandraConnectionStringBuilder
      • ClientOptions
      • Cluster
      • ColumnDesc
      • ColumnTypeCode
      • CompressionType
      • Configuration
      • ConsistencyLevel
      • ConstantReconnectionPolicy
      • ConstantSpeculativeExecutionPolicy
      • CqlColumn
      • CustomColumnInfo
      • DataCollectionMetadata
      • DataCollectionMetadata.SortOrder
      • DCAwareRoundRobinPolicy
      • DecimalTypeAdapter
      • DefaultRetryPolicy
      • Diagnostics
      • DowngradingConsistencyRetryPolicy
      • DriverException
      • DriverInternalError
      • DseCluster
      • DseClusterBuilder
      • DseConfiguration
      • DseLoadBalancingPolicy
      • Duration
      • DynamicCompositeTypeAdapter
      • EC2MultiRegionTranslator
      • ExecutionException
      • ExecutionInfo
      • ExponentialReconnectionPolicy
      • Extensions
      • FallthroughRetryPolicy
      • FixedReconnectionPolicy
      • FunctionFailureException
      • FunctionMetadata
      • Host
      • HostDistance
      • HostsEventArgs
      • HostsEventArgs.Kind
      • HostsEventHandler
      • IAddressTranslator
      • IAuthenticator
      • IAuthProvider
      • IAuthProviderNamed
      • ICluster
      • IColumnInfo
      • IdempotenceAwareRetryPolicy
      • IDseCluster
      • IDseSession
      • IExecutionProfile
      • IExecutionProfileBuilder
      • IExecutionProfileOptions
      • IExtendedRetryPolicy
      • IFrameCompressor
      • IInitializer
      • ILoadBalancingPolicy
      • IndexMetadata
      • IndexMetadata.IndexKind
      • InvalidConfigurationInQueryException
      • InvalidQueryException
      • InvalidTypeException
      • IReconnectionPolicy
      • IReconnectionSchedule
      • IRetryPolicy
      • IsBootstrappingException
      • ISession
      • ISessionState
      • ISpeculativeExecutionPlan
      • ISpeculativeExecutionPolicy
      • IStatement
      • ITimestampGenerator
      • ITypeAdapter
      • KeyspaceMetadata
      • KeyType
      • ListColumnInfo
      • LocalDate
      • LocalTime
      • Logger
      • LoggingRetryPolicy
      • MapColumnInfo
      • MaterializedViewMetadata
      • Metadata
      • MetadataSyncOptions
      • MetricsExtensions
      • MonitorReportingOptions
      • NoHostAvailableException
      • NoneAuthProvider
      • NoSpeculativeExecutionPolicy
      • NullTypeAdapter
      • OperationTimedOutException
      • OverloadedException
      • PlainTextAuthProvider
      • Policies
      • PoolingOptions
      • PreparedQueryNotFoundException
      • PreparedStatement
      • PreparedStatementIdMismatchException
      • ProtocolErrorException
      • ProtocolOptions
      • ProtocolVersion
      • QueryExecutionException
      • QueryOptions
      • QueryProtocolOptions
      • QueryProtocolOptions.QueryFlags
      • QueryTimeoutException
      • QueryTrace
      • QueryTrace.Event
      • QueryValidationException
      • ReadFailureException
      • ReadTimeoutException
      • RegularStatement
      • ReplicationStrategies
      • RequestInvalidException
      • RetryDecision
      • RetryDecision.RetryDecisionType
      • RetryLoadBalancingPolicy
      • RetryLoadBalancingPolicyEventArgs
      • RoundRobinPolicy
      • RoutingKey
      • Row
      • RowSet
      • RowSetMetadata
      • SchemaChangedEventArgs
      • SchemaChangedEventArgs.Kind
      • SchemaChangedEventHandler
      • ServerErrorException
      • Session
      • SetColumnInfo
      • SimpleStatement
      • SocketOptions
      • SSLOptions
      • Statement
      • SyntaxError
      • TableColumn
      • TableMetadata
      • TableOptions
      • TimeUuid
      • TokenAwarePolicy
      • ToManyConnectionsPerHost
      • TraceRetrievalException
      • TruncateException
      • TupleColumnInfo
      • TypeAdapters
      • UdtColumnInfo
      • UdtMap
      • UdtMap<T>
      • UdtMappingDefinitions
      • UnauthorizedException
      • UnavailableException
      • Unset
      • WriteFailureException
      • WriteTimeoutException
    • Dse.AppMetrics
      • DriverAppMetricsOptions
    • Dse.AppMetrics.MetricTypes
      • IAppMetricsCounter
      • IAppMetricsGauge
      • IAppMetricsMeter
      • IAppMetricsMetric
      • IAppMetricsTimer
    • Dse.AppMetrics.MetricValues
      • IAppMetricsHistogramValue
      • IAppMetricsMeterValue
      • IAppMetricsMetricWithValue<T>
      • IAppMetricsTimerValue
    • Dse.Auth
      • DseGssapiAuthProvider
      • DsePlainTextAuthProvider
    • Dse.Auth.Sspi
      • SspiException
    • Dse.Data
      • CqlBatchTransaction
      • CqlCommand
      • CqlConnection
      • CqlDataAdapter
      • CqlParameter
      • CqlParameterCollection
      • CqlProviderFactory
      • CqlReader
    • Dse.Data.Linq
      • AllowFilteringAttribute
      • Batch
      • ClusteringKeyAttribute
      • ColumnAttribute
      • CompactStorageAttribute
      • CounterAttribute
      • CqlArgumentException
      • CqlCommand
      • CqlConditionalCommand<TEntity>
      • CqlDelete
      • CqlFunction
      • CqlInsert<TEntity>
      • CqlLinqNotSupportedException
      • CqlOperator
      • CqlQuery<TEntity>
      • CqlQueryBase<TEntity>
      • CqlQueryExtensions
      • CqlQuerySingleElement<TEntity>
      • CqlScalar<TEntity>
      • CqlToken
      • CqlUpdate
      • IgnoreAttribute
      • ITable
      • PartitionKeyAttribute
      • SecondaryIndexAttribute
      • SessionExtensions
      • StaticColumnAttribute
      • Table<TEntity>
      • TableAttribute
      • TableType
    • Dse.Geometry
      • GeometryBase
      • LineString
      • Point
      • Polygon
    • Dse.Graph
      • Edge
      • Element
      • GraphNode
      • GraphOptions
      • GraphResultSet
      • GraphStatement
      • IEdge
      • IElement
      • IGraphNode
      • IGraphStatement
      • IPath
      • IProperty
      • IVertex
      • IVertexProperty
      • Path
      • SimpleGraphStatement
      • Vertex
    • Dse.Mapping
      • AppliedInfo<T>
      • ColumnMap
      • Cql
      • CqlQueryOptions
      • IColumnDefinition
      • ICqlBatch
      • ICqlQueryAsyncClient
      • ICqlQueryClient
      • ICqlWriteAsyncClient
      • ICqlWriteClient
      • IMapper
      • IPage<T>
      • ITypeDefinition
      • Map<TPoco>
      • Mapper
      • MappingConfiguration
      • Mappings
      • SortOrder
    • Dse.Mapping.Attributes
      • ClusteringKeyAttribute
      • ColumnAttribute
      • CounterAttribute
      • FrozenAttribute
      • FrozenKeyAttribute
      • FrozenValueAttribute
      • IgnoreAttribute
      • PartitionKeyAttribute
      • SecondaryIndexAttribute
      • StaticColumnAttribute
      • TableAttribute
    • Dse.Mapping.TypeConversion
      • DefaultTypeConverter
      • EnumStringMapper<T>
      • NullableEnumStringMapper<T>
      • TypeConverter
    • Dse.Mapping.Utils
      • MemberInfoExtensions
    • Dse.Metrics
      • DriverMetricsOptions
      • IDriverMetrics
      • IMetric
      • IMetricsRegistry<TMetric>
      • NodeMetric
      • NodeMetric.Counters
      • NodeMetric.Gauges
      • NodeMetric.Meters
      • NodeMetric.Timers
      • SessionMetric
      • SessionMetric.Counters
      • SessionMetric.Gauges
      • SessionMetric.Meters
      • SessionMetric.Timers
    • Dse.Metrics.Abstractions
      • IDriverCounter
      • IDriverGauge
      • IDriverMeter
      • IDriverMetric
      • IDriverMetricsProvider
      • IDriverTimer
    • Dse.Search
      • DateRange
      • DateRangeBound
      • DateRangePrecision
    • Dse.Serialization
      • CustomTypeSerializer<T>
      • TypeSerializer
      • TypeSerializer<T>
      • TypeSerializerDefinitions
      • UdtSerializer

    Interface IDseSession

    Represents an ISession suitable for querying a DataStax Enterprise (DSE) Cluster.

    Session instances are designed to be long-lived, thread-safe and usually a single instance is enough per application.

    Inherited Members
    ISession.BinaryProtocolVersion
    ISession.Cluster
    ISession.IsDisposed
    ISession.Keyspace
    ISession.UserDefinedTypes
    ISession.SessionName
    ISession.BeginExecute(IStatement, AsyncCallback, Object)
    ISession.BeginExecute(String, ConsistencyLevel, AsyncCallback, Object)
    ISession.BeginPrepare(String, AsyncCallback, Object)
    ISession.ChangeKeyspace(String)
    ISession.CreateKeyspace(String, Dictionary<String, String>, Boolean)
    ISession.CreateKeyspaceIfNotExists(String, Dictionary<String, String>, Boolean)
    ISession.DeleteKeyspace(String)
    ISession.DeleteKeyspaceIfExists(String)
    ISession.EndExecute(IAsyncResult)
    ISession.EndPrepare(IAsyncResult)
    ISession.Execute(IStatement, String)
    ISession.Execute(IStatement)
    ISession.Execute(String)
    ISession.Execute(String, String)
    ISession.Execute(String, ConsistencyLevel)
    ISession.Execute(String, Int32)
    ISession.ExecuteAsync(IStatement)
    ISession.ExecuteAsync(IStatement, String)
    ISession.Prepare(String)
    ISession.Prepare(String, IDictionary<String, Byte[]>)
    ISession.Prepare(String, String)
    ISession.Prepare(String, String, IDictionary<String, Byte[]>)
    ISession.PrepareAsync(String)
    ISession.PrepareAsync(String, IDictionary<String, Byte[]>)
    ISession.PrepareAsync(String, String)
    ISession.PrepareAsync(String, String, IDictionary<String, Byte[]>)
    ISession.GetMetrics()
    ISession.WaitForSchemaAgreement(RowSet)
    ISession.WaitForSchemaAgreement(IPEndPoint)
    System.IDisposable.Dispose()
    Namespace: Dse
    Assembly: Dse.dll
    Syntax
    public interface IDseSession : ISession, IDisposable

    Methods

    ExecuteGraph(IGraphStatement)

    Executes a graph statement.

    Declaration
    GraphResultSet ExecuteGraph(IGraphStatement statement)
    Parameters
    Type Name Description
    IGraphStatement statement

    The graph statement containing the query

    Returns
    Type Description
    GraphResultSet
    Examples
    GraphResultSet rs = session.ExecuteGraph(new SimpleGraphStatement("g.V()"));

    ExecuteGraph(IGraphStatement, String)

    Executes a graph statement with the provided execution profile. The execution profile must have been added previously to the DseCluster using WithExecutionProfiles(Action<IExecutionProfileOptions>).

    Declaration
    GraphResultSet ExecuteGraph(IGraphStatement statement, string executionProfileName)
    Parameters
    Type Name Description
    IGraphStatement statement

    The graph statement containing the query

    System.String executionProfileName

    The graph execution profile name to use while executing this statement.

    Returns
    Type Description
    GraphResultSet
    Examples
    GraphResultSet rs = session.ExecuteGraph(new SimpleGraphStatement("g.V()"), "graphProfile");

    ExecuteGraphAsync(IGraphStatement)

    Executes a graph statement.

    Declaration
    Task<GraphResultSet> ExecuteGraphAsync(IGraphStatement statement)
    Parameters
    Type Name Description
    IGraphStatement statement

    The graph statement containing the query

    Returns
    Type Description
    System.Threading.Tasks.Task<GraphResultSet>
    Examples
    Task<GraphResultSet$gt; task = session.ExecuteGraphAsync(new SimpleGraphStatement("g.V()"));

    ExecuteGraphAsync(IGraphStatement, String)

    Executes a graph statement asynchronously with the provided graph execution profile. The graph execution profile must have been added previously to the DseCluster using WithExecutionProfiles(Action<IExecutionProfileOptions>).

    Declaration
    Task<GraphResultSet> ExecuteGraphAsync(IGraphStatement statement, string executionProfileName)
    Parameters
    Type Name Description
    IGraphStatement statement

    The graph statement containing the query

    System.String executionProfileName

    The graph execution profile name to use while executing this statement.

    Returns
    Type Description
    System.Threading.Tasks.Task<GraphResultSet>
    Examples
    Task<GraphResultSet$gt; task = session.ExecuteGraphAsync(new SimpleGraphStatement("g.V()"), "graphProfile");

    Extension Methods

    Extensions.GetState(ISession)
    SessionExtensions.GetTable<TEntity>(ISession, String, String)
    SessionExtensions.CreateBatch(ISession)
    SessionExtensions.CreateBatch(ISession, BatchType)
    Back to top © DataStax, All rights reserved.