> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.Records.RecordValue > kinetica.Records.RecordValue — Kinetica C# API

A typed value that can be stored in a GenericRecord. More...

Inherits IEquatable, and IEquatable.

Public Member Functions
int?  AsInt ()
  Gets the value as a 32-bit integer.
 
long?  AsLong ()
  Gets the value as a 64-bit integer.
 
float?  AsFloat ()
  Gets the value as a 32-bit float.
 
double?  AsDouble ()
  Gets the value as a 64-bit double.
 
string?  AsString ()
  Gets the value as a string.
 
byte?\[]  AsBytes ()
  Gets the value as a byte array.
 
bool?  AsBool ()
  Gets the value as a boolean (from int).
 
bool  TryGetInt (out int value)
  Tries to get the value as an integer.
 
bool  TryGetLong (out long value)
  Tries to get the value as a long.
 
bool  TryGetFloat (out float value)
  Tries to get the value as a float.
 
bool  TryGetDouble (out double value)
  Tries to get the value as a double.
 
bool  TryGetString (out string? value)
  Tries to get the value as a string.
 
bool  TryGetBytes (out byte\[]? value)
  Tries to get the value as bytes.
 
bool  TryGetBool (out bool value)
  Tries to get the value as a boolean.
 
bool  Equals (RecordValue other)
 
override bool  Equals (object? obj)
 
override int  GetHashCode ()
 
override string  ToString ()
 
int?  AsInt ()
  Gets the value as a 32-bit integer.
 
long?  AsLong ()
  Gets the value as a 64-bit integer.
 
float?  AsFloat ()
  Gets the value as a 32-bit float.
 
double?  AsDouble ()
  Gets the value as a 64-bit double.
 
string?  AsString ()
  Gets the value as a string.
 
byte?\[]  AsBytes ()
  Gets the value as a byte array.
 
bool?  AsBool ()
  Gets the value as a boolean (from int).
 
bool  TryGetInt (out int value)
  Tries to get the value as an integer.
 
bool  TryGetLong (out long value)
  Tries to get the value as a long.
 
bool  TryGetFloat (out float value)
  Tries to get the value as a float.
 
bool  TryGetDouble (out double value)
  Tries to get the value as a double.
 
bool  TryGetString (out string? value)
  Tries to get the value as a string.
 
bool  TryGetBytes (out byte\[]? value)
  Tries to get the value as bytes.
 
bool  TryGetBool (out bool value)
  Tries to get the value as a boolean.
 
bool  Equals (RecordValue other)
 
override bool  Equals (object? obj)
 
override int  GetHashCode ()
 
override string  ToString ()
 

Static Public Member Functions
static RecordValue  Null ()
  Creates a null record value.
 
static RecordValue  Int (int value)
  Creates a 32-bit integer record value.
 
static RecordValue  Long (long value)
  Creates a 64-bit integer record value.
 
static RecordValue  Float (float value)
  Creates a 32-bit float record value.
 
static RecordValue  Double (double value)
  Creates a 64-bit double record value.
 
static RecordValue  String (string value)
  Creates a string record value.
 
static RecordValue  Bytes (byte\[] value)
  Creates a bytes record value.
 
static RecordValue  Boolean (bool value)
  Creates a boolean record value (stored as int).
 
static implicit  operator RecordValue (int value)
  Implicitly converts an int value to a RecordValue.
 
static implicit  operator RecordValue (long value)
  Implicitly converts a long value to a RecordValue.
 
static implicit  operator RecordValue (float value)
  Implicitly converts a float value to a RecordValue.
 
static implicit  operator RecordValue (double value)
  Implicitly converts a double value to a RecordValue.
 
static implicit  operator RecordValue (string value)
  Implicitly converts a string value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (byte\[] value)
  Implicitly converts a byte\[] value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (bool value)
  Implicitly converts a bool value to a RecordValue.
 
static implicit  operator RecordValue (int? value)
  Implicitly converts an int? value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (long? value)
  Implicitly converts a long? value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (float? value)
  Implicitly converts a float? value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (double? value)
  Implicitly converts a double? value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (bool? value)
  Implicitly converts a bool? value to a RecordValue. A null input becomes a null record value.
 
static bool  operator== (RecordValue left, RecordValue right)
  Determines whether two RecordValue instances are equal.
 
static bool  operator!= (RecordValue left, RecordValue right)
  Determines whether two RecordValue instances are not equal.
 
static RecordValue  Null ()
  Creates a null record value.
 
static RecordValue  Int (int value)
  Creates a 32-bit integer record value.
 
static RecordValue  Long (long value)
  Creates a 64-bit integer record value.
 
static RecordValue  Float (float value)
  Creates a 32-bit float record value.
 
static RecordValue  Double (double value)
  Creates a 64-bit double record value.
 
