> ## 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.KineticaType.Column > kinetica.KineticaType.Column — Kinetica C# API

Describes a single column of a KineticaType: its name, data type, and properties. More...

Public Types
enum   ColumnType {"{"}
  BYTES = (int)Avro.Schema.Type.Bytes ,
  DOUBLE = (int)Avro.Schema.Type.Double ,
  FLOAT = (int)Avro.Schema.Type.Float ,
  INT = (int)Avro.Schema.Type.Int ,
  LONG = (int)Avro.Schema.Type.Long ,
  STRING = (int)Avro.Schema.Type.String ,
  BOOLEAN = (int)Avro.Schema.Type.Boolean ,
  DEFAULT = (int)Avro.Schema.Type.Error ,
  BYTES = (int)Avro.Schema.Type.Bytes ,
  DOUBLE = (int)Avro.Schema.Type.Double ,
  FLOAT = (int)Avro.Schema.Type.Float ,
  INT = (int)Avro.Schema.Type.Int ,
  LONG = (int)Avro.Schema.Type.Long ,
  STRING = (int)Avro.Schema.Type.String ,
  BOOLEAN = (int)Avro.Schema.Type.Boolean ,
  DEFAULT = (int)Avro.Schema.Type.Error
{"}"}
  The primitive data type of a column. More...
 
enum   ColumnType {"{"}
  BYTES = (int)Avro.Schema.Type.Bytes ,
  DOUBLE = (int)Avro.Schema.Type.Double ,
  FLOAT = (int)Avro.Schema.Type.Float ,
  INT = (int)Avro.Schema.Type.Int ,
  LONG = (int)Avro.Schema.Type.Long ,
  STRING = (int)Avro.Schema.Type.String ,
  BOOLEAN = (int)Avro.Schema.Type.Boolean ,
  DEFAULT = (int)Avro.Schema.Type.Error ,
  BYTES = (int)Avro.Schema.Type.Bytes ,
  DOUBLE = (int)Avro.Schema.Type.Double ,
  FLOAT = (int)Avro.Schema.Type.Float ,
  INT = (int)Avro.Schema.Type.Int ,
  LONG = (int)Avro.Schema.Type.Long ,
  STRING = (int)Avro.Schema.Type.String ,
  BOOLEAN = (int)Avro.Schema.Type.Boolean ,
  DEFAULT = (int)Avro.Schema.Type.Error
{"}"}
  The primitive data type of a column. More...
 

Public Member Functions
  Column (string name, ColumnType type, IList\< string >? properties=null)
  Creates a Column object from the given name, type, and properties.
 
string  getName ()
  Returns the name of the column.
 
ColumnType  getType ()
  Returns the enumeration for the column type.
 
bool  isNullable ()
  Returns if the column is nullable.
 
IList\< string >  getProperties ()
  Returns the properties for the column.
 
bool  isDecimal ()
  Returns whether this column is a decimal type.
 
int  getDecimalPrecision ()
  Returns the precision for decimal columns.
 
int  getDecimalScale ()
  Returns the scale for decimal columns.
 
int  getDecimalByteSize ()
  Returns the byte size needed to store decimal values for this column.
 
string  getTypeString ()
  Returns the string format of the data type.
 
override string  ToString ()
 
  Column (string name, ColumnType type, IList\< string >? properties=null)
  Creates a Column object from the given name, type, and properties.
 
string  getName ()
  Returns the name of the column.
 
ColumnType  getType ()
  Returns the enumeration for the column type.
 
bool  isNullable ()
  Returns if the column is nullable.
 
IList\< string >  getProperties ()
  Returns the properties for the column.
 
bool  isDecimal ()
  Returns whether this column is a decimal type.
 
int  getDecimalPrecision ()
  Returns the precision for decimal columns.
 
int  getDecimalScale ()
  Returns the scale for decimal columns.
 
int  getDecimalByteSize ()
  Returns the byte size needed to store decimal values for this column.
 
string  getTypeString ()
  Returns the string format of the data type.
 
override string  ToString ()
 

Static Public Attributes
const int  DEFAULT\_DECIMAL\_PRECISION = 18
  Default precision for decimal columns (matches Java API).
 
