You are viewing documentation about an older version (1.12.1). View latest version

Data Types

This package contains all Snowpark logical types.

Classes/Type Hints

ArrayType([element_type])

Array data type.

BinaryType()

Binary data type.

BooleanType()

Boolean data type.

ByteType()

Byte data type.

ColumnIdentifier(normalized_name)

Represents a column identifier.

DataType()

The base class of Snowpark data types.

DateType()

Date data type.

DecimalType([precision, scale])

Decimal data type.

DoubleType()

Double data type.

FloatType()

Float data type.

Geography

The type hint for annotating Geography data when registering UDFs.

GeographyType()

Geography data type.

Geometry

The type hint for annotating Geometry data when registering UDFs.

GeometryType()

Geometry data type.

IntegerType()

Integer data type.

LongType()

Long integer data type.

LTZ

The type hint for annotating TIMESTAMP_LTZ (e.g., Timestamp[LTZ]) data when registering UDFs.

MapType([key_type, value_type])

Map data type.

NTZ

The type hint for annotating TIMESTAMP_NTZ (e.g., Timestamp[NTZ]) data when registering UDFs.

NullType()

Represents a null type.

PandasDataFrame([data, index, columns, ...])

The type hint for annotating Pandas DataFrame data when registering UDFs.

PandasDataFrameType(col_types[, col_names])

Pandas DataFrame data type.

PandasSeries([data, index, dtype, name, ...])

The type hint for annotating Pandas Series data when registering UDFs.

PandasSeriesType(element_type)

Pandas Series data type.

ShortType()

Short integer data type.

StringType([length])

String data type.

StructField(column_identifier, datatype[, ...])

Represents the content of StructField.

StructType([fields])

Represents a table schema.

Timestamp

The type hint for annotating TIMESTAMP_* data when registering UDFs.

TimestampTimeZone(value)

Snowflake Timestamp variations.

TimestampType([timezone])

Timestamp data type.

TimeType()

Time data type.

TZ

The type hint for annotating TIMESTAMP_TZ (e.g., Timestamp[TZ]) data when registering UDFs.

Variant

The type hint for annotating Variant data when registering UDFs.

VariantType()

Variant data type.