Module tsurugi_dbapi.type_code

Classes

class Blob (value=None)

BLOB type.

Examples

value = cursor.upload_blob(b"\x01\x02\x03")
value = cursor.upload_blob(None)

since 0.10.0

class Bool (value=None)

BOOLEAN type.

Attributes

value : Optional[bool]

boolean value. (read only)

Examples

import tsurugi_dbapi as tsurugi

value = tsurugi.type_code.Bool(True)
value = tsurugi.type_code.Bool(None)

Instance variables

var value

Value.

class Bytes (value=None)

BINARY, VARBINARY type.

Attributes

value : Optional[bytes]

binary data. (read only)

Examples

import tsurugi_dbapi as tsurugi

value = tsurugi.type_code.Bytes(b"0x01\x02\x03")
value = tsurugi.type_code.Bytes(None)

Instance variables

var value

Value.

class Clob (value=None)

CLOB type.

Examples

value = cursor.upload_clob("example text")
value = cursor.upload_clob(None)

since 0.10.0

class Date (value=None)

DATE type.

Attributes

value : Optional[datetime.date]

date value. (read only)

Examples

import tsurugi_dbapi as tsurugi
import datetime

value = tsurugi.type_code.Date(datetime.date(2026, 2, 24))
value = tsurugi.type_code.Date(None)

Instance variables

var value

Value.

Methods

def of(year, month, day)

Create a Date from year, month, and day.

Args

year : int

year

month : int

month (1-12)

day : int

day (1-31)

Returns

Date

created Date object

def raw(epoch_days)

Create a Date from epoch days.

Args

epoch_days : int

number of days offset of epoch 1970-01-01

Returns

Date

created Date object

class Datetime (value=None, nanosecond=None)

TIMESTAMP type.

Attributes

value : Optional[datetime.datetime]

datetime value. (read only)

nanosecond : Optional[int]

nanosecond part of the time. (read only)

Examples

import tsurugi_dbapi as tsurugi
import datetime

value = tsurugi.type_code.Datetime(datetime.datetime(2026, 2, 24, 12, 34, 56, 123456)) # microsecond precision
value = tsurugi.type_code.Datetime(datetime.datetime(2026, 2, 24, 12, 34, 56), 123456879) # nanosecond precision
value = tsurugi.type_code.Datetime(None)

Instance variables

var nanosecond

Nnanosecond.

var value

Value.

Methods

def of(year, month, day, hour=0, minute=0, second=0, nanosecond=0)

Create a Datetime from year, month, day, hour, minute, second, and nanosecond.

Args

year : int

year

month : int

month (1-12)

day : int

day (1-31)

hour : int, optional

hour (0-23)

minute : int, optional

minute (0-59)

second : int, optional

second (0-59)

nanosecond : int, optional

nanosecond (0-999,999,999)

Returns

Datetime

created Datetime object

def raw(epoch_seconds, nanos)

Create a Datetime from epoch seconds and nanoseconds.

Args

epoch_seconds : int

offset seconds from epoch (1970-01-01 00:00:00)

nanos : int

nanosecond part of the time (0-999,999,999)

Returns

Datetime

created Datetime object

class Decimal (value=None)

DECIMAL type.

Attributes

value : Optional[decimal.Decimal]

decimal value. (read only)

Examples

import tsurugi_dbapi as tsurugi
import decimal

value = tsurugi.type_code.Decimal(decimal.Decimal("123.45"))
value = tsurugi.type_code.Decimal(None)

Instance variables

var value

Value.

Methods

def raw(unscaled_value, exponent)

Create a Decimal from unscaled value and exponent.

Args

unscaled_value : bytes

unscaled value as big-endian byte array

exponent : int

exponent

Returns

Decimal

created Decimal object

class Float32 (value=None)

REAL type.

Attributes

value : Optional[float]

float value. (read only)

Examples

import tsurugi_dbapi as tsurugi

value = tsurugi.type_code.Float32(123.5)
value = tsurugi.type_code.Float32(None)

Instance variables

var value

Value.

class Float64 (value=None)

DOUBLE type.

Attributes

value : Optional[float]

float value. (read only)

Examples

import tsurugi_dbapi as tsurugi

value = tsurugi.type_code.Float64(123.5)
value = tsurugi.type_code.Float64(None)

Instance variables

var value

Value.

class Int32 (value=None)

INT type.

Attributes

value : Optional[int]

integer value. (read only)

Examples

import tsurugi_dbapi as tsurugi

value = tsurugi.type_code.Int32(123)
value = tsurugi.type_code.Int32(None)

Instance variables

var value

Value.

class Int64 (value=None)

BIGINT type.

Attributes

value : Optional[int]

integer value. (read only)

Examples

import tsurugi_dbapi as tsurugi

value = tsurugi.type_code.Int64(123)
value = tsurugi.type_code.Int64(None)

Instance variables

var value

Value.

class OffsetDatetime (value=None, nanosecond=None)

