• DataStax C# Driver for Apache Cassandra API Documentation
Search Results for

    Show / Hide Table of Contents
    • Cassandra
      • AesColumnEncryptionPolicy
      • AesColumnEncryptionPolicy.AesKeyAndIV
      • AggregateMetadata
      • AlreadyExistsException
      • AtomicMonotonicTimestampGenerator
      • AtomicMonotonicWinApiTimestampGenerator
      • AuthenticationException
      • BaseColumnEncryptionPolicy<TKey>
      • BaseColumnEncryptionPolicy<TKey>.ColMetadataKey
      • BatchStatement
      • BatchType
      • BigIntegerTypeAdapter
      • BoundStatement
      • Builder
      • BusyPoolException
      • CassandraConnectionStringBuilder
      • ClientOptions
      • Cluster
      • ColumnDesc
      • ColumnEncryptionInvalidTypeError
      • ColumnEncryptionMetadata
      • ColumnTypeCode
      • CompressionType
      • Configuration
      • ConsistencyLevel
      • ConstantReconnectionPolicy
      • ConstantSpeculativeExecutionPolicy
      • CqlColumn
      • CqlVector<T>
      • CustomColumnInfo
      • DCAwareRoundRobinPolicy
      • DataCollectionMetadata
      • DataCollectionMetadata.SortOrder
      • DecimalTypeAdapter
      • DefaultLoadBalancingPolicy
      • DefaultRetryPolicy
      • Diagnostics
      • DowngradingConsistencyRetryPolicy
      • DriverException
      • DriverInternalError
      • Duration
      • DynamicCompositeTypeAdapter
      • EC2MultiRegionTranslator
      • EncryptedValue
      • ExecutionException
      • ExecutionInfo
      • ExponentialReconnectionPolicy
      • Extensions
      • FallthroughRetryPolicy
      • FixedReconnectionPolicy
      • FunctionFailureException
      • FunctionMetadata
      • GraphProtocol
      • Host
      • HostDistance
      • HostsEventArgs
      • HostsEventArgs.Kind
      • HostsEventHandler
      • IAddressTranslator
      • IAuthProvider
      • IAuthenticator
      • ICluster
      • IColumnEncryptionPolicy
      • IColumnInfo
      • IExecutionProfile
      • IExecutionProfileBuilder
      • IExecutionProfileOptions
      • IExtendedRetryPolicy
      • IFrameCompressor
      • IInitializer
      • ILoadBalancingPolicy
      • IReconnectionPolicy
      • IReconnectionSchedule
      • IRequestTracker
      • IRetryPolicy
      • ISession
      • ISessionState
      • ISpeculativeExecutionPlan
      • ISpeculativeExecutionPolicy
      • IStatement
      • ITimestampGenerator
      • ITypeAdapter
      • IdempotenceAwareRetryPolicy
      • IndexMetadata
      • IndexMetadata.IndexKind
      • InitFatalErrorException
      • InvalidConfigurationInQueryException
      • InvalidQueryException
      • InvalidTypeException
      • IsBootstrappingException
      • KeyType
      • KeyspaceMetadata
      • ListColumnInfo
      • LocalDate
      • LocalTime
      • Logger
      • LoggingRetryPolicy
      • MapColumnInfo
      • MaterializedViewMetadata
      • Metadata
      • MetadataSyncOptions
      • MetricsExtensions
      • MonitorReportingOptions
      • NoHostAvailableException
      • NoSpeculativeExecutionPolicy
      • NodeRequestInfo
      • NoneAuthProvider
      • NullTypeAdapter
      • OperationTimedOutException
      • OverloadedException
      • PlainTextAuthProvider
      • Policies
      • PoolingOptions
      • PrepareRequest
      • 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
      • SSLOptions
      • SchemaChangedEventArgs
      • SchemaChangedEventArgs.Kind
      • SchemaChangedEventHandler
      • ServerErrorException
      • Session
      • SessionRequestInfo
      • SetColumnInfo
      • SimpleStatement
      • SocketOptions
      • Statement
      • SyntaxError
      • TableColumn
      • TableMetadata
      • TableOptions
      • TimeUuid
      • ToManyConnectionsPerHost
      • TokenAwarePolicy
      • TraceRetrievalException
      • TruncateException
      • TupleColumnInfo
      • TypeAdapters
      • UdtColumnInfo
      • UdtMap
      • UdtMap<T>
      • UdtMappingDefinitions
      • UnauthorizedException
      • UnavailableException
      • Unset
      • VectorColumnInfo
      • WriteFailureException
      • WriteTimeoutException
    • Cassandra.AppMetrics
      • DriverAppMetricsOptions
    • Cassandra.AppMetrics.MetricTypes
      • IAppMetricsCounter
      • IAppMetricsGauge
      • IAppMetricsMeter
      • IAppMetricsMetric
      • IAppMetricsTimer
    • Cassandra.AppMetrics.MetricValues
      • IAppMetricsHistogramValue
      • IAppMetricsMeterValue
      • IAppMetricsMetricWithValue<T>
      • IAppMetricsTimerValue
    • Cassandra.Data
      • CqlBatchTransaction
      • CqlCommand
      • CqlConnection
      • CqlDataAdapter
      • CqlParameter
      • CqlParameterCollection
      • CqlProviderFactory
      • CqlReader
    • Cassandra.Data.Linq
      • AllowFilteringAttribute
      • Batch
      • ClusteringKeyAttribute
      • ColumnAttribute
      • CompactStorageAttribute
      • CounterAttribute
      • CqlArgumentException
      • CqlCommand
      • CqlConditionalCommand<TEntity>
      • CqlDelete
      • CqlFunction
      • CqlInsert<TEntity>
      • CqlLinqNotSupportedException
      • CqlOperator
      • CqlQueryBase<TEntity>
      • CqlQueryExtensions
      • CqlQuerySingleElement<TEntity>
      • CqlQuery<TEntity>
      • CqlScalar<TEntity>
      • CqlToken
      • CqlUpdate
      • ITable
      • IgnoreAttribute
      • PartitionKeyAttribute
      • SecondaryIndexAttribute
      • SessionExtensions
      • StaticColumnAttribute
      • TableAttribute
      • TableType
      • Table<TEntity>
    • Cassandra.DataStax.Auth
      • DseGssapiAuthProvider
      • DsePlainTextAuthProvider
    • Cassandra.DataStax.Auth.Sspi
      • SspiException
    • Cassandra.DataStax.Graph
      • Direction
      • Edge
      • Element
      • ElementMap
      • EnumWrapper
      • FluentGraphStatement
      • GraphNode
      • GraphOptions
      • GraphResultSet
      • GraphStatement
      • IEdge
      • IElement
      • IGraphNode
      • IGraphStatement
      • IPath
      • IProperty
      • IPropertyWithElement
      • IVertex
      • IVertexProperty
      • Path
      • SimpleGraphStatement
      • TEnum
      • Traverser
      • Vertex
    • Cassandra.DataStax.Graph.Internal
      • IGraphSONDeserializer
      • IGraphSONReader
      • IGraphSONSerializer
      • IGraphSONWriter
    • Cassandra.DataStax.Search
      • DateRange
      • DateRangeBound
      • DateRangePrecision
    • Cassandra.Geometry
      • GeometryBase
      • LineString
      • Point
      • Polygon
    • Cassandra.Mapping
      • AppliedInfo<T>
      • ColumnMap
      • Cql
      • CqlQueryOptions
      • IColumnDefinition
      • ICqlBatch
      • ICqlQueryAsyncClient
      • ICqlQueryClient
      • ICqlWriteAsyncClient
      • ICqlWriteClient
      • IMapper
      • IPage<T>
      • ITypeDefinition
      • Map<TPoco>
      • Mapper
      • MappingConfiguration
      • Mappings
      • PrimaryKeyAttribute
      • SortOrder
      • TableNameAttribute
    • Cassandra.Mapping.Attributes
      • ClusteringKeyAttribute
      • ColumnAttribute
      • CounterAttribute
      • FrozenAttribute
      • FrozenKeyAttribute
      • FrozenValueAttribute
      • IgnoreAttribute
      • PartitionKeyAttribute
      • SecondaryIndexAttribute
      • StaticColumnAttribute
      • TableAttribute
    • Cassandra.Mapping.TypeConversion
      • DefaultTypeConverter
      • EnumStringMapper<T>
      • NullableEnumStringMapper<T>
      • TypeConverter
    • Cassandra.Mapping.Utils
      • MemberInfoExtensions
    • Cassandra.Metrics
      • DriverMetricsOptions
      • IDriverMetrics
      • IMetric
      • IMetricsRegistry<TMetric>
      • NodeMetric
      • NodeMetric.Counters
      • NodeMetric.Gauges
      • NodeMetric.Meters
      • NodeMetric.Timers
      • SessionMetric
      • SessionMetric.Counters
      • SessionMetric.Gauges
      • SessionMetric.Meters
      • SessionMetric.Timers
    • Cassandra.Metrics.Abstractions
      • IDriverCounter
      • IDriverGauge
      • IDriverMeter
      • IDriverMetric
      • IDriverMetricsProvider
      • IDriverTimer
    • Cassandra.OpenTelemetry
      • BuilderExtensions
      • CassandraActivitySourceHelper
      • CassandraInstrumentationOptions
      • OpenTelemetryRequestTracker
    • Cassandra.Serialization
      • CustomTypeSerializer<T>
      • TypeSerializer
      • TypeSerializerDefinitions
      • TypeSerializer<T>
      • UdtSerializer
    • Cassandra.Serialization.Primitive
      • DecimalSerializer

    Class GraphNode

    Represents an item of a graph query result, it can be a vertex, an edge, a path or an scalar value.

    Inheritance
    object
    DynamicObject
    GraphNode
    Implements
    IDynamicMetaObjectProvider
    IEquatable<GraphNode>
    IGraphNode
    IEquatable<IGraphNode>
    ISerializable
    Inherited Members
    DynamicObject.GetDynamicMemberNames()
    DynamicObject.GetMetaObject(Expression)
    DynamicObject.TryBinaryOperation(BinaryOperationBinder, object, out object)
    DynamicObject.TryCreateInstance(CreateInstanceBinder, object[], out object)
    DynamicObject.TryDeleteIndex(DeleteIndexBinder, object[])
    DynamicObject.TryDeleteMember(DeleteMemberBinder)
    DynamicObject.TryGetIndex(GetIndexBinder, object[], out object)
    DynamicObject.TryInvoke(InvokeBinder, object[], out object)
    DynamicObject.TryInvokeMember(InvokeMemberBinder, object[], out object)
    DynamicObject.TrySetIndex(SetIndexBinder, object[], object)
    DynamicObject.TrySetMember(SetMemberBinder, object)
    DynamicObject.TryUnaryOperation(UnaryOperationBinder, out object)
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Cassandra.DataStax.Graph
    Assembly: Cassandra.dll
    Syntax
    [Serializable]
    [JsonConverter(typeof(GraphNodeConverter))]
    public class GraphNode : DynamicObject, IDynamicMetaObjectProvider, IEquatable<GraphNode>, IGraphNode, IEquatable<IGraphNode>, ISerializable

    Constructors

    GraphNode(SerializationInfo, StreamingContext)

    Creates a new instance of GraphNode using a serialization information.

    Declaration
    protected GraphNode(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    SerializationInfo info
    StreamingContext context

    GraphNode(string)

    Creates a new instance of GraphNode.

    Declaration
    public GraphNode(string json)
    Parameters
    Type Name Description
    string json

    The graph string json with the form: "{"result": ...}".

    Properties

    IsArray

    Returns true if the underlying value is an array.

    Declaration
    public bool IsArray { get; }
    Property Value
    Type Description
    bool

    IsObjectTree

    Returns true if the underlying value is an object tree.

    Declaration
    public bool IsObjectTree { get; }
    Property Value
    Type Description
    bool

    IsScalar

    Returns true if the underlying value is a scalar value (string, double, boolean, ...).

    Declaration
    public bool IsScalar { get; }
    Property Value
    Type Description
    bool

    Methods

    Equals(GraphNode)

    Returns true if the value represented by this instance is the same.

    Declaration
    public bool Equals(GraphNode other)
    Parameters
    Type Name Description
    GraphNode other
    Returns
    Type Description
    bool

    Equals(IGraphNode)

    Declaration
    public bool Equals(IGraphNode other)
    Parameters
    Type Name Description
    IGraphNode other
    Returns
    Type Description
    bool

    Equals(object)

    Returns true if the value represented by this instance is the same.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj
    Returns
    Type Description
    bool
    Overrides
    object.Equals(object)

    GetHashCode()

    Gets the hash code for this instance, based on its value.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int
    Overrides
    object.GetHashCode()

    GetObjectData(SerializationInfo, StreamingContext)

    Declaration
    public void GetObjectData(SerializationInfo info, StreamingContext context)
    Parameters
    Type Name Description
    SerializationInfo info
    StreamingContext context

    GetProperties()

    Gets the a dictionary of properties of this node.

    Declaration
    public IDictionary<string, GraphNode> GetProperties()
    Returns
    Type Description
    IDictionary<string, GraphNode>

    GetRaw()

    Gets the raw data represented by this instance.

    Raw internal representation might be different depending on the graph serialization format and it is subject to change without any prior notice.

    Declaration
    public dynamic GetRaw()
    Returns
    Type Description
    dynamic

    Get<T>(string)

    Gets the typed value of a property of the result.

    Declaration
    public T Get<T>(string propertyName)
    Parameters
    Type Name Description
    string propertyName

    Name of the property.

    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T

    Type of the property. Use dynamic for object trees.

    Exceptions
    Type Condition
    NotSupportedException

    Throws NotSupportedException when the target type is not supported

    HasProperty(string)

    Returns true if the property is defined in this instance.

    Declaration
    public bool HasProperty(string name)
    Parameters
    Type Name Description
    string name
    Returns
    Type Description
    bool
    Exceptions
    Type Condition
    InvalidOperationException

    When the underlying value is not an object tree

    To(Type)

    Returns the representation of the GraphNode as an instance of the type provided.

    Declaration
    public object To(Type type)
    Parameters
    Type Name Description
    Type type
    Returns
    Type Description
    object
    Exceptions
    Type Condition
    NotSupportedException

    Throws NotSupportedException when the target type is not supported

    ToArray()

    Converts the instance into an array when the internal representation is a json array.

    Declaration
    public GraphNode[] ToArray()
    Returns
    Type Description
    GraphNode[]

    ToBoolean()

    Returns the representation of the result as a boolean.

    Declaration
    public bool ToBoolean()
    Returns
    Type Description
    bool
    Exceptions
    Type Condition
    InvalidOperationException

    It throws an InvalidOperationException when the internal value is not an scalar.

    InvalidCastException

    When the scalar value is not convertible to target type.

    ToDouble()

    Returns the representation of the result as a double.

    Declaration
    public double ToDouble()
    Returns
    Type Description
    double
    Exceptions
    Type Condition
    InvalidOperationException

    It throws an InvalidOperationException when the internal value is not an scalar.

    InvalidCastException

    When the scalar value is not convertible to target type.

    ToEdge()

    Returns an edge representation of the current instance.

    This method is maintained for backward compatibity. It's recommended that you use To<T>() instead, providing IEdge as type parameter

    Declaration
    public Edge ToEdge()
    Returns
    Type Description
    Edge

    ToFloat()

    Returns the representation of the result as a float.

    Declaration
    public float ToFloat()
    Returns
    Type Description
    float
    Exceptions
    Type Condition
    InvalidOperationException

    It throws an InvalidOperationException when the internal value is not an scalar.

    InvalidCastException

    When the scalar value is not convertible to target type.

    ToIArray()

    Converts the instance into an array when the internal representation is a json array.

    Declaration
    public IGraphNode[] ToIArray()
    Returns
    Type Description
    IGraphNode[]

    ToInt32()

    Returns the representation of the result as an int.

    Declaration
    public int ToInt32()
    Returns
    Type Description
    int
    Exceptions
    Type Condition
    InvalidOperationException

    It throws an InvalidOperationException when the internal value is not an scalar.

    InvalidCastException

    When the scalar value is not convertible to target type.

    ToPath()

    Returns a Path representation of the current instance.

    This method is maintained for backward compatibity. It's recommended that you use To<T>() instead, providing IPath as type parameter.

    Declaration
    public Path ToPath()
    Returns
    Type Description
    Path

    ToString()

    Returns the json representation of the result.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    object.ToString()

    ToVertex()

    Returns a vertex representation of the current instance.

    This method is maintained for backward compatibity. It's recommended that you use To<T>() instead, providing IVertex as type parameter.

    Declaration
    public Vertex ToVertex()
    Returns
    Type Description
    Vertex

    To<T>()

    Returns the representation of the GraphNode as an instance of type T.

    Declaration
    public T To<T>()
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T

    The type to which the current instance is going to be converted to.

    Exceptions
    Type Condition
    NotSupportedException

    Throws NotSupportedException when the target type is not supported

    TryConvert(ConvertBinder, out object)

    Declaration
    public override bool TryConvert(ConvertBinder binder, out object result)
    Parameters
    Type Name Description
    ConvertBinder binder
    object result
    Returns
    Type Description
    bool
    Overrides
    DynamicObject.TryConvert(ConvertBinder, out object)

    TryGetMember(GetMemberBinder, out object)

    Provides the implementation for operations that get member values.

    Declaration
    public override bool TryGetMember(GetMemberBinder binder, out object result)
    Parameters
    Type Name Description
    GetMemberBinder binder
    object result
    Returns
    Type Description
    bool
    Overrides
    DynamicObject.TryGetMember(GetMemberBinder, out object)

    Operators

    operator ==(GraphNode, GraphNode)

    Returns true if the value represented by the instances are the same.

    Declaration
    public static bool operator ==(GraphNode result1, GraphNode result2)
    Parameters
    Type Name Description
    GraphNode result1
    GraphNode result2
    Returns
    Type Description
    bool

    implicit operator Edge(GraphNode)

    Converts this instance to an Edge instance.

    Declaration
    public static implicit operator Edge(GraphNode b)
    Parameters
    Type Name Description
    GraphNode b
    Returns
    Type Description
    Edge

    implicit operator Path(GraphNode)

    Converts this instance to a Path instance.

    Declaration
    public static implicit operator Path(GraphNode b)
    Parameters
    Type Name Description
    GraphNode b
    Returns
    Type Description
    Path

    implicit operator Vertex(GraphNode)

    Converts this instance to a Vertex instance.

    Declaration
    public static implicit operator Vertex(GraphNode b)
    Parameters
    Type Name Description
    GraphNode b
    Returns
    Type Description
    Vertex

    implicit operator bool(GraphNode)

    Converts this instance to a boolean representation.

    Declaration
    public static implicit operator bool(GraphNode b)
    Parameters
    Type Name Description
    GraphNode b
    Returns
    Type Description
    bool

    implicit operator double(GraphNode)

    Converts this instance to a long representation.

    Declaration
    public static implicit operator double(GraphNode b)
    Parameters
    Type Name Description
    GraphNode b
    Returns
    Type Description
    double

    implicit operator short(GraphNode)

    Converts this instance to a short representation.

    Declaration
    public static implicit operator short(GraphNode b)
    Parameters
    Type Name Description
    GraphNode b
    Returns
    Type Description
    short

    implicit operator int(GraphNode)

    Converts this instance to an int representation.

    Declaration
    public static implicit operator int(GraphNode b)
    Parameters
    Type Name Description
    GraphNode b
    Returns
    Type Description
    int

    implicit operator long(GraphNode)

    Converts this instance to a long representation.

    Declaration
    public static implicit operator long(GraphNode b)
    Parameters
    Type Name Description
    GraphNode b
    Returns
    Type Description
    long

    implicit operator float(GraphNode)

    Converts this instance to a float representation.

    Declaration
    public static implicit operator float(GraphNode b)
    Parameters
    Type Name Description
    GraphNode b
    Returns
    Type Description
    float

    implicit operator string(GraphNode)

    Converts this instance to a string representation.

    Declaration
    public static implicit operator string(GraphNode b)
    Parameters
    Type Name Description
    GraphNode b
    Returns
    Type Description
    string

    operator !=(GraphNode, GraphNode)

    Compares the values for inequality.

    Declaration
    public static bool operator !=(GraphNode result1, GraphNode result2)
    Parameters
    Type Name Description
    GraphNode result1
    GraphNode result2
    Returns
    Type Description
    bool

    Implements

    IDynamicMetaObjectProvider
    IEquatable<T>
    IGraphNode
    IEquatable<T>
    ISerializable
    Back to top © DataStax, All rights reserved.