dolphindb 0.0.14 → 2.0.501

package/README.md

@@ -220,6 +220,15 @@ const obj = new DdbObj({
 })
 ```
 
+##### NULL object in the form of scalar, the value corresponding to DdbObj is null in JavaScript
+```ts
+;(await ddb.eval('double()')).value === null
+
+// create NULL object
+new DdbInt(null)
+new DdbDouble(null)
+```
+
 
 #### `call` Method Declaration
 ```ts
@@ -321,18 +330,38 @@ async upload (
 ```
 
 
-### Notes
+### Some Examples
 ```ts
-import { nulls, DdbInt, timestamp2str } from 'dolphindb'
+import { nulls, DdbInt, timestamp2str, DdbVectorSymbol, DdbTable, DdbVectorDouble } from 'dolphindb'
 
-// create DolphinDB null integer value (the smallest 32-bit integer)
-new DdbInt(nulls.int32)
-
-// convert DolphinDB timestamp value to string
+// Format timestamp in DolphinDB as string
 timestamp2str(
     (
-        await ddb.call<DdbObj<bigint>>('now', [false])
+        await ddb.call('now', [false])
+        // TypeScript: await ddb.call<DdbObj<bigint>>('now', [false])
     ).value
 ) === '2022.02.23 17:23:13.494'
+
+// create symbol vector
+new DdbVectorSymbol(['aaa', 'aaa', 'aaa', 'aaa', 'aaa', 'bbb'])
+
+// Create a double vector with NULL values using JavaScript native arrays
+new DdbVectorDouble([0.1, null, 0.3])
+
+// More efficient and memory efficient double vector creation using JavaScript TypedArray
+let av = new Float64Array(3)
+av[0] = 0.1
+av[1] = nulls.double
+av[2] = 0.3
+new DdbVectorDouble(av)
+
+// create DdbTable
+new DdbTable(
+    [
+        new DdbVectorDouble([0.1, 0.2, null], 'col0'),
+        new DdbVectorSymbol(['a', 'b', 'c'], 'col1')
+    ],
+    'mytable'
+)
 ```
 

package/README.zh.md

@@ -221,6 +221,15 @@ const obj = new DdbObj({
 })
 ```
 
+##### scalar 形式的 NULL 对象, 对应 DdbObj 的 value 为 JavaScript 中的 null
+```ts
+;(await ddb.eval('double()')).value === null
+
+// 创建 NULL 对象
+new DdbInt(null)
+new DdbDouble(null)
+```
+
 
 #### `call` 方法声明
 ```ts
@@ -322,17 +331,37 @@ async upload (
 ```
 
 
-### Notes
+### 一些例子
 ```ts
-import { nulls, DdbInt, timestamp2str } from 'dolphindb'
-
-// 创建 DolphinDB 空值 (最小的 32-bit 整数)
-new DdbInt(nulls.int32)
+import { nulls, DdbInt, timestamp2str, DdbVectorSymbol, DdbTable, DdbVectorDouble } from 'dolphindb'
 
 // 将 DolphinDB 中的 timestamp 格式化为 string
 timestamp2str(
     (
-        await ddb.call<DdbObj<bigint>>('now', [false])
+        await ddb.call('now', [false])
+        // TypeScript: await ddb.call<DdbObj<bigint>>('now', [false])
     ).value
 ) === '2022.02.23 17:23:13.494'
+
+// 创建 symbol vector
+new DdbVectorSymbol(['aaa', 'aaa', 'aaa', 'aaa', 'aaa', 'bbb'])
+
+// 使用 JavaScript 原生数组创建含有 NULL 值的 double vector
+new DdbVectorDouble([0.1, null, 0.3])
+
+// 使用 JavaScript TypedArray 更加高效且节约内存的创建 double vector
+let av = new Float64Array(3)
+av[0] = 0.1
+av[1] = nulls.double
+av[2] = 0.3
+new DdbVectorDouble(av)
+
+// 创建 DdbTable
+new DdbTable(
+    [
+        new DdbVectorDouble([0.1, 0.2, null], 'col0'),
+        new DdbVectorSymbol(['a', 'b', 'c'], 'col1')
+    ],
+    'mytable'
+)
 ```

package/browser.d.ts

@@ -78,10 +78,15 @@ export interface DdbArrayVectorBlock {
 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 bool: 128;
     readonly char: "€";
     readonly int16: -32768;
     readonly int32: -2147483648;
     readonly int64: -9223372036854775808n;
+    readonly float32: -3.4028234663852886e+38;
+    /** -Number.MAX_VALUE */
+    readonly double: number;
+    readonly bytes16: Uint8Array;
 };
 export declare const timezone_offset: number;
 /** 可以表示所有 DolphinDB 数据库中的数据类型 */
@@ -149,57 +154,85 @@ export declare class DdbVoid extends DdbObj<undefined> {
     constructor();
 }
 export declare class DdbBool extends DdbObj<boolean> {
-    constructor(value: boolean);
+    constructor(value: boolean | null);
 }
 export declare class DdbChar extends DdbObj<string> {
-    constructor(value: string);
+    constructor(value: string | null);
 }
 export declare class DdbInt extends DdbObj<number> {
-    constructor(value: number);
+    constructor(value: number | null);
 }
 export declare class DdbString extends DdbObj<string> {
     constructor(value: string);
 }
 export declare class DdbLong extends DdbObj<bigint> {
-    constructor(value: bigint);
+    constructor(value: bigint | null);
 }
 export declare class DdbDouble extends DdbObj<number> {
-    constructor(value: number);
+    constructor(value: number | null);
 }
 export declare class DdbDateTime extends DdbObj<number> {
-    constructor(value: number);
+    constructor(value: number | null);
 }
 export declare class DdbTimeStamp extends DdbObj<bigint> {
-    constructor(value: bigint);
+    constructor(value: bigint | null);
 }
 export declare class DdbNanoTimeStamp extends DdbObj<bigint> {
-    constructor(value: bigint);
+    constructor(value: bigint | null);
+}
+export declare class DdbPair extends DdbObj<Int32Array> {
+    constructor(l: number | null, r?: number | null);
+}
+export declare class DdbFunction extends DdbObj<DdbFunctionDefValue> {
+    constructor(name: string, type: DdbFunctionType);
 }
 export declare class DdbVectorInt extends DdbObj<Int32Array> {
-    constructor(value: number[], name?: string);
+    constructor(ints: (number | null)[] | Int32Array, name?: string);
 }
 export declare class DdbVectorString extends DdbObj<string[]> {
-    constructor(value: string[], name?: string);
+    constructor(strings: string[], name?: string);
 }
 export declare class DdbVectorDouble extends DdbObj<Float64Array> {
-    constructor(value: number[], name?: string);
+    constructor(doubles: (number | null)[] | Float64Array, name?: string);
 }
 export declare class DdbVectorAny extends DdbObj {
-    constructor(value: DdbObj<DdbValue>[], name?: string);
+    constructor(objs: DdbObj<DdbValue>[], name?: string);
 }
-export declare class DdbPair extends DdbObj<Int32Array> {
-    constructor(l: number, r?: number);
+export declare class DdbVectorSymbol extends DdbObj<DdbSymbolExtendedValue> {
+    constructor(strings: string[], name?: string);
 }
-export declare class DdbFunction extends DdbObj<DdbFunctionDefValue> {
-    constructor(name: string, type: DdbFunctionType);
+export declare class DdbTable extends DdbObj<DdbObj[]> {
+    constructor(columns: DdbObj[], name?: string);
 }
 export declare function date2str(date: number, format?: string): string;
 export declare function datetime2str(datetime: number, format?: string): string;
-export declare function timestamp2str(timestamp: bigint): string;
+/** format timestamp (bigint) to string
+    - timestamp: bigint value
+    - format?:
+        format string, default to `YYYY.MM.DD HH:mm:ss.SSS`
+        https://day.js.org/docs/en/parse/string-format#list-of-all-available-parsing-tokens
+*/
+export declare function timestamp2str(timestamp: bigint, format?: string): string;
+/** parse timestamp string to bigint value
+    - str: timestamp string, If it is an empty string, it will return the corresponding empty value (nulls.int64)
+    - format?:
+        The format string corresponding to the incoming string, the default is `YYYY.MM.DD HH:mm:ss.SSS`
+        https://day.js.org/docs/en/parse/string-format#list-of-all-available-parsing-tokens
+*/
+export declare function str2timestamp(str: string, format?: string): bigint;
+/** format nanotimestamp value (bigint) to string
+    - nanotimestamp: bigint value
+    - format?:
+        format string, default is `YYYY.MM.DD HH:mm:ss.SSSSSSSSS`
+        Seconds are in the format ss (must be included); nanoseconds are in the format SSSSSSSSS (must be included)
+        https://day.js.org/docs/en/parse/string-format#list-of-all-available-parsing-tokens
+*/
 export declare function nanotimestamp2str(nanotimestamp: bigint, format?: string): string;
 /** parse nano timestamp string to bigint value
-    - str: nano timestamp string, 如果为空字符串会返回对应的空值 (nulls.int64)
-    - format?: Format string up to and including seconds of the passed string, default is `YYYY.MM.DD HH:mm:ss`
+    - str: nano timestamp string, If it is an empty string, it will return the corresponding empty value (nulls.int64)
+    - format?:
+        The format string corresponding to the incoming string, the default is `YYYY.MM.DD HH:mm:ss.SSSSSSSSS`
+        Seconds are in the format ss (must be included); nanoseconds are in the format SSSSSSSSS (must be included)
         https://day.js.org/docs/en/parse/string-format#list-of-all-available-parsing-tokens
 */
 export declare function str2nanotimestamp(str: string, format?: string): bigint;
@@ -227,6 +260,7 @@ export declare class DDB {
     presolver(buf: Uint8Array): void;
     prejector(error: Error): void;
     presult: Promise<Uint8Array>;
+    get connected(): boolean;
     /**
         Initialize an instance of DolphinDB Client using the WebSocket URL
         (without establishing an actual network connection)
@@ -327,7 +361,7 @@ export declare class DDB {
     };
     /** 自动转换 js string, boolean 为 DdbObj */
     to_ddbobj(value: DdbObj | string | boolean): DdbObj;
-    /** 转换 js 数组为 DdbObj[] (in place, 会修改原数组) */
+    /** 转换 js 数组为 DdbObj[] */
     to_ddbobjs(values: any[]): DdbObj<DdbValue>[];
 }
 export declare let ddb: DDB;