dolphindb 2.0.914 → 2.0.916

package/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" resolution-mode="require"/>
 import type { InspectOptions as UtilInspectOptions } from 'util';
-import { inspect } from 'xshell/utils.js';
+import { inspect } from 'xshell';
 export declare enum DdbForm {
     scalar = 0,
     vector = 1,
@@ -17,8 +17,8 @@ export declare enum DdbForm {
     object = 9
 }
 /** DolphinDB DataType
-    对应的 array vector 类型为 64 + 基本类型
-    对应的 extended 类型为 128 + 基本类型
+    对应的 array vector 类型为 64 + 基本类型  The corresponding array vector type is 64 + base type
+    对应的 extended 类型为 128 + 基本类型  The corresponding extended type is 128 + base type
 */
 export declare enum DdbType {
     void = 0,
@@ -181,6 +181,7 @@ Uint8Array[] | // blob
 DdbObj[] | // any
 DdbSymbolExtendedValue | DdbArrayVectorValue | DdbDecimal32VectorValue | DdbDecimal64VectorValue;
 export type DdbValue = DdbScalarValue | DdbVectorValue | DdbMatrixValue | DdbDictValue | DdbChartValue;
+export type DdbStringObj = DdbObj<string>;
 export type DdbVectorObj = DdbObj<DdbVectorValue>;
 export type DdbVectorAnyObj = DdbObj<DdbObj[]>;
 export type DdbVectorStringObj = DdbObj<string[]>;
@@ -230,7 +231,8 @@ export declare class DdbObj<TValue extends DdbValue = DdbValue> {
     rows?: number;
     /** 第 2 维 */
     cols?: number;
-    /** 实际数据。不同的 DdbForm, DdbType 使用 DdbValue 中不同的类型来表示实际数据  The actual data. Different DdbForm, DdbType use different types in DdbValue to represent actual data */
+    /** 实际数据。不同的 DdbForm, DdbType 使用 DdbValue 中不同的类型来表示实际数据
+        The actual data. Different DdbForm, DdbType use different types in DdbValue to represent actual data */
     value: TValue;
     /** 原始二进制数据，仅在 parse_object 为 false 时通过 parse_message 生成的顶层对象有这个属性 */
     buffer?: Uint8Array;
@@ -258,7 +260,7 @@ export declare class DdbObj<TValue extends DdbValue = DdbValue> {
     /** 转换 js 数组为 DdbObj[] */
     static to_ddbobjs(values: any[]): DdbObj<DdbValue>[];
     to_rows<T extends Record<string, any> = Record<string, any>>(): T[];
-    /** 将 dict<string, any> 自动转换为 js object (Record<string, any>)  convert dict<string, any> to js object (Record<string, any>)
+    /** 将 dict<string, any> 自动转换为 js object (Record<string, any>)  Automatically convert dict<string, any> to js object (Record<string, any>)
         - options?:
             - strip?: `false` 是否将 DdbObj 中的 value 直接提取、剥离出来作为 js object 的 value (丢弃 DdbObj 中的其余信息，只保留 value)
                 Whether to directly extract and strip the value in DdbObj as the value of js object (discard the rest of the information in DdbObj, only keep the value)
@@ -442,9 +444,25 @@ export interface StreamingData extends StreamingParams {
     error?: Error;
 }
 export declare const winsize: 100000;
-export declare class ConnectionError extends Error {
+type DdbRpcType = 'script' | 'function' | 'variable' | 'connect';
+export interface DdbRpcOptions {
+    script?: string;
+    func?: string;
+    args?: (DdbObj | string | boolean)[];
+    vars?: string[];
+    urgent?: boolean;
+    listener?: DdbMessageListener;
+    parse_object?: boolean;
+}
+export declare class DdbConnectionError extends Error {
     ddb: DDB;
-    constructor(ddb: DDB);
+    constructor(ddb: DDB, error_options?: ErrorOptions);
+}
+export declare class DdbDatabaseError extends Error {
+    ddb: DDB;
+    type: DdbRpcType;
+    options: DdbRpcOptions;
+    constructor(message: string, ddb: DDB, type: DdbRpcType, options: DdbRpcOptions);
 }
 export declare class DDB {
     /** 当前的 session id (http 或 tcp) */
@@ -541,7 +559,8 @@ export declare class DDB {
     }): string;
     disconnect(): void;
     /** rpc through websocket (function/script/variable command)
-        未连接到 DDB 时调用会自动连接，连接断开时调用会抛出 ConnectionError  When the DDB is not connected, the call will be automatically connected. When the connection is disconnected, the call will throw the Connectionerror
+        未连接到 DDB 时调用会自动连接，连接断开时调用会抛出 DdbConnectionError
+        When the DDB is not connected, the call will be automatically connected. When the connection is disconnected, the call will throw the DdbConnectionError
         - type: API 类型: 'script' | 'function' | 'variable'
         - options:
             - urgent?: 决定 `行为标识` 那一行字符串的取值（只适用于 script 和 function）
@@ -550,22 +569,13 @@ export declare class DDB {
             - parse_object?: 在本次 rpc 期间设置 parse_object, 结束后恢复原有
                 为 false 时返回的 DdbObj 仅含有 buffer 和 le，不做解析，以便后续转发、序列化
     */
-    rpc<T extends DdbObj = DdbObj>(type: 'script' | 'function' | 'variable' | 'connect', { script, func, args, vars, urgent, listener, parse_object, }: {
-        script?: string;
-        func?: string;
-        args?: (DdbObj | string | boolean)[];
-        vars?: string[];
-        urgent?: boolean;
-        listener?: DdbMessageListener;
-        parse_object?: boolean;
-    }): Promise<T>;
+    rpc<T extends DdbObj = DdbObj>(type: DdbRpcType, options: DdbRpcOptions): Promise<T>;
     /** eval script through websocket (script command)
         - script?: 执行的脚本  Script to execute
         - options?: 执行选项  execution options
             - urgent?: 紧急 flag，确保提交的脚本使用 urgent worker 处理，防止被其它作业阻塞
                 Urgent flag to ensure that submitted scripts are processed by urgent workers to prevent being blocked by other jobs
-            - listener?: 处理本次 rpc 期间的消息 (DdbMessage)
-                Process messages during this rpc (DdbMessage)
+            - listener?: 处理本次 rpc 期间的消息 (DdbMessage)  Process messages during this rpc (DdbMessage)
             - parse_object?: 在该次 rpc 期间设置 parse_object, 结束后恢复原有，为 false 时返回的 DdbObj 仅含有 buffer 和 le，
                 不做解析，以便后续转发、序列化
                 Set parse_object during this rpc, and restore the original after the end.
@@ -579,7 +589,8 @@ export declare class DDB {
     }): Promise<T>;
     /** call function through websocket (function command)
         - func: 函数名  function name
-        - args?: `[ ]` 调用参数 (传入的原生 string 和 boolean 会被自动转换为 DdbObj<string> 和 DdbObj<boolean>)  Call parameters (the incoming native string and boolean will be automatically converted to DdbObj<string> and DdbObj<boolean>)
+        - args?: `[ ]` 调用参数 (传入的原生 string 和 boolean 会被自动转换为 DdbObj<string> 和 DdbObj<boolean>)
+            Call parameters (the incoming native string and boolean will be automatically converted to DdbObj<string> and DdbObj<boolean>)
         - options?: 调用选项  call options
             - urgent?: 紧急 flag。使用 urgent worker 执行，防止被其它作业阻塞
                 Emergency flag. Use urgent worker execution to prevent being blocked by other jobs
@@ -620,7 +631,7 @@ export declare class DDB {
     /** 取消当前 session id 对应的所有 console jobs  Cancel all console jobs corresponding to the current session id */
     cancel(): Promise<void>;
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
-    parse_message(buf: Uint8Array, parse_object?: boolean): DdbMessage;
+    parse_message(buf: Uint8Array, error: DdbDatabaseError): DdbMessage;
     /** 内部的流订阅方法  Internal stream subscription method */
     subscribe(): Promise<StreamingData>;
 }
@@ -640,3 +651,4 @@ export interface DdbErrorMessage {
     data: Error;
 }
 export type DdbMessage = DdbPrintMessage | DdbObjectMessage | DdbErrorMessage;
+export {};

package/index.js

@@ -1,12 +1,10 @@
 // import { table, getBorderCharacters, type TableUserConfig } from 'table'
-import { WebSocket } from 'ws';
 import dayjs from 'dayjs';
 import DayjsCustomParseFormat from 'dayjs/plugin/customParseFormat.js';
 dayjs.extend(DayjsCustomParseFormat);
 import ipaddrjs from 'ipaddr.js';
 const { fromByteArray: buf2ipaddr } = ipaddrjs;
-import { concat, assert, inspect, typed_array_to_buffer } from 'xshell/utils.js';
-import { connect_websocket } from 'xshell/net.js';
+import { concat, assert, inspect, typed_array_to_buffer, connect_websocket, WebSocket } from 'xshell';
 import { t } from './i18n/index.js';
 export var DdbForm;
 (function (DdbForm) {
@@ -25,8 +23,8 @@ export var DdbForm;
     DdbForm[DdbForm["object"] = 9] = "object";
 })(DdbForm = DdbForm || (DdbForm = {}));
 /** DolphinDB DataType
-    对应的 array vector 类型为 64 + 基本类型
-    对应的 extended 类型为 128 + 基本类型
+    对应的 array vector 类型为 64 + 基本类型  The corresponding array vector type is 64 + base type
+    对应的 extended 类型为 128 + 基本类型  The corresponding extended type is 128 + base type
 */
 export var DdbType;
 (function (DdbType) {
@@ -152,7 +150,8 @@ export class DdbObj {
     rows;
     /** 第 2 维 */
     cols;
-    /** 实际数据。不同的 DdbForm, DdbType 使用 DdbValue 中不同的类型来表示实际数据  The actual data. Different DdbForm, DdbType use different types in DdbValue to represent actual data */
+    /** 实际数据。不同的 DdbForm, DdbType 使用 DdbValue 中不同的类型来表示实际数据
+        The actual data. Different DdbForm, DdbType use different types in DdbValue to represent actual data */
     value;
     /** 原始二进制数据，仅在 parse_object 为 false 时通过 parse_message 生成的顶层对象有这个属性 */
     buffer;
@@ -959,7 +958,7 @@ export class DdbObj {
                     ];
                 }
                 default:
-                    throw new Error(`${DdbForm[form] || form} ${t('暂时不支持序列化')}`);
+                    throw new Error(t('vector {{type}} 暂不支持序列化', { type: DdbType[type] || type }));
             }
         })();
         if (!body)
@@ -1051,7 +1050,7 @@ export class DdbObj {
                 return [Int32Array.of(scale), data];
             }
             default:
-                throw new Error(t('vector {{type}} 暂不支持序列化', { type: DdbType[type] || type }));
+                throw new Error(t('vector {{type}} 暂不支持序列化', { type: String(DdbType[type] || type) }));
         }
     }
     [inspect.custom](depth, _options, _inspect) {
@@ -2106,13 +2105,24 @@ export function int1282str(buffer, le = true) {
         .padStart(2, '0')).join('');
 }
 export const winsize = 10_0000;