static RecordValue  String (string value)
  Creates a string record value.
 
static RecordValue  Bytes (byte\[] value)
  Creates a bytes record value.
 
static RecordValue  Boolean (bool value)
  Creates a boolean record value (stored as int).
 
static implicit  operator RecordValue (int value)
  Implicitly converts an int value to a RecordValue.
 
static implicit  operator RecordValue (long value)
  Implicitly converts a long value to a RecordValue.
 
static implicit  operator RecordValue (float value)
  Implicitly converts a float value to a RecordValue.
 
static implicit  operator RecordValue (double value)
  Implicitly converts a double value to a RecordValue.
 
static implicit  operator RecordValue (string value)
  Implicitly converts a string value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (byte\[] value)
  Implicitly converts a byte\[] value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (bool value)
  Implicitly converts a bool value to a RecordValue.
 
static implicit  operator RecordValue (int? value)
  Implicitly converts an int? value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (long? value)
  Implicitly converts a long? value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (float? value)
  Implicitly converts a float? value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (double? value)
  Implicitly converts a double? value to a RecordValue. A null input becomes a null record value.
 
static implicit  operator RecordValue (bool? value)
  Implicitly converts a bool? value to a RecordValue. A null input becomes a null record value.
 
static bool  operator== (RecordValue left, RecordValue right)
  Determines whether two RecordValue instances are equal.
 
static bool  operator!= (RecordValue left, RecordValue right)
  Determines whether two RecordValue instances are not equal.
 

Properties
RecordValueType  Type \[get]
  Gets the type of this record value.
 
bool  IsNull \[get]
  Returns true if this value is null.
 

Detailed Description

A typed value that can be stored in a GenericRecord.

Equivalent to Rust's RecordValue enum.

This struct provides type-safe storage for record field values.

Definition at line 33 of file RecordValue.cs.

Member Function Documentation

◆ AsBool() \[1/2]

bool? kinetica.Records.RecordValue.AsBool ( )
inline

Gets the value as a boolean (from int).

Definition at line 191 of file RecordValue.cs.

◆ AsBool() \[2/2]

bool? kinetica.Records.RecordValue.AsBool ( )
inline

Gets the value as a boolean (from int).

Definition at line 191 of file RecordValue.cs.

◆ AsBytes() \[1/2]

byte?\[] kinetica.Records.RecordValue.AsBytes ( )
inline

Gets the value as a byte array.

Definition at line 179 of file RecordValue.cs.

◆ AsBytes() \[2/2]

byte?\[] kinetica.Records.RecordValue.AsBytes ( )
inline

Gets the value as a byte array.

Definition at line 179 of file RecordValue.cs.

◆ AsDouble() \[1/2]

double? kinetica.Records.RecordValue.AsDouble ( )
inline

Gets the value as a 64-bit double.

Definition at line 154 of file RecordValue.cs.

◆ AsDouble() \[2/2]

double? kinetica.Records.RecordValue.AsDouble ( )
inline

Gets the value as a 64-bit double.

Definition at line 154 of file RecordValue.cs.

◆ AsFloat() \[1/2]

float? kinetica.Records.RecordValue.AsFloat ( )
inline

Gets the value as a 32-bit float.

Definition at line 142 of file RecordValue.cs.

◆ AsFloat() \[2/2]

float? kinetica.Records.RecordValue.AsFloat ( )
inline

Gets the value as a 32-bit float.

Definition at line 142 of file RecordValue.cs.

◆ AsInt() \[1/2]

int? kinetica.Records.RecordValue.AsInt ( )
inline

Gets the value as a 32-bit integer.

Definition at line 117 of file RecordValue.cs.

◆ AsInt() \[2/2]

int? kinetica.Records.RecordValue.AsInt ( )
inline

Gets the value as a 32-bit integer.

Definition at line 117 of file RecordValue.cs.

◆ AsLong() \[1/2]

long? kinetica.Records.RecordValue.AsLong ( )
inline

Gets the value as a 64-bit integer.

Definition at line 129 of file RecordValue.cs.

◆ AsLong() \[2/2]

long? kinetica.Records.RecordValue.AsLong ( )
inline

Gets the value as a 64-bit integer.

Definition at line 129 of file RecordValue.cs.

◆ AsString() \[1/2]

string? kinetica.Records.RecordValue.AsString ( )
inline

Gets the value as a string.

Definition at line 167 of file RecordValue.cs.

◆ AsString() \[2/2]

string? kinetica.Records.RecordValue.AsString ( )
inline

Gets the value as a string.

Definition at line 167 of file RecordValue.cs.

◆ Boolean() \[1/2]

static RecordValue kinetica.Records.RecordValue.Boolean ( bool value )
static

Creates a boolean record value (stored as int).

