dolphindb 2.0.800 → 2.0.801

package/browser.d.ts

@@ -262,7 +262,7 @@ export declare class DdbObj<TValue extends DdbValue = DdbValue> {
     to_cols(): {
         title: string;
         dataIndex: string;
-        render?: any;
+        render: (value: any) => string;
     }[];
     to_rows<T extends Record<string, any> = Record<string, any>>(): T[];
     /** Automatically convert dict<string, any> to js object (Record<string, any>)
@@ -283,10 +283,14 @@ export interface InspectOptions {
     colors?: boolean;
     /** decimal places */
     decimals?: number;
+    /** `false` 决定 null 值如何返回. nullstr ? 'null' : '' */
+    nullstr?: boolean;
+    /** `false` 决定 string, symbol, char 类型是否加引号 */
+    quote?: boolean;
 }
 /** Formats a single element (value) as a string according to DdbType, null returns a 'null' string */
 export declare function format(type: DdbType, value: DdbValue, le: boolean, options?: InspectOptions): string;
-/** formatted vector, the index-th item in the collection is a string, a null value returns a 'null' string */
+/** formatted vector, the index-th item in the collection is a string */
 export declare function formati(obj: DdbVectorObj, index: number, options?: InspectOptions): string;
 export declare class DdbVoid extends DdbObj<undefined> {
     constructor();
@@ -442,6 +446,10 @@ export interface StreamingData extends StreamingParams {
     };
 }
 export declare const winsize: 40;
+export declare class ConnectionError extends Error {
+    ddb: DDB;
+    constructor(ddb: DDB);
+}
 export declare class DDB {
     /** 当前的 session id (http 或 tcp) */
     sid: string;
@@ -508,23 +516,10 @@ export declare class DDB {
         streaming?: StreamingParams;
     });
     private on_message;