-export class ConnectionError extends Error {
+export class DdbConnectionError extends Error {
     ddb;
-    constructor(ddb) {
-        super(`${ddb.url} ${t('已断开')}`);
+    constructor(ddb, error_options) {
+        super(`${ddb.url} ${t('已断开')}`, error_options);
         this.ddb = ddb;
     }
 }
+export class DdbDatabaseError extends Error {
+    ddb;
+    type;
+    options;
+    constructor(message, ddb, type, options) {
+        super(message);
+        this.ddb = ddb;
+        this.type = type;
+        this.options = options;
+    }
+}
 export class DDB {
     /** 当前的 session id (http 或 tcp) */
     sid = '0';
@@ -2274,7 +2284,8 @@ export class DDB {
             this.websocket.close(1000);
     }
     /** rpc through websocket (function/script/variable command)
-        未连接到 DDB 时调用会自动连接，连接断开时调用会抛出 ConnectionError  When the DDB is not connected, the call will be automatically connected. When the connection is disconnected, the call will throw the Connectionerror
+        未连接到 DDB 时调用会自动连接，连接断开时调用会抛出 DdbConnectionError
+        When the DDB is not connected, the call will be automatically connected. When the connection is disconnected, the call will throw the DdbConnectionError
         - type: API 类型: 'script' | 'function' | 'variable'
         - options:
             - urgent?: 决定 `行为标识` 那一行字符串的取值（只适用于 script 和 function）
@@ -2283,11 +2294,13 @@ export class DDB {
             - parse_object?: 在本次 rpc 期间设置 parse_object, 结束后恢复原有
                 为 false 时返回的 DdbObj 仅含有 buffer 和 le，不做解析，以便后续转发、序列化
     */
-    async rpc(type, { script, func, args = [], vars = [], urgent, listener, parse_object, }) {
+    async rpc(type, options) {
         if (!this.websocket)
             await this.connect();
         if (!this.connected)
-            throw new ConnectionError(this);
+            throw new DdbConnectionError(this);
+        const { script, func, vars = [], urgent, listener, } = options;
+        let { args = [] } = options;
         if (func === 'pnode_run' && !this.pnode_run_defined) {
             // 保证并发调用 rpc 时只定义一次 pnode_run
             const ptail = this.ppnoderun;
@@ -2340,6 +2353,7 @@ export class DDB {
         }
         // this 上的当前配置需要在 message 到达后使用，先保存起来
         const _handlers = [...this.listeners].reverse();
+        let error = new DdbDatabaseError('', this, type, options);
         // 临界区：保证多个 rpc 并发时形成 promise 链
         // ddb 世界观：需要等待上一个 rpc 结果从 server 返回之后才能发起下一个调用  
         // 违反世界观可能造成:  
@@ -2362,7 +2376,7 @@ export class DDB {
                 const buf = new Uint8Array(buffer);
                 if (this.print_message_buffer)
                     console.log(typed_array_to_buffer(buf));
-                const message = this.parse_message(buf, parse_object);
+                const message = this.parse_message(buf, error);
                 listener?.(message, this);
                 for (const listener of _handlers)
                     listener(message, this);
@@ -2416,8 +2430,7 @@ export class DDB {
         - options?: 执行选项  execution options
             - urgent?: 紧急 flag，确保提交的脚本使用 urgent worker 处理，防止被其它作业阻塞
                 Urgent flag to ensure that submitted scripts are processed by urgent workers to prevent being blocked by other jobs
-            - listener?: 处理本次 rpc 期间的消息 (DdbMessage)
-                Process messages during this rpc (DdbMessage)
+            - listener?: 处理本次 rpc 期间的消息 (DdbMessage)  Process messages during this rpc (DdbMessage)
             - parse_object?: 在该次 rpc 期间设置 parse_object, 结束后恢复原有，为 false 时返回的 DdbObj 仅含有 buffer 和 le，
                 不做解析，以便后续转发、序列化
                 Set parse_object during this rpc, and restore the original after the end.
@@ -2429,7 +2442,8 @@ export class DDB {
     }
     /** call function through websocket (function command)
         - func: 函数名  function name
-        - args?: `[ ]` 调用参数 (传入的原生 string 和 boolean 会被自动转换为 DdbObj<string> 和 DdbObj<boolean>)  Call parameters (the incoming native string and boolean will be automatically converted to DdbObj<string> and DdbObj<boolean>)
+        - args?: `[ ]` 调用参数 (传入的原生 string 和 boolean 会被自动转换为 DdbObj<string> 和 DdbObj<boolean>)
+            Call parameters (the incoming native string and boolean will be automatically converted to DdbObj<string> and DdbObj<boolean>)
         - options?: 调用选项  call options
             - urgent?: 紧急 flag。使用 urgent worker 执行，防止被其它作业阻塞
                 Emergency flag. Use urgent worker execution to prevent being blocked by other jobs
@@ -2505,7 +2519,7 @@ export class DDB {
         }
     }
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
-    parse_message(buf, parse_object = this.parse_object) {
+    parse_message(buf, error) {
         // MSG\n
         // <message>\0
         // 'M'.codePointAt(0).to_hex_str()
@@ -2538,17 +2552,16 @@ export class DDB {
         const ilf1 = buf.indexOf(0x0a, ils1); // '\n'
         /** 'OK' 表示成功，其它文本表示失败 */
         const message = this.dec.decode(buf.subarray(ils1, ilf1));
-        if (message !== 'OK')
-            return {
-                type: 'error',
-                data: new Error(message)
-            };
+        if (message !== 'OK') {
+            error.message = message;
+            return { type: 'error', data: error };
+        }
         const bufobj = buf.subarray(ilf1 + 1);
         if (this.print_object_buffer)
             console.log(typed_array_to_buffer(bufobj));
         return {
             type: 'object',
-            data: parse_object ?
+            data: error.options.parse_object ?? this.parse_object ?
                 DdbObj.parse(bufobj, this.le)
                 :
                     new DdbObj({