◆ Boolean() \[2/2]

static RecordValue kinetica.Records.RecordValue.Boolean ( bool value )
static

Creates a boolean record value (stored as int).

◆ Bytes() \[1/2]

static RecordValue kinetica.Records.RecordValue.Bytes ( byte\[] value )
static

Creates a bytes record value.

◆ Bytes() \[2/2]

static RecordValue kinetica.Records.RecordValue.Bytes ( byte\[] value )
static

Creates a bytes record value.

◆ Double() \[1/2]

static RecordValue kinetica.Records.RecordValue.Double ( double value )
static

Creates a 64-bit double record value.

◆ Double() \[2/2]

static RecordValue kinetica.Records.RecordValue.Double ( double value )
static

Creates a 64-bit double record value.

◆ Equals() \[1/4]

override bool kinetica.Records.RecordValue.Equals ( object? obj )

◆ Equals() \[2/4]

override bool kinetica.Records.RecordValue.Equals ( object? obj )

◆ Equals() \[3/4]

bool kinetica.Records.RecordValue.Equals ( RecordValue other )
inline

Definition at line 304 of file RecordValue.cs.

◆ Equals() \[4/4]

bool kinetica.Records.RecordValue.Equals ( RecordValue other )
inline

Definition at line 304 of file RecordValue.cs.

◆ Float() \[1/2]

static RecordValue kinetica.Records.RecordValue.Float ( float value )
static

Creates a 32-bit float record value.

◆ Float() \[2/2]

static RecordValue kinetica.Records.RecordValue.Float ( float value )
static

Creates a 32-bit float record value.

◆ GetHashCode() \[1/2]

override int kinetica.Records.RecordValue.GetHashCode ( )
inline

Definition at line 335 of file RecordValue.cs.

◆ GetHashCode() \[2/2]

override int kinetica.Records.RecordValue.GetHashCode ( )
inline

Definition at line 335 of file RecordValue.cs.

◆ Int() \[1/2]

static RecordValue kinetica.Records.RecordValue.Int ( int value )
static

Creates a 32-bit integer record value.

◆ Int() \[2/2]

static RecordValue kinetica.Records.RecordValue.Int ( int value )
static

Creates a 32-bit integer record value.

◆ Long() \[1/2]

static RecordValue kinetica.Records.RecordValue.Long ( long value )
static

Creates a 64-bit integer record value.

◆ Long() \[2/2]

static RecordValue kinetica.Records.RecordValue.Long ( long value )
static

Creates a 64-bit integer record value.

◆ Null() \[1/2]

static RecordValue kinetica.Records.RecordValue.Null ( )
static

Creates a null record value.

◆ Null() \[2/2]

static RecordValue kinetica.Records.RecordValue.Null ( )
static

Creates a null record value.