TIMESTAMP WITH TIME ZONE type.

Attributes

value : Optional[datetime.datetime]

datetime value with time zone. (read only)

nanosecond : Optional[int]

nanosecond part of the time. (read only)

Examples

import tsurugi_dbapi as tsurugi
import datetime

JST = datetime.timezone(datetime.timedelta(hours=9))
value = tsurugi.type_code.OffsetDatetime(datetime.datetime(2026, 2, 24, 12, 34, 56, 123456, tzinfo=JST)) # microsecond precision
value = tsurugi.type_code.OffsetDatetime(datetime.datetime(2026, 2, 24, 12, 34, 56, tzinfo=JST), 123456879) # nanosecond precision
value = tsurugi.type_code.OffsetDatetime(None)

Instance variables

var nanosecond

Nnanosecond.

var value

Value.

Methods

def of(year, month, day, hour=0, minute=0, second=0, nanosecond=0, tzinfo=None)

Create a OffsetDatetime from year, month, day, hour, minute, second, nanosecond, and tzinfo.

Args

year : int

year

month : int

month (1-12)

day : int

day (1-31)

hour : int, optional

hour (0-23)

minute : int, optional

minute (0-59)

second : int, optional

second (0-59)

nanosecond : int, optional

nanosecond (0-999,999,999)

tzinfo : datetime.tzinfo, optional

time zone info (default: UTC)

Returns

OffsetDatetime

created OffsetDatetime object

def raw(epoch_seconds, nanos, time_zone_offset)

Create a OffsetDatetime from epoch seconds, nanoseconds, and time zone offset.

Args

epoch_seconds : int

offset seconds from epoch (1970-01-01 00:00:00)

nanos : int

nanosecond part of the time (0-999,999,999)

time_zone_offset : int

time zone offset in minutes

Returns

OffsetDatetime

created OffsetDatetime object

class OffsetTime (value=None, nanosecond=None)

TIME WITH TIME ZONE type.

Attributes

value : Optional[datetime.time]

time value with time zone. (read only)

nanosecond : Optional[int]

nanosecond part of the time. (read only)

Examples

import tsurugi_dbapi as tsurugi
import datetime

JST = datetime.timezone(datetime.timedelta(hours=9))
value = tsurugi.type_code.OffsetTime(datetime.time(12, 34, 56, 123456, tzinfo=JST)) # microsecond precision
value = tsurugi.type_code.OffsetTime(datetime.time(12, 34, 56, tzinfo=JST), 123456879) # nanosecond precision
value = tsurugi.type_code.OffsetTime(None)

Instance variables

var nanosecond

Nnanosecond.

var value

Value.

Methods

def of(hour=0, minute=0, second=0, nanosecond=0, tzinfo=None)

Create a OffsetTime from hour, minute, second, nanosecond, and tzinfo.

Args

hour : int, optional

hour (0-23)

minute : int, optional

minute (0-59)

second : int, optional

second (0-59)

nanosecond : int, optional

nanosecond (0-999,999,999)

tzinfo : datetime.tzinfo, optional

time zone info (Default: UTC)

Returns

OffsetTime

created OffsetTime object

def raw(nanoseconds_of_day, time_zone_offset)

Create a OffsetTime from epoch nanoseconds of day and time zone offset.

Args

nanoseconds_of_day : int

offset nano-seconds from epoch (00:00:00) in the time zone

time_zone_offset : int

timezone offset in minute

Returns

OffsetTime

created OffsetTime object

class Str (value=None)

CHAR, VARCHAR type.

Attributes

value : Optional[str]

string value. (read only)

Examples

import tsurugi_dbapi as tsurugi

value = tsurugi.type_code.Str("abc")
value = tsurugi.type_code.Str(None)

Instance variables

var value

Value.

class Time (value=None, nanosecond=None)

TIME type.

Attributes

value : Optional[datetime.time]

time value. (read only)

nanosecond : Optional[int]

nanosecond part of the time. (read only)

Examples

import tsurugi_dbapi as tsurugi
import datetime

value = tsurugi.type_code.Time(datetime.time(12, 34, 56, 123456)) # microsecond precision
value = tsurugi.type_code.Time(datetime.time(12, 34, 56), 123456879) # nanosecond precision
value = tsurugi.type_code.Time(None)

Instance variables

var nanosecond

Nnanosecond.

var value

Value.

Methods

def of(hour=0, minute=0, second=0, nanosecond=0)

Create a Time from hour, minute, second, and nanosecond.

Args

hour : int, optional

hour (0-23)

minute : int, optional

minute (0-59)

second : int, optional

second (0-59)

nanosecond : int, optional

nanosecond (0-999,999,999)

Returns

Time

created Time object

def raw(nanoseconds_of_day)

Create a Time from nanoseconds of day.

Args

nanoseconds_of_day : int

time of day (nanoseconds since 00:00:00)

Returns

Time

created Time object