@ultipa-graph/ultipa-driver 5.0.0-s5.0

package/dist/types/types.d.ts

@@ -0,0 +1,496 @@
+import { ResponseType } from '.';
+export declare namespace ULTIPA {
+    /**
+     * Raft集群的类型
+     */
+    enum ClientType {
+        Default = 0,
+        Algo = 1,
+        Update = 2,
+        Leader = 3
+    }
+    interface TimeZone {
+        timeZone?: string;
+        timeZoneOffset?: number;
+        timestampToString?: boolean;
+    }
+    /**
+     * 连接的配置
+     */
+    class UltipaConfig {
+        useHost?: string;
+        graphSetName?: string;
+        clusterId?: string;
+        timeZone?: string;
+        timeZoneOffset?: number;
+        timestampToString?: boolean;
+        logUql?: boolean;
+        timeout?: number;
+        threadNum?: number;
+        responseWithRequestInfo?: boolean;
+        consistency?: boolean;
+    }
+    /**
+     * 属性类型
+     */
+    enum PropertyType {
+        PROPERTY_UNSET,
+        PROPERTY_INT32,
+        PROPERTY_STRING,
+        PROPERTY_FLOAT,
+        PROPERTY_DOUBLE,
+        PROPERTY_UINT32,
+        PROPERTY_INT64,
+        PROPERTY_UINT64,
+        PROPERTY_DATETIME,
+        PROPERTY_TIMESTAMP,
+        PROPERTY_TEXT,
+        PROPERTY_BLOB,
+        PROPERTY_POINT,
+        PROPERTY_DECIMAL,
+        PROPERTY_LIST,
+        PROPERTY_SET,
+        PROPERTY_MAP,
+        PROPERTY_NULL,
+        PROPERTY_BOOL,
+        unset,
+        int32,
+        string,
+        float,
+        double,
+        uint32,
+        int64,
+        uint64,
+        datetime,
+        timestamp,
+        text,
+        blob,
+        point,
+        decimal,
+        list,
+        set,
+        map,
+        null,
+        bool
+    }
+    /**
+     * 返回状态码
+     */
+    enum Code {
+        SUCCESS,
+        FAILED,
+        PARAM_ERROR,
+        BASE_DB_ERROR,
+        ENGINE_ERROR,
+        SYSTEM_ERROR,
+        SYNTAX_ERROR,
+        PERMISSION_DENIED,
+        DUPLICATE_ID,
+        RAFT_REDIRECT,
+        RAFT_LEADER_NOT_YET_ELECTED,
+        RAFT_LOG_ERROR,
+        NOT_RAFT_MODE,
+        RAFT_NO_AVAILABLE_FOLLOWERS,
+        RAFT_NO_AVAILABLE_ALGO_SERVERS,
+        UNKNOWN_ERROR = 1000
+    }
+    enum ResultType {
+        RESULT_TYPE_UNSET,
+        RESULT_TYPE_PATH,
+        RESULT_TYPE_NODE,
+        RESULT_TYPE_EDGE,
+        RESULT_TYPE_ATTR,
+        RESULT_TYPE_TABLE
+    }
+    enum AuthenticateType {
+        PERMISSION_TYPE_UNSET,
+        PERMISSION_TYPE_UQL,
+        PERMISSION_TYPE_GQL,
+        PERMISSION_TYPE_INSERTNODES,
+        PERMISSION_TYPE_INSERTEDGES,
+        PERMISSION_TYPE_EXPORT,
+        PERMISSION_TYPE_DOWNLOADFILE,
+        PERMISSION_TYPE_INSTALLALGO,
+        PERMISSION_TYPE_UNINSTALLALGO,
+        PERMISSION_TYPE_ROLLBACKALGO
+    }
+    enum InsertType {
+        INSERT_TYPE_NORMAL,
+        INSERT_TYPE_OVERWRITE,
+        INSERT_TYPE_UPSERT
+    }
+    /** 语言类型 */
+    enum QueryType {
+        QL_UNSET = 0,
+        UQL = 1,
+        GQL = 2
+    }
+    /**
+     * 数据库类型
+     */
+    enum DBType {
+        /**
+         * 点
+         */
+        DBNODE,
+        /**
+         * 边
+         */
+        DBEDGE
+    }
+    /**
+     * 算法任务的状态
+     */
+    enum JOB_STATUS {
+        JOB_PENDING,
+        JOB_COMPUTING,
+        JOB_WRITING,
+        JOB_DONE,
+        JOB_FAILED,
+        JOB_STOPPED
+    }
+    /**
+     * 连接返回的统一状态
+     */
+    type Status = {
+        code: number;
+        code_desc?: string;
+        message: string;
+    };
+    type ResultAlias = {
+        alias: string;
+        result_type: ResultType;
+    };
+    type ResultAliases = ResultAlias[];
+    interface Job {
+        id: string;
+        graph: string;
+        type: string;
+        uql?: string;
+        gql?: string;
+        status: string;
+        error: string;
+        result: string;
+        startTime: string;
+        endTime: string;
+        progress: string;
+    }
+    interface Process {
+        id: string;
+        uql: string;
+        gql: string;
+        duration: number;
+        status: string;
+    }
+    interface Projection {
+        project_name: string;
+        project_type: string;
+        filter_type: string;
+        is_default: string;
+        graph_name: string;
+        status: string;
+        stats: string;
+        hdc_server_name: string;
+        hdc_server_status: string;
+        config: string;
+    }
+    /**
+     * 点的结构
+     */
+    class Node {
+        _id: string;
+        _uuid: string;
+        schema: string;
+        values: Map<string, any>;
+        getID(): string;
+        getUUID(): string;
+        getSchema(): string;
+        getValues(): Map<string, any>;
+        get(prop_name: string): any;
+        set(prop_name: string, value: any): void;
+    }
+    type NodeTable = Node[];
+    /**
+     * 一组点
+     */
+    type NodeAlias = {
+        nodes: NodeTable;
+        alias: string;
+    };
+    /**
+     * 边的结构
+     */
+    class Edge {
+        _uuid: string;
+        _from: string;
+        _to: string;
+        schema: string;
+        values: Map<string, any>;
+        getUUID(): string;
+        getSchema(): string;
+        getFrom(): string;
+        getTo(): string;
+        getValues(): Map<string, any>;
+        get(prop_name: string): any;
+        set(prop_name: string, value: any): void;
+    }
+    type EdgeTable = Edge[];
+    /**
+     * 一组边
+     */
+    type EdgeAlias = {
+        edges: EdgeTable;
+        alias: string;
+    };
+    /**
+     * 路径的结构
+     */
+    class Path {
+        nodeUUIDs: string[];
+        edgeUUIDs: string[];
+        getNodes(): string[];
+        getEdges(): string[];
+    }
+    type Paths = Path[];
+    class Graph {
+        paths?: Path[];
+        nodes: Map<string, Node>;
+        edges: Map<string, Edge>;
+        getPaths(): Path[];
+        getNodes(): Map<string, Node>;
+        getEdges(): Map<string, Edge>;
+    }
+    type PathAlias = {
+        alias: string;
+        paths: Paths;
+    };
+    type GraphAlias = {
+        alias: string;
+        graph: Graph;
+    };
+    type Header = {
+        name: string;
+        type: PropertyType;
+        subTypes: PropertyType[];
+    };
+    type GraphSet = {
+        id?: number | string;
+        name: string;
+        description?: string | "";
+        shards?: string[] | [];
+        partitionBy?: string | "";
+        /**  */
+        status?: string;
+        totalNodes?: number;
+        totalEdges?: number;
+    };
+    type Schema = {
+        name: string;
+        description?: string;
+        dbType: DBType;
+        total?: number;
+        properties?: Property[];
+    };
+    type Property = {
+        name: string;
+        description?: string;
+        schema: string;
+        type: PropertyType;
+        subTypes?: PropertyType[];
+    };
+    type Replica = {
+        addr: string;
+        status: string;
+        streamAddr: string;
+        lastHearBeat: string;
+    };
+    type Statistics = {
+        totalCost: number;
+        engineCost: number;
+        nodeAffected?: number;
+        edgeAffected?: number;
+    };
+    class License {
+        LicenseINFO: any;
+    }
+    /**
+     * 表格的结构
+     */
+    class Table {
+        name: string;
+        alias: string;
+        headers: string[];
+        rows: any[][];
+        toKV(): any[];
+        getHeaders(): string[];
+        getRows(): any[][];
+    }
+    type AttrAlias = {
+        values: any[];
+        type: ResultType;
+        type_desc: string;
+        alias: string;
+    };
+    type AttrNodesAlias = {
+        values: Node[][];
+        type: ResultType;
+        type_desc: string;
+        alias: string;
+    };
+    type AttrEdgesAlias = {
+        values: Edge[][];
+        type: ResultType;
+        type_desc: string;
+        alias: string;
+    };
+    type AttrPathsAlias = {
+        values: Path[][];
+        type: ResultType;
+        type_desc: string;
+        alias: string;
+    };
+    /**
+     * 一组属性
+     */
+    type AttrNewAlias = {
+        attr: Attr;
+        alias: string;
+    };
+    type Attr = {
+        type: PropertyType;
+        type_desc: string;
+        values: any[];
+        has_attr_data: boolean;
+        has_ultipa_data: boolean;
+    };
+    type AttrListData = {
+        type: ResultType;
+        type_desc: string;
+        nodes?: NodeTable;
+        edges?: EdgeTable;
+        paths?: Path[];
+        attrs?: Attr[];
+    };
+    type AttrMapData = {
+        key: Attr;
+        value: Attr;
+    };
+    type ListData = {
+        values: any[];
+    };
+    type SetData = ListData;
+    type MapValue = {
+        key: any;
+        value: any;
+    };
+    type MapData = {
+        values: MapData[];
+    };
+    type ExplainPlan = {
+        plan_nodes: PlanNode[];
+    };
+    type PlanNode = {
+        alias: string;
+        children_num: number;
+        children?: PlanNode[] | null;
+        query_text: string;
+        infos: string;
+    };
+    /**
+     * uql统一返回结构体的data
+     */
+    type QueryReplyBase = {
+        total_time_cost: number;
+        engine_time_cost: number;
+        results?: ResultAlias[];
+        paths?: PathAlias[];
+        nodes?: NodeAlias[];
+        edges?: EdgeAlias[];
+        graph?: GraphAlias[];
+        attrs?: AttrAlias[];
+        tables?: Table[];
+        statistics: Statistics;
+        explainPlans?: ExplainPlan;
+        explainPlansTreeTopNode?: PlanNode;
+    };
+    function getExplainPlansTreeTopNode(plans: ExplainPlan): PlanNode;
+    class QueryReply {
+        aliasMap: {
+            [x: string]: DataItem;
+        };
+        datas: DataItem[];
+        statistics: Statistics;
+        explainPlansTreeTopNode: PlanNode;
+        constructor(queryReplyBase: QueryReplyBase);
+        private defaultValueFromType;
+        ___aliasMapFromDatas(): void;
+        isEmpty(): boolean;
+        singleDataNodes(): Node[];
+        singleDataEdges(): Edge[];
+        singleDataPaths(): any;
+        getTables(): Table[];
+        singleDataTables(): Table;
+        singleDataAttrs(): AttrAlias;
+        get(index: number): DataItem;
+        alias(alias: string): DataItem;
+        toJSON(): {
+            statistics: Statistics;
+            explainPlansTreeTopNode: PlanNode;
+            datas: DataItem[];
+        };
+    }
+    class DataItem {
+        data: any;
+        type: ResultType;
+        type_desc: string;
+        alias: string;
+        constructor(alias: string, data: any, type: ResultType);
+        private _asTypeError;
+        asEdges(): EdgeTable;
+        asPaths(): Paths;
+        asGraph(): Graph[];
+        asNodes(): NodeTable;
+        asTable(): Table;
+        asAttrs(): AttrAlias;
+        asNodeList(): AttrNodesAlias;
+        asEdgeList(): AttrEdgesAlias;
+        asPathList(): AttrPathsAlias;
+        asGraphs(): ResponseType.GraphSet[];
+        asProperties(): ResponseType.Property[];
+        asSchemas(): ResponseType.Schema[];
+        asAlgos(): ResponseType.Algo[];
+        asExtas(): ResponseType.Exta[];
+        asTasks(): ResponseType.Task[];
+        asAny(): any;
+        asTableWithT<T>(): T[];
+        toJSONString(): string;
+    }
+    /**
+     * 所有请求的统一返回结构体
+     */
+    class Response<T> {
+        req?: any;
+        status: Status;
+        data?: T;
+        statistics?: Statistics;
+        explainPlans?: ExplainPlan;
+    }
+    /**
+     * uql请求的返回结构体
+     */
+    class QueryResponse extends Response<ULTIPA.QueryReply> {
+    }
+    function NewQueryResponse(jsonObj: any): QueryResponse;
+    class QueryBaseResponse extends Response<ULTIPA.QueryReplyBase> {
+    }
+    function NewUQLBaseResponse(jsonObj: any): QueryBaseResponse;
+    function formatBaseResponse(base: QueryBaseResponse): any;
+    class UQLSingleResponse {
+        responseWithoutData: Response<null>;
+        QueryReply: QueryReply;
+    }
+    class TruncateType {
+        node: string;
+        edge: string;
+    }
+}