-    /** Establish the actual WebSocket connection to the DolphinDB corresponding to the URL
-        - options?:
-            - url?: DolphinDB WebSocket URL. By default, the WebSocket URL passed in when the instance is initialized is used
-            - autologin?: Whether to log in automatically after establishing a connection, default `true`
-            - username?: DolphinDB username, default `'admin'`
-            - password?: DolphinDB password, default `'123456'`
-            - python?: set python session flag, default `false`
-            - streaming?: When this option is set, the WebSocket connection is only used for streaming data
-    */
-    connect({ url, autologin, username, password, python, streaming }?: {
-        url?: string;
-        autologin?: boolean;
-        username?: string;
-        password?: string;
-        python?: boolean;
-        streaming?: StreamingParams;
-    }): Promise<void>;
+    /** Establish a actual websocket connection to the DolphindB corresponding to the URL
+        After calling, it will ensure that it has been connected to the database (ensure that websocket.ReadyState is open), otherwise an error will be reported
+        this.autologin automatically log in when it is true */
+    connect(): Promise<void>;
     get_rpc_options({ urgent, secondary, async: _async, pickle, clear, api, compress, cancellable, priority, parallelism, root_id, limit, }?: {
         urgent?: boolean;
         /** API 提交的任务, secondary 必须为 false */
@@ -550,6 +545,7 @@ export declare class DDB {
     }): string;
     disconnect(): void;
     /** rpc through websocket (function/script/variable command)
+        When the DDB is not connected, the call will be automatically connected. When the connection is disconnected, the call will throw the Connectionerror
         - type: API 类型: 'script' | 'function' | 'variable'
         - options:
             - urgent?: 决定 `行为标识` 那一行字符串的取值（只适用于 script 和 function）

package/browser.js

@@ -4,7 +4,7 @@ dayjs.extend(DayjsCustomParseFormat);
 import ipaddrjs from 'ipaddr.js';
 const { fromByteArray: buf2ipaddr } = ipaddrjs;
 import 'xshell/prototype.browser.js';
-import { blue } from 'xshell/chalk.browser.js';
+import { blue, cyan, green, grey, magenta } from 'xshell/chalk.browser.js';
 import { concat, assert } from 'xshell/utils.browser.js';
 import { connect_websocket } from 'xshell/net.browser.js';
 export var DdbForm;
@@ -1018,7 +1018,7 @@ export class DdbObj {
                 throw new Error(`vector ${DdbType[type]} 暂不支持序列化`);
         }
     }
-    toString(options) {
+    toString(options = { nullstr: true, quote: true }) {
         const type = this.inspect_type();
         const data = (() => {
             switch (this.form) {
@@ -1165,27 +1165,11 @@ export class DdbObj {
     }
     to_cols() {
         assert(this.form === DdbForm.table, 'form must be DdbForm.table, otherwise it cannot to_cols');
-        return this.value.map(col => {
-            let col_ = {
-                title: col.name,
-                dataIndex: col.name,
-            };
-            switch (col.type) {
-                case DdbType.char:
-                    col_.render = (value) => format(DdbType.char, value, this.le);
-                    break;
-                case DdbType.timestamp:
-                    col_.render = (value) => timestamp2str(value);
-                    break;
-                case DdbType.date:
-                    col_.render = (value) => date2str(value);
-                    break;
-                case DdbType.ipaddr:
-                    col_.render = (value) => ipaddr2str(value, this.le);
-                    break;
-            }
-            return col_;
-        });
+        return this.value.map(col => ({
+            title: col.name,
+            dataIndex: col.name,
+            render: (value) => format(col.type, value, col.le, { nullstr: false, quote: false })
+        }));
     }
     to_rows() {
         assert(this.form === DdbForm.table, 'form must be DdbForm.table, otherwise it cannot to_rows');
@@ -1242,8 +1226,8 @@ let _decimals = 20;
 let _formatter = Intl.NumberFormat('en-US', { maximumFractionDigits: 20 });
 /** Formats a single element (value) as a string according to DdbType, null returns a 'null' string */
 export function format(type, value, le, options = {}) {
+    const { decimals, nullstr = false, colors = false, quote = false } = options;
     const formatter = (() => {
-        const { decimals } = options;
         if (decimals === undefined || decimals === null)
             return default_formatter;
         if (decimals !== _decimals) {
@@ -1252,117 +1236,176 @@ export function format(type, value, le, options = {}) {
         }
         return _formatter;
     })();
+    function get_nullstr() {
+        return nullstr ?
+            colors ? grey('null') : 'null'
+            :
+                '';
+    }
     switch (type) {
         case DdbType.bool:
-            return String((value === null || value === nulls.int8) ?
-                null
-                :
-                    Boolean(value));
+            if (value === null || value === nulls.int8)
+                return get_nullstr();
+            else {
+                const str = String(Boolean(value));
+                return colors ? blue(str) : str;
+            }
         case DdbType.char:
-            return String((value === null || value === nulls.int8) ?
-                null
-                :
-                    // ascii printable
-                    // http://facweb.cs.depaul.edu/sjost/it212/documents/ascii-pr.htm
-                    (32 <= value && value <= 126) ?
-                        String.fromCharCode(value).quote()
-                        :
-                            value);
+            if (value === null || value === nulls.int8)
+                return get_nullstr();
+            else {
+                let str = 
+                // ascii printable
+                // http://facweb.cs.depaul.edu/sjost/it212/documents/ascii-pr.htm
+                (32 <= value && value <= 126) ?
+                    String.fromCharCode(value)
+                    :
+                        '\\' + String(value);
+                if (quote)
+                    str = str.quote();
+                return colors ? green(str) : str;
+            }
         case DdbType.short:
-            return (value === null || value === nulls.int16) ?
-                'null'
-                :
-                    default_formatter.format(value);
+            if (value === null || value === nulls.int16)
+                return get_nullstr();
+            else {
+                const str = default_formatter.format(value);
+                return colors ? green(str) : str;
+            }
         case DdbType.int:
-            return (value === null || value === nulls.int32) ?
-                'null'
-                :
-                    default_formatter.format(value);
+            if (value === null || value === nulls.int32)
+                return get_nullstr();
+            else {
+                const str = default_formatter.format(value);
+                return colors ? green(str) : str;
+            }
         case DdbType.long:
-            return (value === null || value === nulls.int64) ?
-                'null'
-                :
-                    default_formatter.format(value);
+            if (value === null || value === nulls.int64)
+                return get_nullstr();
+            else {
+                const str = default_formatter.format(value);
+                return colors ? green(str) : str;
+            }
         case DdbType.date:
-            return (value === null || value === nulls.int32) ?
-                'null'
-                :
-                    date2str(value);
+            if (value === null || value === nulls.int16)
+                return get_nullstr();
+            else {
+                const str = date2str(value);
+                return colors ? magenta(str) : str;
+            }
         case DdbType.month:
-            return (value === null || value === nulls.int32) ?
-                'null'
-                :
-                    month2str(value);
+            if (value === null || value === nulls.int32)
+                return get_nullstr();
+            else {
+                const str = month2str(value);
+                return colors ? magenta(str) : str;
+            }
         case DdbType.time:
-            return (value === null || value === nulls.int32) ?
-                'null'
-                :
-                    time2str(value);
+            if (value === null || value === nulls.int32)
+                return get_nullstr();
+            else {
+                const str = time2str(value);
+                return colors ? magenta(str) : str;
+            }
         case DdbType.minute:
-            return (value === null || value === nulls.int32) ?
-                'null'
-                :
-                    minute2str(value);
+            if (value === null || value === nulls.int16)
+                return get_nullstr();
+            else {
+                const str = minute2str(value);
+                return colors ? magenta(str) : str;
+            }
         case DdbType.second:
-            return (value === null || value === nulls.int32) ?
-                'null'
-                :
-                    second2str(value);
+            if (value === null || value === nulls.int32)
+                return get_nullstr();
+            else {
+                const str = second2str(value);
+                return colors ? magenta(str) : str;
+            }
         case DdbType.datetime:
-            return (value === null || value === nulls.int32) ?
-                'null'
-                :
-                    datetime2str(value);
+            if (value === null || value === nulls.int32)
+                return get_nullstr();
+            else {
+                const str = datetime2str(value);
+                return colors ? magenta(str) : str;
+            }
         case DdbType.timestamp:
-            return (value === null || value === nulls.int64) ?
-                'null'
-                :
-                    timestamp2str(value);
+            if (value === null || value === nulls.int64)
+                return get_nullstr();
+            else {
+                const str = timestamp2str(value);
+                return colors ? magenta(str) : str;
+            }
         case DdbType.nanotime:
-            return (value === null || value === nulls.int64) ?
-                'null'
-                :
-                    nanotime2str(value);
+            if (value === null || value === nulls.int64)
+                return get_nullstr();
+            else {
+                const str = nanotime2str(value);
+                return colors ? magenta(str) : str;
+            }
         case DdbType.nanotimestamp:
-            return (value === null || value === nulls.int64) ?
-                'null'
-                :
-                    nanotimestamp2str(value);
+            if (value === null || value === nulls.int64)
+                return get_nullstr();
+            else {
+                const str = nanotimestamp2str(value);
+                return colors ? magenta(str) : str;
+            }
         case DdbType.float:
-            return (value === null || value === nulls.float32) ?
-                'null'
-                :
-                    formatter.format(value);
+            if (value === null || value === nulls.float32)
+                return get_nullstr();
+            else {
+                const str = formatter.format(value);
+                return colors ? green(str) : str;
+            }
         case DdbType.double:
-            return (value === null || value === nulls.double) ?
-                'null'
-                :
-                    formatter.format(value);
+            if (value === null || value === nulls.double)
+                return get_nullstr();
+            else {
+                const str = formatter.format(value);
+                return colors ? green(str) : str;
+            }
         case DdbType.symbol:
-        case DdbType.string:
-            return value.quote('single');
-        case DdbType.uuid:
-            return uuid2str(value, le);
-        case DdbType.functiondef:
-            return value.name.quote('single');
+        case DdbType.string: {
+            let str = value;
+            if (quote)
+                str = str.quote('single');
+            return colors ? cyan(str) : str;
+        }
+        case DdbType.uuid: {
+            const str = uuid2str(value, le);
+            return colors ? cyan(str) : str;
+        }
+        case DdbType.functiondef: {
+            const str = value.name.quote('single');
+            return colors ? cyan(str) : str;
+        }
         case DdbType.handle:
         case DdbType.code:
-        case DdbType.resource:
-            return value.quote('single');
+        case DdbType.resource: {
+            const str = value.quote('single');
+            return colors ? cyan(str) : str;
+        }
         case DdbType.datehour:
-            return (value === null || value === nulls.int32) ?
-                'null'
-                :
-                    datehour2str(value);
-        case DdbType.ipaddr:
-            return ipaddr2str(value, le);
-        case DdbType.int128:
-            return int1282str(value, le);
-        case DdbType.blob:
-            return (value.length > 100 ?
+            if (value === null || value === nulls.int32)
+                return get_nullstr();
+            else {
+                const str = datehour2str(value);
+                return colors ? magenta(str) : str;
+            }
+        case DdbType.ipaddr: {
+            const str = ipaddr2str(value, le);
+            return colors ? cyan(str) : str;
+        }
+        case DdbType.int128: {
+            const str = int1282str(value, le);
+            return colors ? cyan(str) : str;
+        }
+        case DdbType.blob: {
+            const str = value.length > 100 ?
                 DdbObj.dec.decode(value.subarray(0, 98)) + '…'
                 :
-                    DdbObj.dec.decode(value)).quote('single');
+                    DdbObj.dec.decode(value);
+            return colors ? cyan(str) : str;
+        }
         case DdbType.point: {
             const [x, y] = value;
             return `(${format(DdbType.double, x, le, options)}, ${format(DdbType.double, y, le, options)})`;
@@ -1373,7 +1416,8 @@ export function format(type, value, le, options = {}) {
         }
         case DdbType.duration: {
             const { data, unit } = value;
-            return `${data}${DdbDurationUnit[unit]}`;
+            const str = `${data}${DdbDurationUnit[unit]}`;
+            return colors ? magenta(str) : str;
         }
         case DdbType.decimal32:
         case DdbType.decimal64: {
@@ -1381,15 +1425,16 @@ export function format(type, value, le, options = {}) {
             if (data === null ||
                 (data === nulls.int64 && type === DdbType.decimal64) ||
                 (data === nulls.int32 && type === DdbType.decimal32))
-                return 'null';
+                return get_nullstr();
             const s = String(data < 0 ? -data : data).padStart(scale, '0');
-            return (data < 0 ? '-' : '') + (scale ? `${s.slice(0, -scale) || '0'}.${s.slice(-scale)}` : s);
+            const str = (data < 0 ? '-' : '') + (scale ? `${s.slice(0, -scale) || '0'}.${s.slice(-scale)}` : s);
+            return colors ? green(str) : str;
         }
         default:
             return String(value);
     }
 }
-/** formatted vector, the index-th item in the collection is a string, a null value returns a 'null' string */
+/** formatted vector, the index-th item in the collection is a string */
 export function formati(obj, index, options = {}) {
     if (64 <= obj.type && obj.type < 128) { // array vector
         // 因为 array vector 目前只支持：Logical, Integral（不包括 INT128, COMPRESS 类型）, Floating, Temporal
@@ -1424,12 +1469,9 @@ export function formati(obj, index, options = {}) {
         }
     }
     switch (obj.type) {
-        case DdbType.string:
-        case DdbType.symbol:
-            return obj.value[index];
         case DdbType.symbol_extended: {
             const { base, data } = obj.value;
-            return base[data[index]];
+            return format(DdbType.string, base[data[index]], obj.le, options);
         }
         case DdbType.uuid:
         case DdbType.int128:
@@ -1453,7 +1495,8 @@ export function formati(obj, index, options = {}) {
                 x === nulls.int32 && obj.type === DdbType.decimal32)
                 return '';
             const s = String(x < 0 ? -x : x).padStart(scale, '0');
-            return (x < 0 ? '-' : '') + (scale ? `${s.slice(0, -scale) || '0'}.${s.slice(-scale)}` : s);
+            const str = (x < 0 ? '-' : '') + (scale ? `${s.slice(0, -scale) || '0'}.${s.slice(-scale)}` : s);
+            return options.colors ? green(str) : str;
         }
         default:
             return format(obj.type, obj.value[index], obj.le, options);
@@ -1972,6 +2015,13 @@ export function int1282str(buffer, le = true) {
         .padStart(2, '0')).join('');
 }
 export const winsize = 40;
+export class ConnectionError extends Error {
+    ddb;
+    constructor(ddb) {
+        super(`websocket is disconnected: ${ddb.url}`);
+        this.ddb = ddb;
+    }
+}
 export class DDB {
     /** 当前的 session id (http 或 tcp) */
     sid = '0';
@@ -2053,52 +2103,50 @@ export class DDB {
             this.streaming = options.streaming;
     }
     on_message(event) {
-        console.log('This is the default on_message before calling this.rpc, it should not be called unless the server pushes the message first after the connection is established');
-        console.log(event.data);
+        // 这里的实现一定会被 connect 中的实现覆盖
     }
-    /** Establish the actual WebSocket connection to the DolphinDB corresponding to the URL
-        - options?:
-            - url?: DolphinDB WebSocket URL. By default, the WebSocket URL passed in when the instance is initialized is used
-            - autologin?: Whether to log in automatically after establishing a connection, default `true`
-            - username?: DolphinDB username, default `'admin'`
-            - password?: DolphinDB password, default `'123456'`
-            - python?: set python session flag, default `false`
-            - streaming?: When this option is set, the WebSocket connection is only used for streaming data
-    */
-    async connect({ url, autologin, username, password, python, streaming } = {}) {
-        if (url !== undefined)
-            this.url = url;
-        if (autologin !== undefined)
-            this.autologin = autologin;
-        if (username !== undefined)
-            this.username = username;
-        if (password !== undefined)
-            this.password = password;
-        if (python !== undefined)
-            this.python = python;
-        if (streaming !== undefined)
-            this.streaming = streaming;
-        this.disconnect();
-        await connect_websocket(this.url, {
-            protocols: (() => {
-                if (this.streaming)
-                    return 'streaming';
-                if (this.python)
-                    return 'python';
-            })(),
-            on_open: async (event, websocket) => {
-                this.websocket = websocket;
+    /** Establish a actual websocket connection to the DolphindB corresponding to the URL
+        After calling, it will ensure that it has been connected to the database (ensure that websocket.ReadyState is open), otherwise an error will be reported
+        this.autologin automatically log in when it is true */
+    async connect() {
+        if (this.connected)
+            return;
+        const ptail = this.pconnect;
+        let resolve;
+        this.pconnect = new Promise((_resolve, _reject) => {
+            resolve = _resolve;
+        });
+        await ptail;
+        try {
+            if (!this.connected) {
+                this.on_message = (event) => {
+                    assert(false, 'This is the default on_message before calling this.rpc, and it should not be called. Unless the server pushed message first after the connection is established');
+                };
+                this.presult = Promise.resolve(null);
+                this.pnode_run_defined = false;
+                this.websocket = await connect_websocket(this.url, {
+                    protocols: (() => {
+                        if (this.streaming)
+                            return 'streaming';
+                        if (this.python)
+                            return 'python';
+                    })(),
+                    on_message: (event) => {
+                        this.on_message(event);
+                    }
+                });
                 if (this.streaming)
                     await this.subscribe();
-                else
+                else {
                     await this.rpc('connect', {});
-            },
-            on_message: (event) => {
-                this.on_message(event);
+                    if (this.autologin)
+                        await this.call('login', [this.username, this.password], { urgent: true });
+                }
             }
-        });
-        if (!this.streaming && this.autologin)
-            await this.call('login', [this.username, this.password], { urgent: true });
+        }
+        finally {
+            resolve();
+        }
     }
     get_rpc_options({ urgent = false, secondary = false, async: _async = false, pickle = false, clear = false, api = false, compress = false, cancellable = true, priority = urgent ? 8 : 4, parallelism = 8, root_id = '', limit, } = {}) {
         let flag = 0;
@@ -2134,12 +2182,9 @@ export class DDB {
     disconnect() {
         if (this.connected)
             this.websocket.close(1000);
-        this.on_message = () => { };
-        this.presult = Promise.resolve(null);
-        this.pconnect = Promise.resolve();
-        this.pnode_run_defined = false;
     }
     /** rpc through websocket (function/script/variable command)
+        When the DDB is not connected, the call will be automatically connected. When the connection is disconnected, the call will throw the Connectionerror
         - type: API 类型: 'script' | 'function' | 'variable'
         - options:
             - urgent?: 决定 `行为标识` 那一行字符串的取值（只适用于 script 和 function）
@@ -2149,24 +2194,12 @@ export class DDB {
                 为 false 时返回的 DdbObj 仅含有 buffer 和 le，不做解析，以便后续转发、序列化
     */
     async rpc(type, { script, func, args = [], vars = [], urgent, listener, parse_object, }) {
-        if (!this.websocket) {
-            const ptail = this.pconnect;
-            let resolve;
-            this.pconnect = new Promise((_resolve, _reject) => {
-                resolve = _resolve;
-            });
-            await ptail;
-            try {
-                if (!this.websocket)
-                    await this.connect();
-            }
-            finally {
-                resolve();
-            }
-        }
+        if (!this.websocket)
+            await this.connect();
         if (!this.connected)
-            throw new Error(`${this.url} is already disconnected`);
+            throw new ConnectionError(this);
         if (func === 'pnode_run' && !this.pnode_run_defined) {
+            // 保证并发调用 rpc 时只定义一次 pnode_run
             const ptail = this.ppnoderun;
             let resolve;
             this.ppnoderun = new Promise((_resolve, _reject) => {
@@ -2464,7 +2497,7 @@ export class DDB {
                         if (status === StreamingStatusCode.ok)
                             console.log('Subscribed to streaming table:', { status: StreamingStatusCode[status], result: objs[0] });
                         else
-                            reject(new Error(`Failed to subscribe to streaming table: { status: ${StreamingStatusCode[status]}, error: ${objs[0]?.value} }`));
+                            reject(new Error(`Failed to subscribe to streaming table: { status: ${StreamingStatusCode[status]}, error: '${objs[0]?.value}' }`));
                     }
                     catch (error) {
                         reject(error);
@@ -2496,7 +2529,7 @@ export class DDB {
                             // 是 column 片段组成的 any vector
                             const data = streaming.data = DdbObj.parse(buf.subarray(i_topic_end + 1), this.le);
                             let { window: win } = streaming;
-                            win.rows += data.rows;
+                            win.rows += data.value[0].rows;
                             win.segments.push(data);
                             if (win.rows >= winsize * 2 && win.segments.length >= 2) {
                                 let winsize_ = 0;