const int  DEFAULT\_DECIMAL\_SCALE = 4
  Default scale for decimal columns (matches Java API).
 
const int  DECIMAL8\_MAX\_PRECISION = 18
  Maximum precision for 8-byte decimals.
 

Detailed Description

Describes a single column of a KineticaType: its name, data type, and properties.

Definition at line 12 of file KineticaType.cs.

Member Enumeration Documentation

◆ ColumnType \[1/2]

enum kinetica.KineticaType.Column.ColumnType

The primitive data type of a column.

Enumerator
BYTES 

A byte-array (binary) column.

DOUBLE 

A double-precision floating-point column.

FLOAT 

A single-precision floating-point column.

INT 

A 32-bit integer column.

LONG 

A 64-bit integer column.

STRING 

A string column.

BOOLEAN 

A boolean column.

DEFAULT 

An unset/unrecognized column type.

BYTES 

A byte-array (binary) column.

DOUBLE 

A double-precision floating-point column.

FLOAT 

A single-precision floating-point column.

INT 

A 32-bit integer column.

LONG 

A 64-bit integer column.

STRING 

A string column.

BOOLEAN 

A boolean column.

DEFAULT 

An unset/unrecognized column type.

Definition at line 15 of file KineticaType.cs.

◆ ColumnType \[2/2]

enum kinetica.KineticaType.Column.ColumnType

The primitive data type of a column.

Enumerator
BYTES 

A byte-array (binary) column.

DOUBLE 

A double-precision floating-point column.

FLOAT 

A single-precision floating-point column.

INT 

A 32-bit integer column.

LONG 

A 64-bit integer column.

STRING 

A string column.

BOOLEAN 

A boolean column.

DEFAULT 

An unset/unrecognized column type.

BYTES 

A byte-array (binary) column.

DOUBLE 

A double-precision floating-point column.

FLOAT 

A single-precision floating-point column.

INT 

A 32-bit integer column.

LONG 

A 64-bit integer column.

STRING 

A string column.

BOOLEAN 

A boolean column.

DEFAULT 

An unset/unrecognized column type.

Definition at line 15 of file KineticaType.cs.

Constructor & Destructor Documentation

◆ Column() \[1/2]

kinetica.KineticaType.Column.Column ( string name,
ColumnType type,
IList\< string >? properties = null )
inline

Creates a Column object from the given name, type, and properties.

Parameters
name
type
properties

Definition at line 71 of file KineticaType.cs.

◆ Column() \[2/2]

kinetica.KineticaType.Column.Column ( string name,
ColumnType type,
IList\< string >? properties = null )
inline

Creates a Column object from the given name, type, and properties.

Parameters
name
type
properties

Definition at line 71 of file KineticaType.cs.

Member Function Documentation

◆ getDecimalByteSize() \[1/2]

int kinetica.KineticaType.Column.getDecimalByteSize ( )
inline

Returns the byte size needed to store decimal values for this column.

Returns 8 for precision \<= 18, or 12 for precision > 18.

Returns
The byte size (8 or 12) for storing decimal values.

Definition at line 130 of file KineticaType.cs.

◆ getDecimalByteSize() \[2/2]

int kinetica.KineticaType.Column.getDecimalByteSize ( )
inline

Returns the byte size needed to store decimal values for this column.

Returns 8 for precision \<= 18, or 12 for precision > 18.

Returns
The byte size (8 or 12) for storing decimal values.

Definition at line 130 of file KineticaType.cs.

◆ getDecimalPrecision() \[1/2]

int kinetica.KineticaType.Column.getDecimalPrecision ( )
inline

Returns the precision for decimal columns.

For non-decimal columns, returns DEFAULT\_DECIMAL\_PRECISION.

Returns
The total number of digits in the decimal.

Definition at line 116 of file KineticaType.cs.

◆ getDecimalPrecision() \[2/2]

int kinetica.KineticaType.Column.getDecimalPrecision ( )
inline

Returns the precision for decimal columns.

For non-decimal columns, returns DEFAULT\_DECIMAL\_PRECISION.

Returns
The total number of digits in the decimal.

Definition at line 116 of file KineticaType.cs.

◆ getDecimalScale() \[1/2]

