dolphindb 0.0.6 → 0.0.7

package/README.md

@@ -320,3 +320,19 @@ async upload (
 ): Promise<void>
 ```
 
+
+### Notes
+```ts
+import { nulls, DdbInt, timestamp2str } from 'dolphindb'
+
+// create DolphinDB null integer value (the smallest 32-bit integer)
+new DdbInt(nulls.int32)
+
+// convert DolphinDB timestamp value to string
+timestamp2str(
+    (
+        await ddb.call<DdbObj<bigint>>('now', [false])
+    ).value
+) === '2022.02.23 17:23:13.494'
+```
+

package/README.zh.md

@@ -320,3 +320,18 @@ async upload (
 ): Promise<void>
 ```
 
+
+### Notes
+```ts
+import { nulls, DdbInt, timestamp2str } from 'dolphindb'
+
+// 创建 DolphinDB 空值 (最小的 32-bit 整数)
+new DdbInt(nulls.int32)
+
+// 将 DolphinDB 中的 timestamp 格式化为 string
+timestamp2str(
+    (
+        await ddb.call<DdbObj<bigint>>('now', [false])
+    ).value
+) === '2022.02.23 17:23:13.494'
+```

package/browser.d.ts

@@ -188,30 +188,68 @@ export declare class DDB {
     /** utf-8 text decoder */
     dec: TextDecoder;
     enc: TextEncoder;
-    ws_url: string;
-    ws: WebSocket;
+    /** DolphinDB WebSocket URL
+        e.g. `ws://127.0.0.1:8848/`, `wss://dolphindb.com`
+    */
+    url: string;
+    websocket: WebSocket;
     /** little endian (server) */
     le: boolean;
     /** little endian (client) */
     static le_client: boolean;
+    /** python session flag (2048) */
+    python: boolean;
+    message_hook: (message: Uint8Array) => any;
     /** print message handler */
     printer(message: string): void;
     /** resolver, rejector, promise of last rpc */
     presolver(buf: Uint8Array): void;
     prejector(error: Error): void;
     presult: Promise<Uint8Array>;
-    constructor(ws_url?: string);
-    /** 连接到 DolphinDB Server */
-    connect({ ws_url, login, username, password, }?: {
-        /** 默认使用实例初始化时传入的 WebSocket URL */
-        ws_url?: string;
-        /** 是否在建立连接后自动登录，默认 true */
+    /**
+        Initialize an instance of DolphinDB Client using the WebSocket URL
+        (without establishing an actual network connection)
+        @example
+        let ddb = new DDB('ws://127.0.0.1:8848')
+        let ddb_secure = new DDB('wss://dolphindb.com')
+    */
+    constructor(url?: string);
+    /** Establish the actual WebSocket connection to the DolphinDB corresponding to the URL */
+    connect({ url, login, username, password, python, }?: {
+        /** By default, the WebSocket URL passed in when the instance is initialized is used */
+        url?: string;
+        /** Whether to automatically log in after the connection is established, the default is true */
         login?: boolean;
-        /** DolphinDB 登录用户名 */
+        /** DolphinDB username */
         username?: string;
-        /** DolphinDB 登录密码 */
+        /** DolphinDB password */
         password?: string;
+        /** set python session flag */
+        python?: boolean;
     }): Promise<void>;
+    get_rpc_options({ urgent, secondary, async: _async, pickle, clear, api, compress, cancellable, priority, parallelism, root_id, limit, }?: {
+        urgent?: boolean;
+        /** API 提交的任务, secondary 必须为 false */
+        secondary?: boolean;
+        /** 是否异步任务（不返回结果） */
+        async?: boolean;
+        /** 让服务端以 pickle 协议返回数据 */
+        pickle?: boolean;
+        /** 本次任务完成后 clear session memory */
+        clear?: boolean;
+        /** 是否为 api client */
+        api?: boolean;
+        compress?: boolean;
+        /** 任务是否可以取消 */
+        cancellable?: boolean;
+        priority?: number;
+        /** `8` 0 ~ 64, 指定本任务并行度 */
+        parallelism?: number;
+        /** 根任务编号，内部使用，API中固定为空 */
+        root_id?: string;
+        /** 指定分块返回的块大小 */
+        limit?: boolean;
+    }): string;
     disconnect(): void;
     /** rpc through websocket (function/script/variable command)
         - type: API 类型: 'script' | 'function' | 'variable'
@@ -219,7 +257,7 @@ export declare class DDB {
             - urgent?: 决定 `行为标识` 那一行字符串的取值（只适用于 script 和 function）
             - vars?: type === 'variable' 时必传，variable 指令中待上传的变量名
     */
-    rpc<T extends DdbObj = DdbObj>(type: 'script' | 'function' | 'variable', { script, func, args, vars, urgent, }: {
+    rpc<T extends DdbObj = DdbObj>(type: 'script' | 'function' | 'variable' | 'connect', { script, func, args, vars, urgent, }: {
         script?: string;
         func?: string;
         args?: (DdbObj | string | boolean)[];
@@ -254,9 +292,9 @@ export declare class DDB {
     }): Promise<T>;
     /** upload variable through websocket (variable command) */
     upload(
-    /** 上传的变量名 */
+    /** Uploaded variables' name */
     vars: string[], 
-    /** 上传的变量值 */
+    /** Uploaded variables' value */
     args: (DdbObj | string | boolean)[]): Promise<DdbObj<DdbValue>>;
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
     parse_message(buf: Uint8Array): {

package/browser.js

@@ -394,8 +394,8 @@ class DdbObj {
                     throw new Error(`array vector 存在非法 unit = ${unit}`);
             }
             let total_length = 0;
-            for (let i = 0; i < lengths.length; i++)
-                total_length += lengths[i];
+            for (const x of lengths)
+                total_length += x;
             const [len_items, data] = this.parse_vector_items(buf.subarray(i_data_start), le, type - 64, total_length);
             blocks.push({
                 unit,
@@ -1014,23 +1014,33 @@ function timestamp2str(timestamp) {
 }
 exports.timestamp2str = timestamp2str;
 class DDB {
-    constructor(ws_url) {
+    /**
+        Initialize an instance of DolphinDB Client using the WebSocket URL
+        (without establishing an actual network connection)
+        @example
+        let ddb = new DDB('ws://127.0.0.1:8848')
+        let ddb_secure = new DDB('wss://dolphindb.com')
+    */
+    constructor(url) {
         /** 当前的 session id (http 或 tcp) */
         this.sid = '0';
         /** utf-8 text decoder */
         this.dec = new TextDecoder('utf-8');
         this.enc = new TextEncoder();
-        this.ws = null;
+        this.websocket = null;
         /** little endian (server) */
         this.le = true;
+        /** python session flag (2048) */
+        this.python = false;
+        this.message_hook = null;
         this.presult = Promise.resolve(null);
-        if (!ws_url) {
-            const url = new URL(location.href);
-            const hostname = url.searchParams.get('hostname') || location.hostname;
-            const port = url.searchParams.get('port') || location.port;
-            ws_url = `${location.protocol === 'https:' ? 'wss' : 'ws'}://${hostname}${port ? `:${port}` : ''}/`;
+        if (!url) {
+            const _url = new URL(location.href);
+            const hostname = _url.searchParams.get('hostname') || location.hostname;
+            const port = _url.searchParams.get('port') || location.port;
+            url = `${location.protocol === 'https:' ? 'wss' : 'ws'}://${hostname}${port ? `:${port}` : ''}/`;
         }
-        this.ws_url = ws_url;
+        this.url = url;
     }
     /** print message handler */
     printer(message) {
@@ -1039,66 +1049,100 @@ class DDB {
     /** resolver, rejector, promise of last rpc */
     presolver(buf) { }
     prejector(error) { }
-    /** 连接到 DolphinDB Server */
-    async connect({ ws_url = this.ws_url, login = true, username = 'admin', password = '123456', } = {}) {
-        this.ws_url = ws_url;
-        if (this.ws?.readyState === WebSocket.OPEN)
+    /** Establish the actual WebSocket connection to the DolphinDB corresponding to the URL */
+    async connect({ url = this.url, login = true, username = 'admin', password = '123456', python = false, } = {}) {
+        this.url = url;
+        this.python = python;
+        if (this.websocket?.readyState === WebSocket.OPEN)
             this.disconnect();
-        let ws = new WebSocket(ws_url);
+        let websocket = new WebSocket(url, python ? ['python'] : []);
         // https://stackoverflow.com/questions/11821096/what-is-the-difference-between-an-arraybuffer-and-a-blob/39951543
-        ws.binaryType = 'arraybuffer';
-        this.ws = ws;
-        ws.addEventListener('open', ev => {
-            console.log(`${this.ws_url} opened`);
-            ws.send(`API ${this.sid} 8\n` +
-                'connect\n');
-        });
-        ws.addEventListener('close', ev => {
-            console.log(`${this.ws_url} closed with code = ${ev.code}, reason = '${ev.reason}'`);
-        });
-        ws.addEventListener('error', ev => {
-            console.log(`${this.ws_url} errored`, ev);
-        });
-        // 为首个 connect 响应报文初始化 presult 链表头结点
-        this.presult = new Promise((resolve, reject) => {
-            this.presolver = resolve;
-            this.prejector = reject;
-        });
-        ws.addEventListener('message', ({ data: buf }) => {
-            try {
-                const { type, data } = this.parse_message(new Uint8Array(buf));
-                if (type === 'message') {
-                    this.printer(data);
-                    return;
+        websocket.binaryType = 'arraybuffer';
+        this.websocket = websocket;
+        await new Promise((resolve, reject) => {
+            websocket.addEventListener('open', async (event) => {
+                console.log(`${websocket.url} opened`);
+                await this.rpc('connect', {});
+                resolve();
+            });
+            websocket.addEventListener('close', event => {
+                console.log(`${websocket.url} closed with code = ${event.code}, reason = '${event.reason}'`);
+            });
+            websocket.addEventListener('error', event => {
+                const message = `${websocket.url} errored`;
+                console.error(message, event);
+                reject(Object.assign(new Error(message), { event }));
+            });
+            websocket.addEventListener('message', event => {
+                const buf = new Uint8Array(event.data);
+                if (this.message_hook)
+                    this.message_hook(buf);
+                try {
+                    const { type, data } = this.parse_message(buf);
+                    if (type === 'message') {
+                        this.printer(data);
+                        return;
+                    }
+                    this.presolver(data);
                 }
-                this.presolver(data);
-            }
-            catch (error) {
-                this.prejector(error);
-            }
+                catch (error) {
+                    this.prejector(error);
+                }
+            });
         });
-        await this.presult;
-        await this.eval('def pnode_run (nodes, func_name, args, add_node_alias = true) {\n' +
-            '    nargs = size(args)\n' +
-            '    func = funcByName(func_name)\n' +
-            '    \n' +
-            '    if (!nargs)\n' +
-            '        return pnodeRun(func, nodes, add_node_alias)\n' +
-            '    \n' +
-            '    args_partial = array(any, 1 + nargs, 1 + nargs)\n' +
-            '    args_partial[0] = func\n' +
-            '    args_partial[1:] = args\n' +
-            '    return pnodeRun(\n' +
-            '        unifiedCall(partial, args_partial),\n' +
-            '        nodes,\n' +
-            '        add_node_alias\n' +
-            '    )\n' +
-            '}\n', { urgent: true });
+        if (!this.python)
+            await this.eval('def pnode_run (nodes, func_name, args, add_node_alias = true) {\n' +
+                '    nargs = size(args)\n' +
+                '    func = funcByName(func_name)\n' +
+                '    \n' +
+                '    if (!nargs)\n' +
+                '        return pnodeRun(func, nodes, add_node_alias)\n' +
+                '    \n' +
+                '    args_partial = array(any, 1 + nargs, 1 + nargs)\n' +
+                '    args_partial[0] = func\n' +
+                '    args_partial[1:] = args\n' +
+                '    return pnodeRun(\n' +
+                '        unifiedCall(partial, args_partial),\n' +
+                '        nodes,\n' +
+                '        add_node_alias\n' +
+                '    )\n' +
+                '}\n', { urgent: true });
         if (login)
             await this.call('login', [username, password], { urgent: true });
     }
+    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;
+        if (urgent)
+            flag += 1;
+        if (secondary)
+            flag += 2;
+        if (_async)
+            flag += 4;
+        if (pickle)
+            flag += 8;
+        if (clear)
+            flag += 16;
+        if (api)
+            flag += 32;
+        if (compress)
+            flag += 64;
+        // python session
+        if (this.python)
+            flag += 2048;
+        const options = [
+            flag,
+            cancellable ? 1 : 0,
+            priority,
+            parallelism,
+            ...limit ? [
+                root_id,
+                limit,
+            ] : [],
+        ];
+        return `/ ${options.join('_')}`;
+    }
     disconnect() {
-        this.ws?.close(1000);
+        this.websocket?.close(1000);
     }
     /** rpc through websocket (function/script/variable command)
         - type: API 类型: 'script' | 'function' | 'variable'
@@ -1107,10 +1151,10 @@ class DDB {
             - vars?: type === 'variable' 时必传，variable 指令中待上传的变量名
     */
     async rpc(type, { script, func, args = [], vars = [], urgent, }) {
-        if (!this.ws)
+        if (!this.websocket)
             await this.connect();
-        if (this.ws.readyState !== WebSocket.OPEN)
-            throw new Error('ws 连接已断开');
+        if (this.websocket.readyState !== WebSocket.OPEN)
+            throw new Error(`${this.url} is already disconnected`);
         // 临界区：保证多个 rpc 并发时形成 promise 链
         // ddb 世界观：需要等待上一个 rpc 结果从 server 返回之后才能发起下一个调用  
         // 违反世界观可能造成:  
@@ -1148,14 +1192,16 @@ class DDB {
                         `${vars.join(',')}\n` +
                         `${vars.length}\n` +
                         `${Number(DDB.le_client)}\n`;
+                case 'connect':
+                    return 'connect\n';
             }
         })());
         const message = (0, utils_browser_1.concat)([
-            this.enc.encode(`API2 ${this.sid} ${command.length}${urgent ? ` / 1_1_8_8` : ''}\n`),
+            this.enc.encode(`API2 ${this.sid} ${command.length}${this.get_rpc_options({ urgent })}\n`),
             command,
             ...args.map((arg) => arg.pack())
         ]);
-        this.ws.send(message);
+        this.websocket.send(message);
         return DdbObj.parse(await presult, // data_buf
         this.le);
     }
@@ -1178,6 +1224,8 @@ class DDB {
             - add_node_alias?: 设置 nodes 参数时选传，其它情况不传
     */
     async call(func, args = [], { urgent, node, nodes, func_type, add_node_alias } = {}) {
+        if (this.python)
+            throw new Error('call doesn\'t support python session yet');
         if (node) {
             if (typeof func_type === 'undefined')
                 throw new Error('指定 node 时必须设置 func_type');
@@ -1193,7 +1241,13 @@ class DDB {
                 new DdbVectorString(nodes),
                 func,
                 new DdbVectorAny(this.to_ddbobjs(args)),
-                ...typeof add_node_alias === 'undefined' ? [] : [add_node_alias]
+                ...(() => {
+                    if (typeof add_node_alias !== 'undefined')
+                        return [add_node_alias];
+                    if (this.python)
+                        return [true];
+                    return [];
+                })()
             ];
             func = 'pnode_run';
         }
@@ -1205,9 +1259,9 @@ class DDB {
     }
     /** upload variable through websocket (variable command) */
     async upload(
-    /** 上传的变量名 */
+    /** Uploaded variables' name */
     vars, 
-    /** 上传的变量值 */
+    /** Uploaded variables' value */
     args) {
         if (!args.length || args.length !== vars.length)
             throw new Error('variable 指令参数为空或参数名为空，或数量不匹配');