apache-arrow
Version:
Apache Arrow columnar in-memory format
588 lines (586 loc) • 21.6 kB
JavaScript
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
import { bigIntToNumber } from './util/bigint.mjs';
import { Type, Precision, UnionMode, DateUnit, TimeUnit, IntervalUnit } from './enum.mjs';
/**
* An abstract base class for classes that encapsulate metadata about each of
* the logical types that Arrow can represent.
*/
export class DataType {
/** @nocollapse */ static isNull(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Null; }
/** @nocollapse */ static isInt(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Int; }
/** @nocollapse */ static isFloat(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Float; }
/** @nocollapse */ static isBinary(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Binary; }
/** @nocollapse */ static isLargeBinary(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.LargeBinary; }
/** @nocollapse */ static isUtf8(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Utf8; }
/** @nocollapse */ static isLargeUtf8(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.LargeUtf8; }
/** @nocollapse */ static isBool(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Bool; }
/** @nocollapse */ static isDecimal(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Decimal; }
/** @nocollapse */ static isDate(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Date; }
/** @nocollapse */ static isTime(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Time; }
/** @nocollapse */ static isTimestamp(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Timestamp; }
/** @nocollapse */ static isInterval(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Interval; }
/** @nocollapse */ static isDuration(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Duration; }
/** @nocollapse */ static isList(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.List; }
/** @nocollapse */ static isStruct(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Struct; }
/** @nocollapse */ static isUnion(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Union; }
/** @nocollapse */ static isFixedSizeBinary(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.FixedSizeBinary; }
/** @nocollapse */ static isFixedSizeList(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.FixedSizeList; }
/** @nocollapse */ static isMap(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Map; }
/** @nocollapse */ static isDictionary(x) { return (x === null || x === void 0 ? void 0 : x.typeId) === Type.Dictionary; }
/** @nocollapse */ static isDenseUnion(x) { return DataType.isUnion(x) && x.mode === UnionMode.Dense; }
/** @nocollapse */ static isSparseUnion(x) { return DataType.isUnion(x) && x.mode === UnionMode.Sparse; }
constructor(typeId) {
this.typeId = typeId;
}
}
_a = Symbol.toStringTag;
DataType[_a] = ((proto) => {
proto.children = null;
proto.ArrayType = Array;
proto.OffsetArrayType = Int32Array;
return proto[Symbol.toStringTag] = 'DataType';
})(DataType.prototype);
/** @ignore */
export class Null extends DataType {
constructor() {
super(Type.Null);
}
toString() { return `Null`; }
}
_b = Symbol.toStringTag;
Null[_b] = ((proto) => proto[Symbol.toStringTag] = 'Null')(Null.prototype);
/** @ignore */
class Int_ extends DataType {
constructor(isSigned, bitWidth) {
super(Type.Int);
this.isSigned = isSigned;
this.bitWidth = bitWidth;
}
get ArrayType() {
switch (this.bitWidth) {
case 8: return this.isSigned ? Int8Array : Uint8Array;
case 16: return this.isSigned ? Int16Array : Uint16Array;
case 32: return this.isSigned ? Int32Array : Uint32Array;
case 64: return this.isSigned ? BigInt64Array : BigUint64Array;
}
throw new Error(`Unrecognized ${this[Symbol.toStringTag]} type`);
}
toString() { return `${this.isSigned ? `I` : `Ui`}nt${this.bitWidth}`; }
}
_c = Symbol.toStringTag;
Int_[_c] = ((proto) => {
proto.isSigned = null;
proto.bitWidth = null;
return proto[Symbol.toStringTag] = 'Int';
})(Int_.prototype);
export { Int_ as Int };
/** @ignore */
export class Int8 extends Int_ {
constructor() { super(true, 8); }
get ArrayType() { return Int8Array; }
}
/** @ignore */
export class Int16 extends Int_ {
constructor() { super(true, 16); }
get ArrayType() { return Int16Array; }
}
/** @ignore */
export class Int32 extends Int_ {
constructor() { super(true, 32); }
get ArrayType() { return Int32Array; }
}
/** @ignore */
export class Int64 extends Int_ {
constructor() { super(true, 64); }
get ArrayType() { return BigInt64Array; }
}
/** @ignore */
export class Uint8 extends Int_ {
constructor() { super(false, 8); }
get ArrayType() { return Uint8Array; }
}
/** @ignore */
export class Uint16 extends Int_ {
constructor() { super(false, 16); }
get ArrayType() { return Uint16Array; }
}
/** @ignore */
export class Uint32 extends Int_ {
constructor() { super(false, 32); }
get ArrayType() { return Uint32Array; }
}
/** @ignore */
export class Uint64 extends Int_ {
constructor() { super(false, 64); }
get ArrayType() { return BigUint64Array; }
}
Object.defineProperty(Int8.prototype, 'ArrayType', { value: Int8Array });
Object.defineProperty(Int16.prototype, 'ArrayType', { value: Int16Array });
Object.defineProperty(Int32.prototype, 'ArrayType', { value: Int32Array });
Object.defineProperty(Int64.prototype, 'ArrayType', { value: BigInt64Array });
Object.defineProperty(Uint8.prototype, 'ArrayType', { value: Uint8Array });
Object.defineProperty(Uint16.prototype, 'ArrayType', { value: Uint16Array });
Object.defineProperty(Uint32.prototype, 'ArrayType', { value: Uint32Array });
Object.defineProperty(Uint64.prototype, 'ArrayType', { value: BigUint64Array });
/** @ignore */
export class Float extends DataType {
constructor(precision) {
super(Type.Float);
this.precision = precision;
}
get ArrayType() {
switch (this.precision) {
case Precision.HALF: return Uint16Array;
case Precision.SINGLE: return Float32Array;
case Precision.DOUBLE: return Float64Array;
}
// @ts-ignore
throw new Error(`Unrecognized ${this[Symbol.toStringTag]} type`);
}
toString() { return `Float${(this.precision << 5) || 16}`; }
}
_d = Symbol.toStringTag;
Float[_d] = ((proto) => {
proto.precision = null;
return proto[Symbol.toStringTag] = 'Float';
})(Float.prototype);
/** @ignore */
export class Float16 extends Float {
constructor() { super(Precision.HALF); }
}
/** @ignore */
export class Float32 extends Float {
constructor() { super(Precision.SINGLE); }
}
/** @ignore */
export class Float64 extends Float {
constructor() { super(Precision.DOUBLE); }
}
Object.defineProperty(Float16.prototype, 'ArrayType', { value: Uint16Array });
Object.defineProperty(Float32.prototype, 'ArrayType', { value: Float32Array });
Object.defineProperty(Float64.prototype, 'ArrayType', { value: Float64Array });
/** @ignore */
export class Binary extends DataType {
constructor() {
super(Type.Binary);
}
toString() { return `Binary`; }
}
_e = Symbol.toStringTag;
Binary[_e] = ((proto) => {
proto.ArrayType = Uint8Array;
return proto[Symbol.toStringTag] = 'Binary';
})(Binary.prototype);
/** @ignore */
export class LargeBinary extends DataType {
constructor() {
super(Type.LargeBinary);
}
toString() { return `LargeBinary`; }
}
_f = Symbol.toStringTag;
LargeBinary[_f] = ((proto) => {
proto.ArrayType = Uint8Array;
proto.OffsetArrayType = BigInt64Array;
return proto[Symbol.toStringTag] = 'LargeBinary';
})(LargeBinary.prototype);
/** @ignore */
export class Utf8 extends DataType {
constructor() {
super(Type.Utf8);
}
toString() { return `Utf8`; }
}
_g = Symbol.toStringTag;
Utf8[_g] = ((proto) => {
proto.ArrayType = Uint8Array;
return proto[Symbol.toStringTag] = 'Utf8';
})(Utf8.prototype);
/** @ignore */
export class LargeUtf8 extends DataType {
constructor() {
super(Type.LargeUtf8);
}
toString() { return `LargeUtf8`; }
}
_h = Symbol.toStringTag;
LargeUtf8[_h] = ((proto) => {
proto.ArrayType = Uint8Array;
proto.OffsetArrayType = BigInt64Array;
return proto[Symbol.toStringTag] = 'LargeUtf8';
})(LargeUtf8.prototype);
/** @ignore */
export class Bool extends DataType {
constructor() {
super(Type.Bool);
}
toString() { return `Bool`; }
}
_j = Symbol.toStringTag;
Bool[_j] = ((proto) => {
proto.ArrayType = Uint8Array;
return proto[Symbol.toStringTag] = 'Bool';
})(Bool.prototype);
/** @ignore */
export class Decimal extends DataType {
constructor(scale, precision, bitWidth = 128) {
super(Type.Decimal);
this.scale = scale;
this.precision = precision;
this.bitWidth = bitWidth;
}
toString() { return `Decimal[${this.precision}e${this.scale > 0 ? `+` : ``}${this.scale}]`; }
}
_k = Symbol.toStringTag;
Decimal[_k] = ((proto) => {
proto.scale = null;
proto.precision = null;
proto.ArrayType = Uint32Array;
return proto[Symbol.toStringTag] = 'Decimal';
})(Decimal.prototype);
/** @ignore */
export class Date_ extends DataType {
constructor(unit) {
super(Type.Date);
this.unit = unit;
}
toString() { return `Date${(this.unit + 1) * 32}<${DateUnit[this.unit]}>`; }
get ArrayType() {
return this.unit === DateUnit.DAY ? Int32Array : BigInt64Array;
}
}
_l = Symbol.toStringTag;
Date_[_l] = ((proto) => {
proto.unit = null;
return proto[Symbol.toStringTag] = 'Date';
})(Date_.prototype);
/** @ignore */
export class DateDay extends Date_ {
constructor() { super(DateUnit.DAY); }
}
/**
* A signed 64-bit date representing the elapsed time since UNIX epoch (1970-01-01) in milliseconds.
* According to the specification, this should be treated as the number of days, in milliseconds, since the UNIX epoch.
* Therefore, values must be evenly divisible by `86_400_000` (the number of milliseconds in a standard day).
*
* Practically, validation that values of this type are evenly divisible by `86_400_000` is not enforced by this library
* for performance and usability reasons.
*
* Users should prefer to use {@link DateDay} to cleanly represent the number of days. For JS dates,
* {@link TimestampMillisecond} is the preferred type.
*
* @ignore
*/
export class DateMillisecond extends Date_ {
constructor() { super(DateUnit.MILLISECOND); }
}
/** @ignore */
class Time_ extends DataType {
constructor(unit, bitWidth) {
super(Type.Time);
this.unit = unit;
this.bitWidth = bitWidth;
}
toString() { return `Time${this.bitWidth}<${TimeUnit[this.unit]}>`; }
get ArrayType() {
switch (this.bitWidth) {
case 32: return Int32Array;
case 64: return BigInt64Array;
}
// @ts-ignore
throw new Error(`Unrecognized ${this[Symbol.toStringTag]} type`);
}
}
_m = Symbol.toStringTag;
Time_[_m] = ((proto) => {
proto.unit = null;
proto.bitWidth = null;
return proto[Symbol.toStringTag] = 'Time';
})(Time_.prototype);
export { Time_ as Time };
/** @ignore */
export class TimeSecond extends Time_ {
constructor() { super(TimeUnit.SECOND, 32); }
}
/** @ignore */
export class TimeMillisecond extends Time_ {
constructor() { super(TimeUnit.MILLISECOND, 32); }
}
/** @ignore */
export class TimeMicrosecond extends Time_ {
constructor() { super(TimeUnit.MICROSECOND, 64); }
}
/** @ignore */
export class TimeNanosecond extends Time_ {
constructor() { super(TimeUnit.NANOSECOND, 64); }
}
/** @ignore */
class Timestamp_ extends DataType {
constructor(unit, timezone) {
super(Type.Timestamp);
this.unit = unit;
this.timezone = timezone;
}
toString() { return `Timestamp<${TimeUnit[this.unit]}${this.timezone ? `, ${this.timezone}` : ``}>`; }
}
_o = Symbol.toStringTag;
Timestamp_[_o] = ((proto) => {
proto.unit = null;
proto.timezone = null;
proto.ArrayType = BigInt64Array;
return proto[Symbol.toStringTag] = 'Timestamp';
})(Timestamp_.prototype);
export { Timestamp_ as Timestamp };
/** @ignore */
export class TimestampSecond extends Timestamp_ {
constructor(timezone) { super(TimeUnit.SECOND, timezone); }
}
/** @ignore */
export class TimestampMillisecond extends Timestamp_ {
constructor(timezone) { super(TimeUnit.MILLISECOND, timezone); }
}
/** @ignore */
export class TimestampMicrosecond extends Timestamp_ {
constructor(timezone) { super(TimeUnit.MICROSECOND, timezone); }
}
/** @ignore */
export class TimestampNanosecond extends Timestamp_ {
constructor(timezone) { super(TimeUnit.NANOSECOND, timezone); }
}
/** @ignore */
class Interval_ extends DataType {
constructor(unit) {
super(Type.Interval);
this.unit = unit;
}
toString() { return `Interval<${IntervalUnit[this.unit]}>`; }
}
_p = Symbol.toStringTag;
Interval_[_p] = ((proto) => {
proto.unit = null;
proto.ArrayType = Int32Array;
return proto[Symbol.toStringTag] = 'Interval';
})(Interval_.prototype);
export { Interval_ as Interval };
/** @ignore */
export class IntervalDayTime extends Interval_ {
constructor() { super(IntervalUnit.DAY_TIME); }
}
/** @ignore */
export class IntervalYearMonth extends Interval_ {
constructor() { super(IntervalUnit.YEAR_MONTH); }
}
/** @ignore */
export class Duration extends DataType {
constructor(unit) {
super(Type.Duration);
this.unit = unit;
}
toString() { return `Duration<${TimeUnit[this.unit]}>`; }
}
_q = Symbol.toStringTag;
Duration[_q] = ((proto) => {
proto.unit = null;
proto.ArrayType = BigInt64Array;
return proto[Symbol.toStringTag] = 'Duration';
})(Duration.prototype);
/** @ignore */
export class DurationSecond extends Duration {
constructor() { super(TimeUnit.SECOND); }
}
/** @ignore */
export class DurationMillisecond extends Duration {
constructor() { super(TimeUnit.MILLISECOND); }
}
/** @ignore */
export class DurationMicrosecond extends Duration {
constructor() { super(TimeUnit.MICROSECOND); }
}
/** @ignore */
export class DurationNanosecond extends Duration {
constructor() { super(TimeUnit.NANOSECOND); }
}
/** @ignore */
export class List extends DataType {
constructor(child) {
super(Type.List);
this.children = [child];
}
toString() { return `List<${this.valueType}>`; }
get valueType() { return this.children[0].type; }
get valueField() { return this.children[0]; }
get ArrayType() { return this.valueType.ArrayType; }
}
_r = Symbol.toStringTag;
List[_r] = ((proto) => {
proto.children = null;
return proto[Symbol.toStringTag] = 'List';
})(List.prototype);
/** @ignore */
export class Struct extends DataType {
constructor(children) {
super(Type.Struct);
this.children = children;
}
toString() { return `Struct<{${this.children.map((f) => `${f.name}:${f.type}`).join(`, `)}}>`; }
}
_s = Symbol.toStringTag;
Struct[_s] = ((proto) => {
proto.children = null;
return proto[Symbol.toStringTag] = 'Struct';
})(Struct.prototype);
/** @ignore */
class Union_ extends DataType {
constructor(mode, typeIds, children) {
super(Type.Union);
this.mode = mode;
this.children = children;
this.typeIds = typeIds = Int32Array.from(typeIds);
this.typeIdToChildIndex = typeIds.reduce((typeIdToChildIndex, typeId, idx) => (typeIdToChildIndex[typeId] = idx) && typeIdToChildIndex || typeIdToChildIndex, Object.create(null));
}
toString() {
return `${this[Symbol.toStringTag]}<${this.children.map((x) => `${x.type}`).join(` | `)}>`;
}
}
_t = Symbol.toStringTag;
Union_[_t] = ((proto) => {
proto.mode = null;
proto.typeIds = null;
proto.children = null;
proto.typeIdToChildIndex = null;
proto.ArrayType = Int8Array;
return proto[Symbol.toStringTag] = 'Union';
})(Union_.prototype);
export { Union_ as Union };
/** @ignore */
export class DenseUnion extends Union_ {
constructor(typeIds, children) {
super(UnionMode.Dense, typeIds, children);
}
}
/** @ignore */
export class SparseUnion extends Union_ {
constructor(typeIds, children) {
super(UnionMode.Sparse, typeIds, children);
}
}
/** @ignore */
export class FixedSizeBinary extends DataType {
constructor(byteWidth) {
super(Type.FixedSizeBinary);
this.byteWidth = byteWidth;
}
toString() { return `FixedSizeBinary[${this.byteWidth}]`; }
}
_u = Symbol.toStringTag;
FixedSizeBinary[_u] = ((proto) => {
proto.byteWidth = null;
proto.ArrayType = Uint8Array;
return proto[Symbol.toStringTag] = 'FixedSizeBinary';
})(FixedSizeBinary.prototype);
/** @ignore */
export class FixedSizeList extends DataType {
constructor(listSize, child) {
super(Type.FixedSizeList);
this.listSize = listSize;
this.children = [child];
}
get valueType() { return this.children[0].type; }
get valueField() { return this.children[0]; }
get ArrayType() { return this.valueType.ArrayType; }
toString() { return `FixedSizeList[${this.listSize}]<${this.valueType}>`; }
}
_v = Symbol.toStringTag;
FixedSizeList[_v] = ((proto) => {
proto.children = null;
proto.listSize = null;
return proto[Symbol.toStringTag] = 'FixedSizeList';
})(FixedSizeList.prototype);
/** @ignore */
export class Map_ extends DataType {
constructor(entries, keysSorted = false) {
var _y, _z, _0;
super(Type.Map);
this.children = [entries];
this.keysSorted = keysSorted;
// ARROW-8716
// https://github.com/apache/arrow/issues/17168
if (entries) {
entries['name'] = 'entries';
if ((_y = entries === null || entries === void 0 ? void 0 : entries.type) === null || _y === void 0 ? void 0 : _y.children) {
const key = (_z = entries === null || entries === void 0 ? void 0 : entries.type) === null || _z === void 0 ? void 0 : _z.children[0];
if (key) {
key['name'] = 'key';
}
const val = (_0 = entries === null || entries === void 0 ? void 0 : entries.type) === null || _0 === void 0 ? void 0 : _0.children[1];
if (val) {
val['name'] = 'value';
}
}
}
}
get keyType() { return this.children[0].type.children[0].type; }
get valueType() { return this.children[0].type.children[1].type; }
get childType() { return this.children[0].type; }
toString() { return `Map<{${this.children[0].type.children.map((f) => `${f.name}:${f.type}`).join(`, `)}}>`; }
}
_w = Symbol.toStringTag;
Map_[_w] = ((proto) => {
proto.children = null;
proto.keysSorted = null;
return proto[Symbol.toStringTag] = 'Map_';
})(Map_.prototype);
/** @ignore */
const getId = ((atomicDictionaryId) => () => ++atomicDictionaryId)(-1);
/** @ignore */
export class Dictionary extends DataType {
constructor(dictionary, indices, id, isOrdered) {
super(Type.Dictionary);
this.indices = indices;
this.dictionary = dictionary;
this.isOrdered = isOrdered || false;
this.id = id == null ? getId() : bigIntToNumber(id);
}
get children() { return this.dictionary.children; }
get valueType() { return this.dictionary; }
get ArrayType() { return this.dictionary.ArrayType; }
toString() { return `Dictionary<${this.indices}, ${this.dictionary}>`; }
}
_x = Symbol.toStringTag;
Dictionary[_x] = ((proto) => {
proto.id = null;
proto.indices = null;
proto.isOrdered = null;
proto.dictionary = null;
return proto[Symbol.toStringTag] = 'Dictionary';
})(Dictionary.prototype);
/** @ignore */
export function strideForType(type) {
const t = type;
switch (type.typeId) {
case Type.Decimal: return type.bitWidth / 32;
case Type.Interval: return 1 + t.unit;
// case Type.Int: return 1 + +((t as Int_).bitWidth > 32);
// case Type.Time: return 1 + +((t as Time_).bitWidth > 32);
case Type.FixedSizeList: return t.listSize;
case Type.FixedSizeBinary: return t.byteWidth;
default: return 1;
}
}
//# sourceMappingURL=type.mjs.map