dolphindb 2.0.501 → 2.0.504

package/README.md

@@ -54,23 +54,24 @@ let ddb = new DDB('ws://127.0.0.1:8848')
 await ddb.connect()
 ```
 
-#### Connect Method Declaration
+#### DDB options
 ```ts
-async connect (
-    options?: {
-        /** by default, the WebSocket URL passed in when the instance is initialized is used */
-        ws_url?: string
-        
-        /** whether to automatically log in after the connection is established, the default is true */
-        login?: boolean
-        
-        /** DolphinDB username */
-        username?: string
-        
-        /** DolphinDB password */
-        password?: string
-    } = { }
-): Promise<void>
+let ddb = new DDB('ws://127.0.0.1:8848')
+
+// Encrypt with HTTPS
+let ddbsecure = new DDB('wss://dolphindb.com', {
+    // Whether to log in automatically after establishing a connection, default `true`
+    autologin: true,
+    
+    // DolphinDB username, default `'admin'`
+    username: 'admin',
+    
+    // DolphinDB password, default `'123456'`
+    password: '123456',
+    
+    // set python session flag, default `false`
+    python: false
+})
 ```
 
 
@@ -187,37 +188,41 @@ enum DdbType {
 }
 ```
 
-##### For types that are not in the utility classes, such as the datetime type in DolphinDB, we can specify form and type to create a DdbObj object
+##### If there is no shortcut class, you can also specify form and type to manually create a DdbObj object
 ```ts
+// Created by the DdbDateTime shortcut class
+new DdbDateTime(1644573600)
+
+// Equivalent to manually creating an object of form = scalar, type = datetime through DdbObj
 const obj = new DdbObj({
-    form: DdbForm.scalar,
-    type: DdbType.datetime,
-    value: 1644573600,
-    length: 0
+     form: DdbForm.scalar,
+     type: DdbType.datetime,
+     value: 1644573600,
+     length: 0
 })
-```
 
-The corresponding type and value of value property in js can refer to the result returned by `ddb.eval` (see below: `eval` Method Declaration)
 
-```ts
+// The corresponding type and value of value in js can refer to the result returned by ddb.eval (see the `eval` method declaration below)
 const obj = await ddb.eval('2022.02.11 10:00:00')
 console.log(obj.form === DdbForm.scalar)
 console.log(obj.type === DdbType.datetime)
 console.log(obj.value)
-```
 
-##### Another example is to create a set
-```ts
+// Another example is to create a set
 // refer to ddb.eval
 // const obj = await ddb.eval('set([1, 2, 3])')
 // console.log(obj.value)
-
 const obj = new DdbObj({
-    form: DdbForm.set,
-    type: DdbType.int,
-    value: Int32Array.of(1, 2, 3),
-    length: 0
+     form: DdbForm.set,
+     type: DdbType.int,
+     value: Int32Array.of(1, 2, 3),
+     length: 0
 })
+
+// It's easier to use shortcut classes
+const obj = new DdbSetInt(
+     new Set([1, 2, 3])
+)
 ```
 
 ##### NULL object in the form of scalar, the value corresponding to DdbObj is null in JavaScript

package/README.zh.md

@@ -55,23 +55,24 @@ let ddb = new DDB('ws://127.0.0.1:8848')
 await ddb.connect()
 ```
 
-#### connect 方法声明
+#### DDB 选项
 ```ts
-async connect (
-    options?: {
-        /** 默认使用实例初始化时传入的 WebSocket 链接 */
-        ws_url?: string
-        
-        /** 是否在建立连接后自动登录，默认 true */
-        login?: boolean
-        
-        /** DolphinDB 登录用户名 */
-        username?: string
-        
-        /** DolphinDB 登录密码 */
-        password?: string
-    } = { }
-): Promise<void>
+let ddb = new DDB('ws://127.0.0.1:8848')
+
+// 使用 HTTPS 加密
+let ddbsecure = new DDB('wss://dolphindb.com', {
+    // 是否在建立连接后自动登录，默认 `true`
+    autologin: true,
+    
+    // DolphinDB 登录用户名，默认 `'admin'`
+    username: 'admin',
+    
+    // DolphinDB 登录密码，默认 `'123456'`
+    password: '123456',
+    
+    // 设置 python session flag，默认 `false`
+    python: false
+})
 ```
 
 
@@ -188,37 +189,41 @@ enum DdbType {
 }
 ```
 
-##### 不在快捷类中的类型，比如 DolphinDB 中的 datetime 类型, 可以指定 form 和 type 创建 DdbObj 对象
+##### 没有快捷类的类型，也可以指定 form 和 type 手动创建 DdbObj 对象
 ```ts
+// 通过 DdbDateTime 快捷类创建
+new DdbDateTime(1644573600)
+
+// 等价于手动通过 DdbObj 创建 form = scalar, type = datetime 的对象
 const obj = new DdbObj({
     form: DdbForm.scalar,
     type: DdbType.datetime,
     value: 1644573600,
     length: 0
 })
-```
 