int kinetica.KineticaType.Column.getDecimalScale ( )
inline

Returns the scale for decimal columns.

For non-decimal columns, returns DEFAULT\_DECIMAL\_SCALE.

Returns
The number of digits after the decimal point.

Definition at line 123 of file KineticaType.cs.

◆ getDecimalScale() \[2/2]

int kinetica.KineticaType.Column.getDecimalScale ( )
inline

Returns the scale for decimal columns.

For non-decimal columns, returns DEFAULT\_DECIMAL\_SCALE.

Returns
The number of digits after the decimal point.

Definition at line 123 of file KineticaType.cs.

◆ getName() \[1/2]

string kinetica.KineticaType.Column.getName ( )
inline

Returns the name of the column.

Returns

Definition at line 85 of file KineticaType.cs.

◆ getName() \[2/2]

string kinetica.KineticaType.Column.getName ( )
inline

Returns the name of the column.

Returns

Definition at line 85 of file KineticaType.cs.

◆ getProperties() \[1/2]

IList\< string > kinetica.KineticaType.Column.getProperties ( )
inline

Returns the properties for the column.

Returns

Definition at line 103 of file KineticaType.cs.

◆ getProperties() \[2/2]

IList\< string > kinetica.KineticaType.Column.getProperties ( )
inline

Returns the properties for the column.

Returns

Definition at line 103 of file KineticaType.cs.

◆ getType() \[1/2]

ColumnType kinetica.KineticaType.Column.getType ( )
inline

Returns the enumeration for the column type.

Returns

Definition at line 91 of file KineticaType.cs.

◆ getType() \[2/2]

ColumnType kinetica.KineticaType.Column.getType ( )
inline

Returns the enumeration for the column type.

Returns

Definition at line 91 of file KineticaType.cs.

◆ getTypeString() \[1/2]

string kinetica.KineticaType.Column.getTypeString ( )
inline

Returns the string format of the data type.

Returns

Definition at line 138 of file KineticaType.cs.

◆ getTypeString() \[2/2]

string kinetica.KineticaType.Column.getTypeString ( )
inline

Returns the string format of the data type.

Returns

Definition at line 138 of file KineticaType.cs.

◆ isDecimal() \[1/2]

bool kinetica.KineticaType.Column.isDecimal ( )
inline

Returns whether this column is a decimal type.

Returns
True if the column has a decimal property.

Definition at line 109 of file KineticaType.cs.

◆ isDecimal() \[2/2]

bool kinetica.KineticaType.Column.isDecimal ( )
inline

Returns whether this column is a decimal type.

Returns
True if the column has a decimal property.

Definition at line 109 of file KineticaType.cs.

◆ isNullable() \[1/2]

bool kinetica.KineticaType.Column.isNullable ( )
inline

Returns if the column is nullable.

Returns

Definition at line 97 of file KineticaType.cs.

◆ isNullable() \[2/2]

bool kinetica.KineticaType.Column.isNullable ( )
inline

Returns if the column is nullable.

Returns

Definition at line 97 of file KineticaType.cs.

◆ ToString() \[1/2]

override string kinetica.KineticaType.Column.ToString ( )
inline

Definition at line 227 of file KineticaType.cs.

◆ ToString() \[2/2]

override string kinetica.KineticaType.Column.ToString ( )
inline

Definition at line 227 of file KineticaType.cs.

Member Data Documentation

◆ DECIMAL8\_MAX\_PRECISION

const int kinetica.KineticaType.Column.DECIMAL8\_MAX\_PRECISION = 18
static

Maximum precision for 8-byte decimals.

Decimals with precision > 18 use 12 bytes.

Definition at line 48 of file KineticaType.cs.

◆ DEFAULT\_DECIMAL\_PRECISION

const int kinetica.KineticaType.Column.DEFAULT\_DECIMAL\_PRECISION = 18
static

Default precision for decimal columns (matches Java API).

Definition at line 38 of file KineticaType.cs.

◆ DEFAULT\_DECIMAL\_SCALE

const int kinetica.KineticaType.Column.DEFAULT\_DECIMAL\_SCALE = 4
static

Default scale for decimal columns (matches Java API).

Definition at line 43 of file KineticaType.cs.

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