LogicalType
Read onlyYes
FinalYes
Constants
- BSON : string = 'BSON'
- DATE : string = 'DATE'
- DECIMAL : string = 'DECIMAL'
- ENUM : string = 'ENUM'
- FLOAT16 : string = 'FLOAT16'
- INTEGER : string = 'INTEGER'
- JSON : string = 'JSON'
- LIST : string = 'LIST'
- MAP : string = 'MAP'
- STRING : string = 'STRING'
- TIME : string = 'TIME'
- TIMESTAMP : string = 'TIMESTAMP'
- UNKNOWN : string = 'UNKNOWN'
- UUID : string = 'UUID'
Methods
- __construct() : mixed
- bson() : self
- convertedType() : ConvertedType|null
- The converted type a writer annotates this logical type with for older readers (arrow-rs 60 `ConvertedType::from(Option<LogicalType>)`); null where none exists.
- date() : self
- decimal() : self
- decimalData() : Decimal|null
- enum() : self
- fromConvertedType() : self|null
- fromThrift() : self|null
- integer() : self
- integerData() : Integer|null
- is() : bool
- json() : self
- list() : self
- map() : self
- name() : string
- string() : self
- time() : self
- timeData() : Time|null
- timestamp() : self
- timestampData() : Timestamp|null
- toThrift() : LogicalType
- unknown() : self
- uuid() : self
Constants
BSON
public
string
BSON
= 'BSON'
DATE
public
string
DATE
= 'DATE'
DECIMAL
public
string
DECIMAL
= 'DECIMAL'
ENUM
public
string
ENUM
= 'ENUM'
FLOAT16
public
string
FLOAT16
= 'FLOAT16'
INTEGER
public
string
INTEGER
= 'INTEGER'
JSON
public
string
JSON
= 'JSON'
LIST
public
string
LIST
= 'LIST'
MAP
public
string
MAP
= 'MAP'
STRING
public
string
STRING
= 'STRING'
TIME
public
string
TIME
= 'TIME'
TIMESTAMP
public
string
TIMESTAMP
= 'TIMESTAMP'
UNKNOWN
public
string
UNKNOWN
= 'UNKNOWN'
UUID
public
string
UUID
= 'UUID'
Methods
__construct()
public
__construct(string $name[, Timestamp|null $timestamp = null ][, Time|null $time = null ][, Decimal|null $decimal = null ][, Integer|null $integer = null ]) : mixed
Parameters
bson()
public
static bson() : self
Return values
selfconvertedType()
The converted type a writer annotates this logical type with for older readers (arrow-rs 60 `ConvertedType::from(Option<LogicalType>)`); null where none exists.
public
convertedType() : ConvertedType|null
Return values
ConvertedType|nulldate()
public
static date() : self
Return values
selfdecimal()
public
static decimal(int $scale, int $precision) : self
Parameters
- $scale : int
- $precision : int
Return values
selfdecimalData()
public
decimalData() : Decimal|null
Return values
Decimal|nullenum()
public
static enum() : self
Return values
selffromConvertedType()
public
static fromConvertedType(ConvertedType $convertedType, int|null $scale, int|null $precision) : self|null
Parameters
- $convertedType : ConvertedType
- $scale : int|null
- $precision : int|null
Return values
self|nullfromThrift()
public
static fromThrift(LogicalType $logicalType) : self|null
Parameters
- $logicalType : LogicalType
Return values
self|nullinteger()
public
static integer(int $bitWidth, bool $isSigned) : self
Parameters
- $bitWidth : int
- $isSigned : bool
Return values
selfintegerData()
public
integerData() : Integer|null
Return values
Integer|nullis()
public
is(string $logicalType) : bool
Parameters
- $logicalType : string
Return values
booljson()
public
static json() : self
Return values
selflist()
public
static list() : self
Return values
selfmap()
public
static map() : self
Return values
selfname()
public
name() : string
Return values
stringstring()
public
static string() : self
Return values
selftime()
public
static time() : self
Return values
selftimeData()
public
timeData() : Time|null
Return values
Time|nulltimestamp()
public
static timestamp() : self
Return values
selftimestampData()
public
timestampData() : Timestamp|null
Return values
Timestamp|nulltoThrift()
public
toThrift() : LogicalType
Return values
LogicalTypeunknown()
public
static unknown() : self
Return values
selfuuid()
public
static uuid() : self