-value 的在 js 中对应类型及取值可以参考 ddb.eval 返回的结果 (见后文 `eval` 方法声明)
 
-```ts
+// value 在 js 中对应类型及取值可以参考 ddb.eval 返回的结果 (见后文 `eval` 方法声明)
 const obj = await ddb.eval('2022.02.11 10:00:00')
 console.log(obj.form === DdbForm.scalar)
 console.log(obj.type === DdbType.datetime)
 console.log(obj.value)
-```
 
-##### 再比如创建一个 set
-```ts
+// 再比如创建一个 set
 // 参考 ddb.eval
 // const obj = await ddb.eval('set([1, 2, 3])')
 // console.log(obj.value)
-
 const obj = new DdbObj({
     form: DdbForm.set,
     type: DdbType.int,
     value: Int32Array.of(1, 2, 3),
     length: 0
 })
+
+// 使用快捷类较为简单
+const obj = new DdbSetInt(
+    new Set([1, 2, 3])
+)
 ```
 
 ##### scalar 形式的 NULL 对象, 对应 DdbObj 的 value 为 JavaScript 中的 null

package/browser.d.ts

@@ -93,7 +93,9 @@ export declare const timezone_offset: number;
 export declare class DdbObj<T extends DdbValue = DdbValue> {
     static dec: TextDecoder;
     static enc: TextEncoder;
-    /** 维护已解析的 symbol base，比如流数据中后续的 symbol 向量可能只发送一个 base.id, base.size == 0, 依赖之前发送的 symbol base */
+    /** 维护已解析的 symbol base，比如流数据中后续的 symbol 向量可能只发送一个 base.id, base.size == 0, 依赖之前发送的 symbol base ？
+        只是暂存，如果一张表有多个 symbol 列，可能这个 symbol base 会被复用，不同的对象之间 symbol base 一般不复用
+    */
     static symbol_bases: Record<number, string[]>;
     /** little endian (client) */
     static le_client: boolean;
@@ -189,18 +191,27 @@ export declare class DdbFunction extends DdbObj<DdbFunctionDefValue> {
 export declare class DdbVectorInt extends DdbObj<Int32Array> {
     constructor(ints: (number | null)[] | Int32Array, name?: string);
 }
-export declare class DdbVectorString extends DdbObj<string[]> {
-    constructor(strings: string[], name?: string);
-}
 export declare class DdbVectorDouble extends DdbObj<Float64Array> {
     constructor(doubles: (number | null)[] | Float64Array, name?: string);
 }
+export declare class DdbVectorString extends DdbObj<string[]> {
+    constructor(strings: string[], name?: string);
+}
 export declare class DdbVectorAny extends DdbObj {
     constructor(objs: DdbObj<DdbValue>[], name?: string);
 }
 export declare class DdbVectorSymbol extends DdbObj<DdbSymbolExtendedValue> {
     constructor(strings: string[], name?: string);
 }
+export declare class DdbSetInt extends DdbObj<Int32Array> {
+    constructor(ints: (number | null)[] | Set<number> | Int32Array);
+}
+export declare class DdbSetDouble extends DdbObj<Float64Array> {
+    constructor(doubles: (number | null)[] | Set<number> | Float64Array);
+}
+export declare class DdbSetString extends DdbObj<string[]> {
+    constructor(strings: string[] | Set<string>);
+}
 export declare class DdbTable extends DdbObj<DdbObj[]> {
     constructor(columns: DdbObj[], name?: string);
 }
@@ -251,6 +262,12 @@ export declare class DDB {
     le: boolean;
     /** little endian (client) */
     static le_client: boolean;
+    /** Whether to automatically log in after the connection is established, the default is true */
+    autologin: boolean;
+    /** DolphinDB username */
+    username: string;
+    /** DolphinDB password */
+    password: string;
     /** python session flag (2048) */
     python: boolean;
     message_hook: (message: Uint8Array) => any;
@@ -264,22 +281,43 @@ export declare class DDB {
     /**
         Initialize an instance of DolphinDB Client using the WebSocket URL
         (without establishing an actual network connection)
+        - url?: DolphinDB WebSocket URL. e.g.：`ws://127.0.0.1:8848`, Defaults to the current page URL
+        - options?:
+            - 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`
+        
         @example
         let ddb = new DDB('ws://127.0.0.1:8848')
-        let ddb_secure = new DDB('wss://dolphindb.com')
+        
+        // 使用 HTTPS 加密
+        let ddbsecure = new DDB('wss://dolphindb.com', {
+            autologin: true,
+            username: 'admin',
+            password: '123456',
+            python: false
+        })
+    */
+    constructor(url?: string, options?: {
+        autologin?: boolean;
+        username?: string;
+        password?: string;
+        python?: boolean;
+    });
+    /** 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`
     */
-    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 */
+    connect(options?: {
         url?: string;
-        /** Whether to automatically log in after the connection is established, the default is true */
-        login?: boolean;
-        /** DolphinDB username */
+        autologin?: boolean;
         username?: string;
-        /** 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, }?: {

package/browser.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ddb = exports.DDB = exports.str2nanotimestamp = exports.nanotimestamp2str = exports.str2timestamp = exports.timestamp2str = exports.datetime2str = exports.date2str = exports.DdbTable = exports.DdbVectorSymbol = exports.DdbVectorAny = exports.DdbVectorDouble = exports.DdbVectorString = exports.DdbVectorInt = exports.DdbFunction = exports.DdbPair = exports.DdbNanoTimeStamp = exports.DdbTimeStamp = exports.DdbDateTime = exports.DdbDouble = exports.DdbLong = exports.DdbString = exports.DdbInt = exports.DdbChar = exports.DdbBool = exports.DdbVoid = exports.DdbObj = exports.timezone_offset = exports.nulls = exports.DdbFunctionType = exports.DdbType = exports.DdbForm = void 0;
+exports.ddb = exports.DDB = exports.str2nanotimestamp = exports.nanotimestamp2str = exports.str2timestamp = exports.timestamp2str = exports.datetime2str = exports.date2str = exports.DdbTable = exports.DdbSetString = exports.DdbSetDouble = exports.DdbSetInt = exports.DdbVectorSymbol = exports.DdbVectorAny = exports.DdbVectorString = exports.DdbVectorDouble = exports.DdbVectorInt = exports.DdbFunction = exports.DdbPair = exports.DdbNanoTimeStamp = exports.DdbTimeStamp = exports.DdbDateTime = exports.DdbDouble = exports.DdbLong = exports.DdbString = exports.DdbInt = exports.DdbChar = 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 = tslib_1.__importDefault(require("dayjs"));
 const customParseFormat_js_1 = tslib_1.__importDefault(require("dayjs/plugin/customParseFormat.js"));
@@ -915,7 +915,9 @@ class DdbObj {
 exports.DdbObj = DdbObj;
 DdbObj.dec = new TextDecoder('utf-8');
 DdbObj.enc = new TextEncoder();
-/** 维护已解析的 symbol base，比如流数据中后续的 symbol 向量可能只发送一个 base.id, base.size == 0, 依赖之前发送的 symbol base */
+/** 维护已解析的 symbol base，比如流数据中后续的 symbol 向量可能只发送一个 base.id, base.size == 0, 依赖之前发送的 symbol base ？
+    只是暂存，如果一张表有多个 symbol 列，可能这个 symbol base 会被复用，不同的对象之间 symbol base 一般不复用
+*/
 DdbObj.symbol_bases = {};
 /** little endian (client) */
 DdbObj.le_client = Boolean(new Uint8Array(Uint32Array.of(1).buffer)[0]);
@@ -1073,20 +1075,6 @@ class DdbVectorInt extends DdbObj {
     }
 }
 exports.DdbVectorInt = DdbVectorInt;
-class DdbVectorString extends DdbObj {
-    constructor(strings, name) {
-        super({
-            form: DdbForm.vector,
-            type: DdbType.string,
-            length: 0,
-            rows: strings.length,
-            cols: 1,
-            value: strings,
-            name,
-        });
-    }
-}
-exports.DdbVectorString = DdbVectorString;
 class DdbVectorDouble extends DdbObj {
     constructor(doubles, name) {
         super({
@@ -1107,6 +1095,20 @@ class DdbVectorDouble extends DdbObj {
     }
 }
 exports.DdbVectorDouble = DdbVectorDouble;
+class DdbVectorString extends DdbObj {
+    constructor(strings, name) {
+        super({
+            form: DdbForm.vector,
+            type: DdbType.string,
+            length: 0,
+            rows: strings.length,
+            cols: 1,
+            value: strings,
+            name,
+        });
+    }
+}
+exports.DdbVectorString = DdbVectorString;
 class DdbVectorAny extends DdbObj {
     constructor(objs, name) {
         super({
@@ -1152,6 +1154,65 @@ class DdbVectorSymbol extends DdbObj {
     }
 }
 exports.DdbVectorSymbol = DdbVectorSymbol;
+class DdbSetInt extends DdbObj {
+    constructor(ints) {
+        super({
+            form: DdbForm.set,
+            type: DdbType.int,
+            length: 0,
+            rows: ints instanceof Set ?
+                ints.size
+                :
+                    ints.length,
+            cols: 1,
+            value: ints instanceof Int32Array ?
+                ints
+                :
+                    Int32Array.from(ints, v => v === null ?
+                        exports.nulls.int32
+                        :
+                            v),
+        });
+    }
+}
+exports.DdbSetInt = DdbSetInt;
+class DdbSetDouble extends DdbObj {
+    constructor(doubles) {
+        super({
+            form: DdbForm.set,
+            type: DdbType.double,
+            length: 0,
+            rows: doubles instanceof Set ?
+                doubles.size
+                :
+                    doubles.length,
+            cols: 1,
+            value: doubles instanceof Int32Array ?
+                doubles
+                :
+                    Int32Array.from(doubles, v => v === null ?
+                        exports.nulls.int32
+                        :
+                            v),
+        });
+    }
+}
+exports.DdbSetDouble = DdbSetDouble;
+class DdbSetString extends DdbObj {
+    constructor(strings) {
+        if (strings instanceof Set)
+            strings = [...strings];
+        super({
+            form: DdbForm.set,
+            type: DdbType.string,
+            length: 0,
+            rows: strings.length,
+            cols: 1,
+            value: strings
+        });
+    }
+}
+exports.DdbSetString = DdbSetString;
 class DdbTable extends DdbObj {
     constructor(columns, name = '') {
         super({
@@ -1259,11 +1320,25 @@ class DDB {
     /**
         Initialize an instance of DolphinDB Client using the WebSocket URL
         (without establishing an actual network connection)
+        - url?: DolphinDB WebSocket URL. e.g.：`ws://127.0.0.1:8848`, Defaults to the current page URL
+        - options?:
+            - 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`
+        
         @example
         let ddb = new DDB('ws://127.0.0.1:8848')
-        let ddb_secure = new DDB('wss://dolphindb.com')
+        
+        // 使用 HTTPS 加密
+        let ddbsecure = new DDB('wss://dolphindb.com', {
+            autologin: true,
+            username: 'admin',
+            password: '123456',
+            python: false
+        })
     */
-    constructor(url) {
+    constructor(url, options = {}) {
         /** 当前的 session id (http 或 tcp) */
         this.sid = '0';
         /** utf-8 text decoder */
@@ -1272,6 +1347,12 @@ class DDB {
         this.websocket = null;
         /** little endian (server) */
         this.le = true;
+        /** Whether to automatically log in after the connection is established, the default is true */
+        this.autologin = true;
+        /** DolphinDB username */
+        this.username = 'admin';
+        /** DolphinDB password */
+        this.password = '123456';
         /** python session flag (2048) */
         this.python = false;
         this.message_hook = null;
@@ -1283,6 +1364,14 @@ class DDB {
             url = `${location.protocol === 'https:' ? 'wss' : 'ws'}://${hostname}${port ? `:${port}` : ''}/`;
         }
         this.url = url;
+        if (options.autologin !== undefined)
+            this.autologin = options.autologin;
+        if (options.username !== undefined)
+            this.username = options.username;
+        if (options.password !== undefined)
+            this.password = options.password;
+        if (options.python !== undefined)
+            this.python = options.python;
     }
     /** print message handler */
     printer(message) {
@@ -1294,12 +1383,27 @@ class DDB {
     get connected() {
         return this.websocket?.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;
+    /** 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`
+    */
+    async connect(options = {}) {
+        if (options.url !== undefined)
+            this.url = options.url;
+        if (options.autologin !== undefined)
+            this.autologin = options.autologin;
+        if (options.username !== undefined)
+            this.username = options.username;
+        if (options.password !== undefined)
+            this.password = options.password;
+        if (options.python !== undefined)
+            this.python = options.python;
         this.disconnect();
-        let websocket = new WebSocket(url, python ? ['python'] : []);
+        let websocket = new WebSocket(this.url, this.python ? ['python'] : []);
         // https://stackoverflow.com/questions/11821096/what-is-the-difference-between-an-arraybuffer-and-a-blob/39951543
         websocket.binaryType = 'arraybuffer';
         this.websocket = websocket;
@@ -1351,11 +1455,11 @@ class DDB {
                 '        add_node_alias\n' +
                 '    )\n' +
                 '}\n', { urgent: true });
-        if (login)
+        if (this.autologin)
             if (this.python)
-                await this.eval(`login(${username.quote('double')}, ${password.quote('double')})`, { urgent: true });
+                await this.eval(`login(${this.username.quote('double')}, ${this.password.quote('double')})`, { urgent: true });
             else
-                await this.call('login', [username, password], { urgent: true });
+                await this.call('login', [this.username, this.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;