Class DataAPIType

Namespace

DataStax.AstraDB.DataApi.Utils

Assembly

DataStax.AstraDB.DataApi.dll

Represents a Data API column type (e.g., text, int, uuid, vector).

public class DataAPIType

Inheritance

object

DataAPIType

Derived

ListDataAPIType

UserDefinedDataAPIType

VectorDataAPIType

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

DataAPIType(string)

Initializes a new DataAPIType with the given type key.

public DataAPIType(string key)

Parameters

key string

Properties

Key

The Data API type identifier string (e.g., "text", "int", "uuid").

[JsonPropertyName("type")]
public string Key { get; set; }

Property Value

string

Methods

Ascii()

Creates an ascii column type.

public static DataAPIType Ascii()

Returns

DataAPIType

BigInt()

Creates a bigint column type.

public static DataAPIType BigInt()

Returns

DataAPIType

Blob()

Creates a blob column type.

public static DataAPIType Blob()

Returns

DataAPIType

Boolean()

Creates a boolean column type.

public static DataAPIType Boolean()

Returns

DataAPIType

Date()

Creates a date column type.

public static DataAPIType Date()

Returns

DataAPIType

Decimal()

Creates a decimal column type.

public static DataAPIType Decimal()

Returns

DataAPIType

Double()

Creates a double column type.

public static DataAPIType Double()

Returns

DataAPIType

Duration()

Creates a duration column type.

public static DataAPIType Duration()

Returns

DataAPIType

Float()

Creates a float column type.

public static DataAPIType Float()

Returns

DataAPIType

Inet()

Creates an inet (IP address) column type.

public static DataAPIType Inet()

Returns

DataAPIType

Int()

Creates an int column type.

public static DataAPIType Int()

Returns

DataAPIType

List(DataAPIType)

Creates a list column type with the specified element type.

public static DataAPIType List(DataAPIType valueType)

Parameters

valueType DataAPIType

Returns

DataAPIType

Map(DataAPIType)

Creates a map column type with string keys and the specified value type.

public static DataAPIType Map(DataAPIType valueType)

Parameters

valueType DataAPIType

Returns

DataAPIType

Map(DataAPIType, DataAPIType)

Creates a map column type with the specified key and value types.

public static DataAPIType Map(DataAPIType keyType, DataAPIType valueType)

Parameters

keyType DataAPIType

valueType DataAPIType

Returns

DataAPIType

Set(DataAPIType)

Creates a set column type with the specified element type.

public static DataAPIType Set(DataAPIType valueType)

Parameters

valueType DataAPIType

Returns

DataAPIType

Text()

Creates a text column type.

public static DataAPIType Text()

Returns

DataAPIType

Time()

Creates a time column type.

public static DataAPIType Time()

Returns

DataAPIType

TimeUuid()

Creates a time uuid column type.

public static DataAPIType TimeUuid()

Returns

DataAPIType

Timestamp()

Creates a timestamp column type.

public static DataAPIType Timestamp()

Returns

DataAPIType

UserDefined(string)

Creates a user-defined (UDT) column type with the specified type name.

public static DataAPIType UserDefined(string name)

Parameters

name string

Returns

DataAPIType

Uuid()

Creates a uuid column type.

public static DataAPIType Uuid()

Returns

DataAPIType

Vector(int)

Creates a vector column type with the specified dimension.

public static DataAPIType Vector(int dimension)

Parameters

dimension int

Returns

DataAPIType

Vectorize(VectorServiceOptions)

Creates a vectorize column type backed by the specified vectorization service.

public static DataAPIType Vectorize(VectorServiceOptions serviceOptions)

Parameters

serviceOptions VectorServiceOptions

Returns

DataAPIType

Vectorize(int, VectorServiceOptions)

Creates a vectorize column type with explicit dimensions, backed by the specified vectorization service.

public static DataAPIType Vectorize(int dimensions, VectorServiceOptions serviceOptions)

Parameters

dimensions int

serviceOptions VectorServiceOptions

Returns

DataAPIType