◆ operator RecordValue() \[1/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( bool value )
static

Implicitly converts a bool value to a RecordValue.

◆ operator RecordValue() \[2/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( bool value )
static

Implicitly converts a bool value to a RecordValue.

◆ operator RecordValue() \[3/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( bool? value )
static

Implicitly converts a bool? value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[4/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( bool? value )
static

Implicitly converts a bool? value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[5/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( byte\[] value )
static

Implicitly converts a byte\[] value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[6/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( byte\[] value )
static

Implicitly converts a byte\[] value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[7/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( double value )
static

Implicitly converts a double value to a RecordValue.

◆ operator RecordValue() \[8/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( double value )
static

Implicitly converts a double value to a RecordValue.

◆ operator RecordValue() \[9/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( double? value )
static

Implicitly converts a double? value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[10/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( double? value )
static

Implicitly converts a double? value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[11/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( float value )
static

Implicitly converts a float value to a RecordValue.

◆ operator RecordValue() \[12/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( float value )
static

Implicitly converts a float value to a RecordValue.

◆ operator RecordValue() \[13/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( float? value )
static

Implicitly converts a float? value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[14/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( float? value )
static

Implicitly converts a float? value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[15/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( int value )
static

Implicitly converts an int value to a RecordValue.

◆ operator RecordValue() \[16/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( int value )
static

Implicitly converts an int value to a RecordValue.

◆ operator RecordValue() \[17/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( int? value )
static

Implicitly converts an int? value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[18/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( int? value )
static

Implicitly converts an int? value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[19/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( long value )
static

Implicitly converts a long value to a RecordValue.

◆ operator RecordValue() \[20/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( long value )
static

Implicitly converts a long value to a RecordValue.

◆ operator RecordValue() \[21/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( long? value )
static

Implicitly converts a long? value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[22/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( long? value )
static

Implicitly converts a long? value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[23/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( string value )
static

Implicitly converts a string value to a RecordValue. A null input becomes a null record value.

◆ operator RecordValue() \[24/24]

static implicit kinetica.Records.RecordValue.operator RecordValue ( string value )
static

Implicitly converts a string value to a RecordValue. A null input becomes a null record value.

◆ operator!=() \[1/2]

static bool kinetica.Records.RecordValue.operator!= ( RecordValue left,
RecordValue right )
static

Determines whether two RecordValue instances are not equal.

◆ operator!=() \[2/2]

static bool kinetica.Records.RecordValue.operator!= ( RecordValue left,
RecordValue right )
static

Determines whether two RecordValue instances are not equal.

◆ operator==() \[1/2]

static bool kinetica.Records.RecordValue.operator== ( RecordValue left,
RecordValue right )
static

Determines whether two RecordValue instances are equal.

◆ operator==() \[2/2]

static bool kinetica.Records.RecordValue.operator== ( RecordValue left,
RecordValue right )
static

Determines whether two RecordValue instances are equal.

◆ String() \[1/2]

static RecordValue kinetica.Records.RecordValue.String ( string value )
static

Creates a string record value.

◆ String() \[2/2]

static RecordValue kinetica.Records.RecordValue.String ( string value )
static

Creates a string record value.

◆ ToString() \[1/2]

override string kinetica.Records.RecordValue.ToString ( )
inline

Definition at line 356 of file RecordValue.cs.

◆ ToString() \[2/2]

override string kinetica.Records.RecordValue.ToString ( )
inline

Definition at line 356 of file RecordValue.cs.

◆ TryGetBool() \[1/2]

bool kinetica.Records.RecordValue.TryGetBool ( out bool value )
inline

Tries to get the value as a boolean.

Definition at line 288 of file RecordValue.cs.

◆ TryGetBool() \[2/2]

bool kinetica.Records.RecordValue.TryGetBool ( out bool value )
inline

Tries to get the value as a boolean.

Definition at line 288 of file RecordValue.cs.

◆ TryGetBytes() \[1/2]

bool kinetica.Records.RecordValue.TryGetBytes ( out byte?\[] value )
inline

Tries to get the value as bytes.

Definition at line 271 of file RecordValue.cs.

◆ TryGetBytes() \[2/2]

bool kinetica.Records.RecordValue.TryGetBytes ( out byte?\[] value )
inline

Tries to get the value as bytes.

Definition at line 271 of file RecordValue.cs.

◆ TryGetDouble() \[1/2]

bool kinetica.Records.RecordValue.TryGetDouble ( out double value )
inline

Tries to get the value as a double.

Definition at line 242 of file RecordValue.cs.

◆ TryGetDouble() \[2/2]

bool kinetica.Records.RecordValue.TryGetDouble ( out double value )
inline

Tries to get the value as a double.

Definition at line 242 of file RecordValue.cs.

◆ TryGetFloat() \[1/2]

bool kinetica.Records.RecordValue.TryGetFloat ( out float value )
inline

Tries to get the value as a float.

Definition at line 230 of file RecordValue.cs.

◆ TryGetFloat() \[2/2]

bool kinetica.Records.RecordValue.TryGetFloat ( out float value )
inline

Tries to get the value as a float.

Definition at line 230 of file RecordValue.cs.

◆ TryGetInt() \[1/2]

bool kinetica.Records.RecordValue.TryGetInt ( out int value )
inline

Tries to get the value as an integer.

Definition at line 206 of file RecordValue.cs.

◆ TryGetInt() \[2/2]

bool kinetica.Records.RecordValue.TryGetInt ( out int value )
inline

Tries to get the value as an integer.

Definition at line 206 of file RecordValue.cs.

◆ TryGetLong() \[1/2]

bool kinetica.Records.RecordValue.TryGetLong ( out long value )
inline

Tries to get the value as a long.

Definition at line 218 of file RecordValue.cs.

◆ TryGetLong() \[2/2]

bool kinetica.Records.RecordValue.TryGetLong ( out long value )
inline

Tries to get the value as a long.

Definition at line 218 of file RecordValue.cs.

◆ TryGetString() \[1/2]

bool kinetica.Records.RecordValue.TryGetString ( out string? value )
inline

Tries to get the value as a string.

Definition at line 254 of file RecordValue.cs.

◆ TryGetString() \[2/2]

bool kinetica.Records.RecordValue.TryGetString ( out string? value )
inline

Tries to get the value as a string.

Definition at line 254 of file RecordValue.cs.

Property Documentation

◆ IsNull

bool kinetica.Records.RecordValue.IsNull
get

Returns true if this value is null.

Definition at line 52 of file RecordValue.cs.

◆ Type

RecordValueType kinetica.Records.RecordValue.Type
get

Gets the type of this record value.

Definition at line 49 of file RecordValue.cs.

The documentation for this struct was generated from the following files: