dolphindb 0.0.2 → 0.0.6

package/browser.d.ts

@@ -66,16 +66,24 @@ export interface DdbFunctionDefValue {
 export interface DdbSymbolExtendedValue {
     base_id: number;
     base: string[];
-    value: Uint32Array;
+    data: Uint32Array;
 }
-export declare type DdbValue = null | boolean | number | [number, number] | bigint | string | string[] | Uint8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | Uint8Array[] | DdbObj[] | DdbFunctionDefValue | DdbSymbolExtendedValue;
-export declare type DdbVectorValue = string | string[] | Uint8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | Uint8Array[] | DdbObj[] | DdbSymbolExtendedValue;
+export interface DdbArrayVectorBlock {
+    unit: 1 | 2 | 4;
+    rows: number;
+    lengths: Uint8Array | Uint16Array | Uint32Array;
+    data: DdbVectorValue;
+}
+export declare type DdbValue = null | boolean | number | [number, number] | bigint | string | string[] | Uint8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | Uint8Array[] | DdbObj[] | DdbFunctionDefValue | DdbSymbolExtendedValue | DdbArrayVectorBlock[];
+export declare type DdbVectorValue = string | string[] | Uint8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | Uint8Array[] | DdbObj[] | DdbSymbolExtendedValue | DdbArrayVectorBlock[];
 export declare const nulls: {
     readonly char: "€";
     readonly int16: -32768;
     readonly int32: -2147483648;
     readonly int64: -9223372036854775808n;
 };
+export declare const timezone_offset: number;
+/** 可以表示所有 DolphinDB 数据库中的数据类型 */
 export declare class DdbObj<T extends DdbValue = DdbValue> {
     static dec: TextDecoder;
     static enc: TextEncoder;
@@ -128,8 +136,16 @@ export declare class DdbObj<T extends DdbValue = DdbValue> {
     pack(): Uint8Array;
     static pack_vector_body(value: DdbVectorValue, type: DdbType, length: number): ArrayBufferView[];
     toString(): string;
-    to_cols(): any[];
+    to_cols(): {
+        title: string;
+        dataIndex: string;
+        render?: any;
+    }[];
     to_rows<T extends Record<string, any> = Record<string, any>>(): T[];
+    to_dict<T = Record<string, any>>(): T;
+}
+export declare class DdbVoid extends DdbObj<undefined> {
+    constructor();
 }
 export declare class DdbBool extends DdbObj<boolean> {
     constructor(value: boolean);
@@ -164,6 +180,8 @@ export declare class DdbPair extends DdbObj<Int32Array> {
 export declare class DdbFunction extends DdbObj<DdbFunctionDefValue> {
     constructor(name: string, type: DdbFunctionType);
 }
+export declare function date2str(date: number): string;
+export declare function timestamp2str(timestamp: bigint): string;
 export declare class DDB {
     /** 当前的 session id (http 或 tcp) */
     sid: string;
@@ -176,6 +194,8 @@ export declare class DDB {
     le: boolean;
     /** little endian (client) */
     static le_client: boolean;
+    /** print message handler */
+    printer(message: string): void;
     /** resolver, rejector, promise of last rpc */
     presolver(buf: Uint8Array): void;
     prejector(error: Error): void;
@@ -183,7 +203,7 @@ export declare class DDB {
     constructor(ws_url?: string);
     /** 连接到 DolphinDB Server */
     connect({ ws_url, login, username, password, }?: {
-        /** 默认使用实例初始化时传入的 WebSocket 链接地址 */
+        /** 默认使用实例初始化时传入的 WebSocket URL */
         ws_url?: string;
         /** 是否在建立连接后自动登录，默认 true */
         login?: boolean;
@@ -193,7 +213,7 @@ export declare class DDB {
         password?: string;
     }): Promise<void>;
     disconnect(): void;
-    /** rpc through websocket (function command)
+    /** rpc through websocket (function/script/variable command)
         - type: API 类型: 'script' | 'function' | 'variable'
         - options:
             - urgent?: 决定 `行为标识` 那一行字符串的取值（只适用于 script 和 function）
@@ -212,14 +232,14 @@ export declare class DDB {
     script: string, 
     /** 执行选项 */
     { urgent }?: {
-        /** 紧急 flag，使用 urgent worker 处理，防止被其它作业阻塞 */
+        /** 紧急 flag，确保提交的脚本使用 urgent worker 处理，防止被其它作业阻塞 */
         urgent?: boolean;
     }): Promise<T>;
     /** call function through websocket (function command)
         - func: 函数名
         - args?: `[ ]` 调用参数 (传入的原生 string 和 boolean 会被自动转换为 DdbObj<string> 和 DdbObj<boolean>)
         - options?: 调用选项
-            - urgent?: 紧急 flag，使用 urgent worker 处理，防止被其它作业阻塞
+            - urgent?: 紧急 flag。使用 urgent worker 执行，防止被其它作业阻塞
             - node?: 设置结点 alias 时发送到集群中对应的结点执行 (使用 DolphinDB 中的 rpc 方法)
             - nodes?: 设置多个结点 alias 时发送到集群中对应的多个结点执行 (使用 DolphinDB 中的 pnodeRun 方法)
             - func_type?: 设置 node 参数时必传，需指定函数类型，其它情况下不传
@@ -239,7 +259,13 @@ export declare class DDB {
     /** 上传的变量值 */
     args: (DdbObj | string | boolean)[]): Promise<DdbObj<DdbValue>>;
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
-    parse_message(buf: Uint8Array): Uint8Array;
+    parse_message(buf: Uint8Array): {
+        type: "message";
+        data: string;
+    } | {
+        type: "object";
+        data: Uint8Array;
+    };
     /** 自动转换 js string, boolean 为 DdbObj */
     to_ddbobj(value: DdbObj | string | boolean): DdbObj;
     /** 转换 js 数组为 DdbObj[] (in place, 会修改原数组) */

package/browser.js

@@ -1,11 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ddb = exports.DDB = exports.DdbFunction = exports.DdbPair = exports.DdbVectorAny = exports.DdbVectorDouble = exports.DdbVectorString = exports.DdbVectorInt = exports.DdbDouble = exports.DdbLong = exports.DdbString = exports.DdbInt = exports.DdbBool = exports.DdbObj = exports.nulls = exports.DdbFunctionType = exports.DdbType = exports.DdbForm = void 0;
+exports.ddb = exports.DDB = exports.timestamp2str = exports.date2str = exports.DdbFunction = exports.DdbPair = exports.DdbVectorAny = exports.DdbVectorDouble = exports.DdbVectorString = exports.DdbVectorInt = exports.DdbDouble = exports.DdbLong = exports.DdbString = exports.DdbInt = exports.DdbBool = exports.DdbVoid = exports.DdbObj = exports.timezone_offset = exports.nulls = exports.DdbFunctionType = exports.DdbType = exports.DdbForm = void 0;
 const tslib_1 = require("tslib");
 const dayjs_1 = (0, tslib_1.__importDefault)(require("dayjs"));
 require("xshell/prototype.browser");
 const utils_browser_1 = require("xshell/utils.browser");
-const chalk_browser_1 = require("xshell/chalk.browser");
 var DdbForm;
 (function (DdbForm) {
     DdbForm[DdbForm["scalar"] = 0] = "scalar";
@@ -75,6 +74,8 @@ exports.nulls = {
     int32: -2147483648,
     int64: -0x8000000000000000n, // -922_3372_0368_5477_5808
 };
+exports.timezone_offset = 1000 * 60 * new Date().getTimezoneOffset();
+/** 可以表示所有 DolphinDB 数据库中的数据类型 */
 class DdbObj {
     constructor(data) {
         /** 是否为小端 (little endian) */
@@ -333,16 +334,86 @@ class DdbObj {
     static parse_vector(buf, le, type) {
         const dv = new DataView(buf.buffer, buf.byteOffset);
         const rows = dv.getUint32(0, le);
-        const i_items_start = 8;
-        const [len_items, value] = this.parse_vector_items(buf.subarray(i_items_start), le, type, rows);
+        let i_items_start = 8;
+        if (type < 64 || type >= 128) {
+            const [len_items, value] = this.parse_vector_items(buf.subarray(i_items_start), le, type, rows);
+            return new this({
+                le,
+                form: DdbForm.vector,
+                type,
+                length: i_items_start + len_items,
+                cols: 1,
+                rows,
+                value,
+            });
+        }
+        // array vector
+        // av = array(INT[], 0, 3)
+        // append!(av, [1..4])
+        // append!(av, [1..70000])
+        // av
+        // <Buffer 44 01  type = array vector, form = vector
+        // 02 00 00 00 74 11 01 00 rows = 2, cols = 70004 (0x011174)
+        // block 0
+        // 01 00 block.rows = 1
+        // 04 block.unit = 4
+        // 00 reserved
+        // 04 00 00 00 block.lengths = [4]
+        // 01 00 00 00 02 00 00 00 03 00 00 00 04 00 00 00 block.data
+        // block 1
+        // 01 00 block.rows = 1
+        // 04 block.unit = 4
+        // 00 reserved
+        // 70 11 01 00 block.lengths = [70000 (0x00011170)]
+        // 01 00 00 00 02 00 00 00 ... 279992 more bytes> block.data
+        const cols = dv.getUint32(4, le);
+        let blocks = [];
+        let i_block_start = i_items_start;
+        // 解析一个 block
+        for (let i_row = 0; i_row < rows;) {
+            /** 对应 array vector 中元素个数 */
+            const rows = dv.getUint16(i_block_start, le);
+            /** 每个 length 占用的字节数 */
+            const unit = dv.getUint8(i_block_start + 2);
+            /** array vector 每个元素的子元素长度 */
+            let lengths;
+            const i_lengths_start = i_block_start + 4;
+            const i_data_start = i_lengths_start + rows * unit;
+            const lengths_buf = buf.slice(i_lengths_start, i_data_start);
+            switch (unit) {
+                case 1:
+                    lengths = lengths_buf;
+                    break;
+                case 2:
+                    lengths = new Uint16Array(lengths_buf.buffer);
+                    break;
+                case 4:
+                    lengths = new Uint32Array(lengths_buf.buffer);
+                    break;
+                default:
+                    throw new Error(`array vector 存在非法 unit = ${unit}`);
+            }
+            let total_length = 0;
+            for (let i = 0; i < lengths.length; i++)
+                total_length += lengths[i];
+            const [len_items, data] = this.parse_vector_items(buf.subarray(i_data_start), le, type - 64, total_length);
+            blocks.push({
+                unit,
+                rows,
+                lengths,
+                data
+            });
+            i_block_start = i_data_start + len_items;
+            i_row += rows;
+        }
         return new this({
             le,
             form: DdbForm.vector,
             type,
-            length: i_items_start + len_items,
-            cols: 1,
+            length: i_block_start,
+            cols,
             rows,
-            value,
+            value: blocks
         });
     }
     /** 有可能没有字节对齐，不能直接使用原有 message 的 arraybuffer, 统一复制出来，让原有 arraybuffer 被回收掉比较好 */
@@ -423,13 +494,13 @@ class DdbObj {
                 }
                 const value_start = 8 + base_length;
                 const value_end = value_start + length * 4;
-                const value = new Uint32Array(buf.buffer.slice(buf.byteOffset + value_start, buf.byteOffset + value_end));
+                const data = new Uint32Array(buf.buffer.slice(buf.byteOffset + value_start, buf.byteOffset + value_end));
                 return [
                     value_end,
                     {
                         base_id,
                         base,
-                        value
+                        data
                     }
                 ];
             }
@@ -554,11 +625,24 @@ class DdbObj {
                             return [Float64Array.from(this.value)];
                         case DdbType.duration:
                             return [value];
+                        case DdbType.handle:
+                            throw new Error('DolphinDB Server 不支持 handle 的反序列化');
                         default:
                             throw new Error(`${DdbType[type]} 暂时不支持序列化`);
                     }
                 case DdbForm.vector:
                 case DdbForm.pair:
+                    // pack array vector
+                    if (form === DdbForm.vector && 64 <= type && type < 128)
+                        return [
+                            Uint32Array.of(this.rows, this.cols),
+                            ...this.value.map(block => ([
+                                Uint16Array.of(block.rows),
+                                Uint8Array.of(block.unit, 0),
+                                block.lengths,
+                                block.data
+                            ])).flat()
+                        ];
                     return [
                         Uint32Array.of(this.rows, 1),
                         ...DdbObj.pack_vector_body(value, type, this.rows)
@@ -674,6 +758,14 @@ class DdbObj {
                     bufs[i] = value[i].pack();
                 return bufs;
             }
+            case DdbType.symbol_extended: {
+                const { base_id, base, data } = value;
+                return [
+                    Uint32Array.of(base_id, base.length),
+                    ...this.pack_vector_body(base, DdbType.string, base.length),
+                    data
+                ];
+            }
             default:
                 throw new Error(`vector ${DdbType[type]} 暂不支持序列化`);
         }
@@ -687,6 +779,8 @@ class DdbObj {
                         return `functiondef<${DdbFunctionType[this.value.type]}>`;
                     return tname;
                 case DdbForm.vector:
+                    if (64 <= this.type && this.type < 128)
+                        return `${DdbType[this.type - 64]}[][${this.rows}]`;
                     return `${tname}[${this.rows}]`;
                 case DdbForm.pair:
                     return `pair<${tname}>`;
@@ -709,7 +803,7 @@ class DdbObj {
                 return `'${this.value.name}'`;
             return this.value;
         })();
-        return `${(0, chalk_browser_1.blue)(type)}(${this.name ? `'${(0, chalk_browser_1.yellow)(this.name)}', ` : ''}${data})\n`;
+        return `${type}(${this.name ? `'${this.name}', ` : ''}${data})\n`;
     }
     to_cols() {
         return this.value.map(col => {
@@ -719,18 +813,10 @@ class DdbObj {
             };
             switch (col.type) {
                 case DdbType.timestamp:
-                    col_.render = (value) => {
-                        if (value === exports.nulls.int64)
-                            return '';
-                        return (0, dayjs_1.default)(Number(value)).format('YYYY.MM.DD HH:mm:ss.SSS');
-                    };
+                    col_.render = timestamp2str;
                     break;
                 case DdbType.date:
-                    col_.render = (value) => {
-                        if (value === exports.nulls.int32)
-                            return '';
-                        return (0, dayjs_1.default)(Number(1000 * 3600 * 24 * value)).format('YYYY.MM.DD');
-                    };
+                    col_.render = date2str;
                     break;
                 case DdbType.ipaddr:
                     col_.render = value => value.slice().reverse().join('.').replace(/^(0\.)+/, '');
@@ -755,6 +841,15 @@ class DdbObj {
         }
         return rows;
     }
+    to_dict() {
+        if (this.form !== DdbForm.dict)
+            throw new Error('this.form 不是 dict, 不能转换为 Object');
+        const [{ value: keys }, { value: values }] = this.value;
+        let obj = {};
+        for (let i = 0; i < this.rows; i++)
+            obj[keys[i]] = values[i].value;
+        return obj;
+    }
 }
 exports.DdbObj = DdbObj;
 DdbObj.dec = new TextDecoder('utf-8');
@@ -763,6 +858,16 @@ DdbObj.enc = new TextEncoder();
 DdbObj.symbol_bases = {};
 /** little endian (client) */
 DdbObj.le_client = Boolean(new Uint8Array(Uint32Array.of(1).buffer)[0]);
+class DdbVoid extends DdbObj {
+    constructor() {
+        super({
+            form: DdbForm.scalar,
+            type: DdbType.void,
+            length: 0,
+        });
+    }
+}
+exports.DdbVoid = DdbVoid;
 class DdbBool extends DdbObj {
     constructor(value) {
         super({
@@ -894,6 +999,20 @@ class DdbFunction extends DdbObj {
     }
 }
 exports.DdbFunction = DdbFunction;
+function date2str(date) {
+    return date === exports.nulls.int32 ?
+        ''
+        :
+            (0, dayjs_1.default)(exports.timezone_offset + 1000 * 3600 * 24 * date).format('YYYY.MM.DD');
+}
+exports.date2str = date2str;
+function timestamp2str(timestamp) {
+    return timestamp === exports.nulls.int64 ?
+        ''
+        :
+            (0, dayjs_1.default)(exports.timezone_offset + Number(timestamp)).format('YYYY.MM.DD HH:mm:ss.SSS');
+}
+exports.timestamp2str = timestamp2str;
 class DDB {
     constructor(ws_url) {
         /** 当前的 session id (http 或 tcp) */
@@ -913,6 +1032,10 @@ class DDB {
         }
         this.ws_url = ws_url;
     }
+    /** print message handler */
+    printer(message) {
+        console.log(message);
+    }
     /** resolver, rejector, promise of last rpc */
     presolver(buf) { }
     prejector(error) { }
@@ -943,7 +1066,12 @@ class DDB {
         });
         ws.addEventListener('message', ({ data: buf }) => {
             try {
-                this.presolver(this.parse_message(new Uint8Array(buf)));
+                const { type, data } = this.parse_message(new Uint8Array(buf));
+                if (type === 'message') {
+                    this.printer(data);
+                    return;
+                }
+                this.presolver(data);
             }
             catch (error) {
                 this.prejector(error);
@@ -972,7 +1100,7 @@ class DDB {
     disconnect() {
         this.ws?.close(1000);
     }
-    /** rpc through websocket (function command)
+    /** rpc through websocket (function/script/variable command)
         - type: API 类型: 'script' | 'function' | 'variable'
         - options:
             - urgent?: 决定 `行为标识` 那一行字符串的取值（只适用于 script 和 function）
@@ -1023,7 +1151,7 @@ class DDB {
             }
         })());
         const message = (0, utils_browser_1.concat)([
-            this.enc.encode(`API ${this.sid} ${command.length}${urgent ? ` / 1_1_8_8` : ''}\n`),
+            this.enc.encode(`API2 ${this.sid} ${command.length}${urgent ? ` / 1_1_8_8` : ''}\n`),
             command,
             ...args.map((arg) => arg.pack())
         ]);
@@ -1043,7 +1171,7 @@ class DDB {
         - func: 函数名
         - args?: `[ ]` 调用参数 (传入的原生 string 和 boolean 会被自动转换为 DdbObj<string> 和 DdbObj<boolean>)
         - options?: 调用选项
-            - urgent?: 紧急 flag，使用 urgent worker 处理，防止被其它作业阻塞
+            - urgent?: 紧急 flag。使用 urgent worker 执行，防止被其它作业阻塞
             - node?: 设置结点 alias 时发送到集群中对应的结点执行 (使用 DolphinDB 中的 rpc 方法)
             - nodes?: 设置多个结点 alias 时发送到集群中对应的多个结点执行 (使用 DolphinDB 中的 pnodeRun 方法)
             - func_type?: 设置 node 参数时必传，需指定函数类型，其它情况下不传
@@ -1087,6 +1215,14 @@ class DDB {
     }
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
     parse_message(buf) {
+        // MSG\n
+        // <message>\0
+        // 'M'.codePointAt(0).to_hex_str()
+        if (buf[0] === 0x4d && buf[1] === 0x53 && buf[2] === 0x47 && buf[3] === 0x0a)
+            return {
+                type: 'message',
+                data: this.dec.decode(buf.subarray(4))
+            };
         // '1166953221 1 1\n'
         // 'OK\n'
         // '\x04\x00\x02\x00\x00\x00'
@@ -1109,7 +1245,10 @@ class DDB {
         const message = this.dec.decode(buf.subarray(i_ls_1, i_lf_1));
         if (message !== 'OK')
             throw new Error(message);
-        return buf.subarray(i_lf_1 + 1);
+        return {
+            type: 'object',
+            data: buf.subarray(i_lf_1 + 1)
+        };
     }
     /** 自动转换 js string, boolean 为 DdbObj */
     to_ddbobj(value) {