Skip to content

ColumnType

The type of a column in a table.

Use the static factory methods to create instances of this class.

Stub code in ColumnType.sdsstub 

  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
class ColumnType {
    /**
     * Whether the column type is a floating point type.
     */
    @PythonName("is_float") attr isFloat: Boolean
    /**
     * Whether the column type is an integer type (signed or unsigned).
     */
    @PythonName("is_int") attr isInt: Boolean
    /**
     * Whether the column type is a numeric type.
     */
    @PythonName("is_numeric") attr isNumeric: Boolean
    /**
     * Whether the column type is a signed integer type.
     */
    @PythonName("is_signed_int") attr isSignedInt: Boolean
    /**
     * Whether the column type is a temporal type.
     */
    @PythonName("is_temporal") attr isTemporal: Boolean
    /**
     * Whether the column type is an unsigned integer type.
     */
    @PythonName("is_unsigned_int") attr isUnsignedInt: Boolean

    /**
     * Create a `float32` column type (32-bit floating point number).
     */
    @Pure
    static fun float32() -> result1: ColumnType

    /**
     * Create a `float64` column type (64-bit floating point number).
     */
    @Pure
    static fun float64() -> result1: ColumnType

    /**
     * Create an `int8` column type (8-bit signed integer).
     */
    @Pure
    static fun int8() -> result1: ColumnType

    /**
     * Create an `int16` column type (16-bit signed integer).
     */
    @Pure
    static fun int16() -> result1: ColumnType

    /**
     * Create an `int32` column type (32-bit signed integer).
     */
    @Pure
    static fun int32() -> result1: ColumnType

    /**
     * Create an `int64` column type (64-bit signed integer).
     */
    @Pure
    static fun int64() -> result1: ColumnType

    /**
     * Create a `uint8` column type (8-bit unsigned integer).
     */
    @Pure
    static fun uint8() -> result1: ColumnType

    /**
     * Create a `uint16` column type (16-bit unsigned integer).
     */
    @Pure
    static fun uint16() -> result1: ColumnType

    /**
     * Create a `uint32` column type (32-bit unsigned integer).
     */
    @Pure
    static fun uint32() -> result1: ColumnType

    /**
     * Create a `uint64` column type (64-bit unsigned integer).
     */
    @Pure
    static fun uint64() -> result1: ColumnType

    /**
     * Create a `date` column type.
     */
    @Pure
    static fun date() -> result1: ColumnType

    /**
     * Create a `datetime` column type.
     *
     * @param timeZone The time zone. If None, values are assumed to be in local time. This is different from setting the time zone
     * to `"UTC"`. Any TZ identifier defined in the
     * [tz database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) is valid.
     */
    @Pure
    static fun datetime(
        @PythonName("time_zone") timeZone: String? = null
    ) -> result1: ColumnType

    /**
     * Create a `duration` column type.
     */
    @Pure
    static fun duration() -> result1: ColumnType

    /**
     * Create a `time` column type.
     */
    @Pure
    static fun time() -> result1: ColumnType

    /**
     * Create a `string` column type.
     */
    @Pure
    static fun string() -> result1: ColumnType

    /**
     * Create a `binary` column type.
     */
    @Pure
    static fun binary() -> result1: ColumnType

    /**
     * Create a `boolean` column type.
     */
    @Pure
    static fun boolean() -> result1: ColumnType

    /**
     * Create a `null` column type.
     */
    @Pure
    static fun ^null() -> result1: ColumnType
}

isFloat

Whether the column type is a floating point type.

Type: Boolean

isInt

Whether the column type is an integer type (signed or unsigned).

Type: Boolean

isNumeric

Whether the column type is a numeric type.

Type: Boolean

isSignedInt

Whether the column type is a signed integer type.

Type: Boolean

isTemporal

Whether the column type is a temporal type.

Type: Boolean

isUnsignedInt

Whether the column type is an unsigned integer type.

Type: Boolean

binary

Create a binary column type.

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

133
134
@Pure
static fun binary() -> result1: ColumnType

boolean

Create a boolean column type.

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

139
140
@Pure
static fun boolean() -> result1: ColumnType

date

Create a date column type.

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

97
98
@Pure
static fun date() -> result1: ColumnType

datetime

Create a datetime column type.

Parameters:

Name Type Description Default
timeZone String? The time zone. If None, values are assumed to be in local time. This is different from setting the time zone to "UTC". Any TZ identifier defined in the tz database is valid. null

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

107
108
109
110
@Pure
static fun datetime(
    @PythonName("time_zone") timeZone: String? = null
) -> result1: ColumnType

duration

Create a duration column type.

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

115
116
@Pure
static fun duration() -> result1: ColumnType

float32

Create a float32 column type (32-bit floating point number).

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

37
38
@Pure
static fun float32() -> result1: ColumnType

float64

Create a float64 column type (64-bit floating point number).

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

43
44
@Pure
static fun float64() -> result1: ColumnType

int16

Create an int16 column type (16-bit signed integer).

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

55
56
@Pure
static fun int16() -> result1: ColumnType

int32

Create an int32 column type (32-bit signed integer).

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

61
62
@Pure
static fun int32() -> result1: ColumnType

int64

Create an int64 column type (64-bit signed integer).

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

67
68
@Pure
static fun int64() -> result1: ColumnType

int8

Create an int8 column type (8-bit signed integer).

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

49
50
@Pure
static fun int8() -> result1: ColumnType

null

Create a null column type.

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

145
146
@Pure
static fun ^null() -> result1: ColumnType

string

Create a string column type.

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

127
128
@Pure
static fun string() -> result1: ColumnType

time

Create a time column type.

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

121
122
@Pure
static fun time() -> result1: ColumnType

uint16

Create a uint16 column type (16-bit unsigned integer).

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

79
80
@Pure
static fun uint16() -> result1: ColumnType

uint32

Create a uint32 column type (32-bit unsigned integer).

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

85
86
@Pure
static fun uint32() -> result1: ColumnType

uint64

Create a uint64 column type (64-bit unsigned integer).

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

91
92
@Pure
static fun uint64() -> result1: ColumnType

uint8

Create a uint8 column type (8-bit unsigned integer).

Results:

Name Type Description
result1 ColumnType -
Stub code in ColumnType.sdsstub 

73
74
@Pure
static fun uint8() -> result1: ColumnType