dolphindb 2.0.603 → 2.0.801

package/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" resolution-mode="require"/>
-import type { InspectOptions } from 'util';
+import type { InspectOptions as UtilInspectOptions } from 'util';
 import { inspect } from 'xshell/utils.js';
 export declare enum DdbForm {
     scalar = 0,
@@ -55,7 +55,11 @@ export declare enum DdbType {
     complex = 34,
     point = 35,
     duration = 36,
-    object = 37,
+    decimal32 = 37,
+    decimal64 = 38,
+    decimal128 = 39,
+    object = 40,
+    pynone = 41,
     symbol_extended = 145
 }
 export declare enum DdbFunctionType {
@@ -91,6 +95,26 @@ export interface DdbDurationValue {
     /** int32 */
     data: number;
 }
+export interface DdbDecimal32Value {
+    /** int32, data needs to be divided by 10^scale to get the original value */
+    scale: number;
+    /** int32, ddb null is js null */
+    data: number | null;
+}
+export interface DdbDecimal64Value {
+    /** int32, data needs to be divided by 10^scale to get the original value */
+    scale: number;
+    /** int32, ddb null is js null */
+    data: bigint | null;
+}
+export interface DdbDecimal32VectorValue {
+    scale: number;
+    data: Int32Array;
+}
+export interface DdbDecimal64VectorValue {
+    scale: number;
+    data: BigInt64Array;
+}
 export interface DdbSymbolExtendedValue {
     base_id: number;
     base: string[];
@@ -103,11 +127,11 @@ export interface DdbArrayVectorBlock {
     data: Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array;
 }
 export interface DdbMatrixValue {
-    rows: DdbObj<DdbVectorValue>;
-    cols: DdbObj<DdbVectorValue>;
+    rows: DdbVectorObj;
+    cols: DdbVectorObj;
     data: DdbVectorValue;
 }
-export declare type DdbDictValue = [DdbObj<DdbVectorValue>, DdbObj<DdbVectorValue>];
+export declare type DdbDictValue = [DdbVectorObj, DdbVectorObj];
 export declare enum DdbChartType {
     area = 0,
     bar = 1,
@@ -140,19 +164,26 @@ export interface DdbChartValue {
     extras?: {
         multi_y_axes: boolean;
     };
-    data: DdbObj<DdbMatrixValue>;
+    data: DdbMatrixObj;
 }
 export declare type DdbScalarValue = null | boolean | number | bigint | string | Uint8Array | // uuid, ipaddr, int128, blob
 [
     number,
     number
 ] | // complex, point
-DdbFunctionDefValue | DdbDurationValue;
+DdbFunctionDefValue | DdbDurationValue | DdbDecimal32Value | DdbDecimal64Value;
 export declare type DdbVectorValue = Uint8Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | string[] | // string[]
 Uint8Array[] | // blob
 DdbObj[] | // any
-DdbSymbolExtendedValue | DdbArrayVectorBlock[];
+DdbSymbolExtendedValue | DdbArrayVectorBlock[] | DdbDecimal32VectorValue | DdbDecimal64VectorValue;
 export declare type DdbValue = DdbScalarValue | DdbVectorValue | DdbMatrixValue | DdbDictValue | DdbChartValue;
+export declare type DdbVectorObj = DdbObj<DdbVectorValue>;
+export declare type DdbVectorAnyObj = DdbObj<DdbObj[]>;
+export declare type DdbVectorStringObj = DdbObj<string[]>;
+export declare type DdbTableObj = DdbObj<DdbVectorObj[]>;
+export declare type DdbDictObj = DdbObj<[DdbVectorObj, DdbVectorObj]>;
+export declare type DdbMatrixObj = DdbObj<DdbMatrixValue>;
+export declare type DdbChartObj = DdbObj<DdbChartValue>;
 export declare const nulls: {
     readonly int8: -128;
     readonly int16: -32768;
@@ -164,8 +195,15 @@ export declare const nulls: {
     readonly bytes16: Uint8Array;
 };
 export declare const timezone_offset: number;
-/** 可以表示所有 DolphinDB 数据库中的数据类型 */
-export declare class DdbObj<T extends DdbValue = DdbValue> {
+export declare enum StreamingStatusCode {
+    ok = 0,
+    connection_existed = 1,
+    not_leader = 2,
+    other = 3,
+    error = 4
+}
+/** Can represent data types in all DolphinDB databases */
+export declare class DdbObj<TValue extends DdbValue = DdbValue> {
     static dec: TextDecoder;
     static enc: TextEncoder;
     /** 维护已解析的 symbol base，比如流数据中后续的 symbol 向量可能只发送一个 base.id, base.size == 0, 依赖之前发送的 symbol base ？
@@ -196,8 +234,8 @@ export declare class DdbObj<T extends DdbValue = DdbValue> {
     rows?: number;
     /** 第 2 维 */
     cols?: number;
-    /** 实际数据。不同的 DdbForm, DdbType 使用 DdbValue 中不同的类型来表示实际数据 */
-    value: T;
+    /** The actual data. Different DdbForm, DdbType use different types in DdbValue to represent actual data */
+    value: TValue;
     /** 原始二进制数据，仅在 parse_object 为 false 时通过 parse_message 生成的顶层对象有这个属性 */
     buffer?: Uint8Array;
     constructor(data: Partial<DdbObj> & {
@@ -209,7 +247,7 @@ export declare class DdbObj<T extends DdbValue = DdbValue> {
     /** parse: rows, cols, items
         返回的 ddbobj.length 不包括 vector 的 type 和 form
     */
-    static parse_vector(buf: Uint8Array, le: boolean, type: DdbType): DdbObj<DdbVectorValue>;
+    static parse_vector(buf: Uint8Array, le: boolean, type: DdbType): DdbVectorObj;
     /** 有可能没有字节对齐，不能直接使用原有 message 的 arraybuffer, 统一复制出来，让原有 arraybuffer 被回收掉比较好 */
     static parse_vector_items(buf: Uint8Array, le: boolean, type: DdbType, length: number): [
         number,
@@ -217,7 +255,7 @@ export declare class DdbObj<T extends DdbValue = DdbValue> {
     ];
     pack(): Uint8Array;
     static pack_vector_body(value: DdbVectorValue, type: DdbType, length: number): ArrayBufferView[];
-    [inspect.custom](depth: number, options: InspectOptions, _inspect: any): string;
+    [inspect.custom](depth: number, _options: InspectOptions, _inspect: any): string;
     inspect_type(): string;
     /** 自动转换 js string, boolean 为 DdbObj */
     static to_ddbobj(value: DdbObj | string | boolean): DdbObj;
@@ -238,10 +276,15 @@ export declare class DdbObj<T extends DdbValue = DdbValue> {
         deep?: boolean;
     }): T;
 }
+export interface InspectOptions extends UtilInspectOptions {
+    colors?: boolean;
+    /** decimal places */
+    decimals?: number;
+}
 /** 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;
+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 */
-export declare function formati(obj: DdbObj<DdbVectorValue>, index: number, options: InspectOptions): string;
+export declare function formati(obj: DdbVectorObj, index: number, options?: InspectOptions): string;
 export declare class DdbVoid extends DdbObj<undefined> {
     constructor();
 }
@@ -308,7 +351,7 @@ export declare class DdbSetString extends DdbObj<string[]> {
 */
 export declare class DdbDict extends DdbObj<DdbDictValue> {
     constructor(obj: Record<string, boolean | string | DdbObj>);
-    constructor(keys: DdbObj<DdbVectorValue>, values: DdbObj<DdbVectorValue>);
+    constructor(keys: DdbVectorObj, values: DdbVectorObj);
 }
 export declare class DdbTable extends DdbObj<DdbObj[]> {
     constructor(columns: DdbObj[], name?: string);
@@ -364,6 +407,42 @@ export declare function str2nanotimestamp(str: string, format?: string): bigint;
 export declare function ipaddr2str(buffer: Uint8Array, le?: boolean, ipv6?: boolean): string;
 export declare function uuid2str(buffer: Uint8Array, le?: boolean): string;
 export declare function int1282str(buffer: Uint8Array, le?: boolean): string;
+export interface StreamingParams {
+    table: string;
+    action?: string;
+    handler(message: StreamingData): any;
+}
+export interface StreamingData extends StreamingParams {
+    /**
+        The time the server sent the message (nano seconds since epoch)
+        std::chrono::system_clock::now().time_since_epoch() / std::chrono::nanoseconds(1)
+    */
+    time: bigint;
+    /** message id */
+    id: bigint;
+    colnames: string[];
+    /** Subscription topic, which is the name of a subscription.
+        It is a string consisting of the alias of the node where the subscription table is located, the stream data table name, and the subscription task name (if actionName is specified), separated by `/`
+    */
+    topic: string;
+    /** The schema of the flow table, the type is table, there is no data in the column vector (rows === 0), only the column name and type */
+    schema: DdbTableObj;
+    /** Stream data, the type is any vector, each element of which corresponds to a column (without name) of the subscribed table, and the content in the column (DdbObj<DdbVectorValue>) is the new data value */
+    data: DdbObj<DdbVectorObj[]>;
+    window: {
+        /** The establishment of the connection starts offset = 0, and gradually increases as the window moves */
+        offset: number;
+        /** sum of segment.row in segments */
+        rows: number;
+        /** An array of data received each time */
+        segments: DdbObj<DdbVectorObj[]>[];
+    };
+}
+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;
@@ -387,6 +466,8 @@ export declare class DDB {
     password: string;
     /** python session flag (2048) */
     python: boolean;
+    /** Whether it is a streaming data connection, this field is always null for non-streaming data */
+    streaming: StreamingData;
     print_message_buffer: boolean;
     print_object_buffer: boolean;
     print_message: boolean;
@@ -407,11 +488,12 @@ export declare class DDB {
             - 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
         
         @example
         let ddb = new DDB('ws://127.0.0.1:8848')
         
-        // 使用 HTTPS 加密
+        // Encrypt with HTTPS
         let ddbsecure = new DDB('wss://dolphindb.com', {
             autologin: true,
             username: 'admin',
@@ -424,23 +506,13 @@ export declare class DDB {
         username?: string;
         password?: string;
         python?: boolean;
+        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`
-    */
-    connect(options?: {
-        url?: string;
-        autologin?: boolean;
-        username?: string;
-        password?: string;
-        python?: boolean;
-    }): Promise<void>;
+    /** Establish a actual websocket connection to the DolphindB corresponding to the URL
+        It is a power, and 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 */
@@ -466,6 +538,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）
@@ -529,8 +602,12 @@ export declare class DDB {
         listener?: DdbMessageListener;
         parse_object?: boolean;
     }): Promise<DdbObj<DdbValue>>;
+    /** Cancel all console jobs corresponding to the current session id */
+    cancel(): Promise<void>;
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
     parse_message(buf: Uint8Array, parse_object?: boolean): DdbMessage;
+    /** Internal stream subscription method */
+    subscribe(): Promise<DdbTableObj>;
 }
 export interface DdbMessageListener {
     (message: DdbMessage, _this: DDB): any;