Snowpark Scala API Reference1.20.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package com
  Definition Classes
    root
-  package snowflake
  Definition Classes
    com
-  package snowpark
  Definition Classes
    snowflake
-  package types

  This package contains all Snowpark logical types.

  This package contains all Snowpark logical types.

  Definition Classes
    snowpark
  Since

    0.1.0

- ArrayType
- BinaryType
- BooleanType
- ByteType
- ColumnIdentifier
- DataType
- DateType
- DecimalType
- DoubleType
- FloatType
- Geography
- GeographyType
- Geometry
- GeometryType
- IntegerType
- LongType
- MapType
- ShortType
- StringType
- StructField
- StructType
- TimeType
- TimestampType
- Variant
- VariantType
-  package udaf
  Definition Classes
    snowpark
-  package udtf
  Definition Classes
    snowpark

p

com.snowflake.snowpark

# types

#### package types

This package contains all Snowpark logical types.

Since

  0.1.0

Linear Supertypes
AnyRef, Any

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. types
2. AnyRef
3. Any

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Type Members

1.  case class ArrayType(elementType: DataType) extends DataType with Product with Serializable

   Array data type.

   Array data type. This maps to ARRAY data type in Snowflake.

   Since

     0.1.0

2.  class ColumnIdentifier extends AnyRef

   Represents Column Identifier

   Represents Column Identifier

   Since

     0.1.0

3.  abstract class DataType extends AnyRef

   The trait of Snowpark data types

   The trait of Snowpark data types

   Since

     0.1.0

4.  case class DecimalType(precision: Int, scale: Int) extends FractionalType with Product with Serializable

   Decimal data type.

   Decimal data type. Mapped to NUMBER Snowflake date type.

   Since

     0.1.0

5.  class Geography extends AnyRef

   Scala representation of Snowflake Geography data.

   Scala representation of Snowflake Geography data. Only support GeoJSON format.

   Since

     0.2.0

6.  class Geometry extends AnyRef

   Scala representation of Snowflake Geometry data.

   Scala representation of Snowflake Geometry data. Only support GeoJSON format.

   Since

     1.12.0

7.  case class MapType(keyType: DataType, valueType: DataType) extends DataType with Product with Serializable

   Map data type.

   Map data type. This maps to OBJECT data type in Snowflake.

   Since

     0.1.0

8.  case class StructField(columnIdentifier: ColumnIdentifier, dataType: DataType, nullable: Boolean = true) extends Product with Serializable

   Represents the content of StructType.

   Represents the content of StructType.

   Since

     0.1.0

9.  case class StructType(fields: Array[StructField] = Array()) extends DataType with Seq[StructField] with Product with Serializable

   StructType data type, represents table schema.

   StructType data type, represents table schema.

   Since

     0.1.0

10.  class Variant extends AnyRef

    Representation of Snowflake Variant data

    Representation of Snowflake Variant data

    Since

      0.2.0

### Value Members

1.  def convertToSFType(dataType: DataType): String
2.  object BinaryType extends AtomicType

   Binary data type.

   Binary data type. Mapped to BINARY Snowflake data type.

   Since

     0.1.0

3.  object BooleanType extends AtomicType

   Boolean data type.

   Boolean data type. Mapped to BOOLEAN Snowflake data type.

   Since

     0.1.0

4.  object ByteType extends IntegralType

   Byte data type.

   Byte data type. Mapped to TINYINT Snowflake date type.

   Since

     0.1.0

5.  object ColumnIdentifier

   Constructors and Util functions of ColumnIdentifier

   Constructors and Util functions of ColumnIdentifier

   Since

     0.1.0

6.  object DateType extends AtomicType

   Date data type.

   Date data type. Mapped to DATE Snowflake data type.

   Since

     0.1.0

7.  object DecimalType extends Serializable

   Companion object of DecimalType.

   Companion object of DecimalType.

   Since

     0.9.0

8.  object DoubleType extends FractionalType

   Double data type.

   Double data type. Mapped to DOUBLE Snowflake date type.

   Since

     0.1.0

9.  object FloatType extends FractionalType

   Float data type.

   Float data type. Mapped to FLOAT Snowflake date type.

   Since

     0.1.0

10.  object Geography

    Companion object of Geography class.

11.  object GeographyType extends DataType

    Geography data type.

    Geography data type. This maps to GEOGRAPHY data type in Snowflake.

    Since

      0.2.0

12.  object Geometry

    Companion object of Geometry class.

    Companion object of Geometry class.

    Since

      1.12.0

13.  object GeometryType extends DataType

    Geometry data type.

    Geometry data type. This maps to GEOMETRY data type in Snowflake.

    Since

      1.12.0

14.  object IntegerType extends IntegralType

    Integer data type.

    Integer data type. Mapped to INT Snowflake date type.

    Since

      0.1.0

15.  object LongType extends IntegralType

    Long integer data type.

    Long integer data type. Mapped to BIGINT Snowflake date type.

    Since

      0.1.0

16.  object ShortType extends IntegralType

    Short integer data type.

    Short integer data type. Mapped to SMALLINT Snowflake date type.

    Since

      0.1.0

17.  object StringType extends AtomicType

    String data type.

    String data type. Mapped to VARCHAR Snowflake data type.

    Since

      0.1.0

18.  object StructField extends Serializable

    Constructors and Util functions of StructField

    Constructors and Util functions of StructField

    Since

      0.1.0

19.  object StructType extends Serializable

    StructType data type, represents table schema.

    StructType data type, represents table schema.

    Since

      0.1.0

20.  object TimeType extends AtomicType

    Time data type.

    Time data type. Mapped to TIME Snowflake data type.

    Since

      0.2.0

21.  object TimestampType extends AtomicType

    Timestamp data type.

    Timestamp data type. Mapped to TIMESTAMP Snowflake data type.

    Since

      0.1.0

22.  object VariantType extends DataType

    Variant data type.

    Variant data type. This maps to VARIANT data type in Snowflake.

    Since

      0.1.0

### Inherited from AnyRef

### Inherited from Any

### Ungrouped