dolphindb 2.0.800 → 2.0.900

package/index.d.ts

@@ -126,12 +126,15 @@ export interface DdbArrayVectorBlock {
     lengths: Uint8Array | Uint16Array | Uint32Array;
     data: Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array;
 }
+export type DdbArrayVectorValue = DdbArrayVectorBlock[] & /* decimal32, decimal64 会有这个属性 */ {
+    scale?: number;
+};
 export interface DdbMatrixValue {
     rows: DdbVectorObj;
     cols: DdbVectorObj;
     data: DdbVectorValue;
 }
-export declare type DdbDictValue = [DdbVectorObj, DdbVectorObj];
+export type DdbDictValue = [DdbVectorObj, DdbVectorObj];
 export declare enum DdbChartType {
     area = 0,
     bar = 1,
@@ -166,24 +169,24 @@ export interface DdbChartValue {
     };
     data: DdbMatrixObj;
 }
-export declare type DdbScalarValue = null | boolean | number | bigint | string | Uint8Array | // uuid, ipaddr, int128, blob
+export type DdbScalarValue = null | boolean | number | bigint | string | Uint8Array | // uuid, ipaddr, int128, blob
 [
     number,
     number
 ] | // complex, point
 DdbFunctionDefValue | DdbDurationValue | DdbDecimal32Value | DdbDecimal64Value;
-export declare type DdbVectorValue = Uint8Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | string[] | // string[]
+export type DdbVectorValue = Uint8Array | Int8Array | Int16Array | Int32Array | Float32Array | Float64Array | BigInt64Array | string[] | // string[]
 Uint8Array[] | // blob
 DdbObj[] | // any
-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>;
+DdbSymbolExtendedValue | DdbArrayVectorValue | DdbDecimal32VectorValue | DdbDecimal64VectorValue;
+export type DdbValue = DdbScalarValue | DdbVectorValue | DdbMatrixValue | DdbDictValue | DdbChartValue;
+export type DdbVectorObj = DdbObj<DdbVectorValue>;
+export type DdbVectorAnyObj = DdbObj<DdbObj[]>;
+export type DdbVectorStringObj = DdbObj<string[]>;
+export type DdbTableObj = DdbObj<DdbVectorObj[]>;
+export type DdbDictObj = DdbObj<[DdbVectorObj, DdbVectorObj]>;
+export type DdbMatrixObj = DdbObj<DdbMatrixValue>;
+export type DdbChartObj = DdbObj<DdbChartValue>;
 export declare const nulls: {
     readonly int8: -128;
     readonly int16: -32768;
@@ -194,14 +197,6 @@ export declare const nulls: {
     readonly double: number;
     readonly bytes16: Uint8Array;
 };
-export declare const timezone_offset: number;
-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;
@@ -255,7 +250,7 @@ export declare class DdbObj<TValue 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;
@@ -425,10 +420,10 @@ export interface StreamingData extends StreamingParams {
         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[]>;
+    /** Number of new streaming data rows */
+    rows: number;
     window: {
         /** The establishment of the connection starts offset = 0, and gradually increases as the window moves */
         offset: number;
@@ -437,8 +432,14 @@ export interface StreamingData extends StreamingParams {
         /** An array of data received each time */
         segments: DdbObj<DdbVectorObj[]>[];
     };
+    /** After successfully subscribed, if the subsequently pushed message is parsed incorrectly, the error will be set and the handler will be called. */
+    error?: Error;
+}
+export declare const winsize: 100000;
+export declare class ConnectionError extends Error {
+    ddb: DDB;
+    constructor(ddb: DDB);
 }
-export declare const winsize: 40;
 export declare class DDB {
     /** 当前的 session id (http 或 tcp) */
     sid: string;
@@ -505,23 +506,10 @@ export declare class DDB {
         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`
-            - streaming?: When this option is set, the WebSocket connection is only used for streaming data
-    */
-    connect({ url, autologin, username, password, python, streaming }?: {
-        url?: string;
-        autologin?: boolean;
-        username?: string;
-        password?: string;
-        python?: boolean;
-        streaming?: StreamingParams;
-    }): 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 */
@@ -547,6 +535,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）
@@ -615,7 +604,7 @@ export declare class DDB {
     /** 解析服务端响应报文，返回去掉 header 的 data buf */
     parse_message(buf: Uint8Array, parse_object?: boolean): DdbMessage;
     /** Internal stream subscription method */
-    subscribe(): Promise<DdbTableObj>;
+    subscribe(): Promise<StreamingData>;
 }
 export interface DdbMessageListener {
     (message: DdbMessage, _this: DDB): any;
@@ -632,4 +621,4 @@ export interface DdbErrorMessage {
     type: 'error';
     data: Error;
 }
-export declare type DdbMessage = DdbPrintMessage | DdbObjectMessage | DdbErrorMessage;
+export type DdbMessage = DdbPrintMessage | DdbObjectMessage | DdbErrorMessage;