@ultipa-graph/ultipa-node-sdk
Version:
NodeJS SDK for ultipa-server 4.0
90 lines (89 loc) • 3.23 kB
TypeScript
import { ConnectionBase } from "./connection.base";
import { ULTIPA, RequestType, ResponseType } from "../../types";
import { ExportReply, DownloadFileReply } from "../../proto/ultipa_pb";
export declare class BaseExtra extends ConnectionBase {
/**
* 查看节点状态
*/
stats(requestConfig?: RequestType.RequestConfig): Promise<ULTIPA.Response<ResponseType.Stat>>;
/**
* 查看正在运行的uql
*/
top(requestConfig?: RequestType.RequestConfig): Promise<ULTIPA.Response<ResponseType.Top[]>>;
/**
* 终止运行时 UQL
*/
kill(processId?: string, all?: boolean, requestConfig?: RequestType.RequestConfig): Promise<ULTIPA.Response<null>>;
/**
* 下载文件，一般为算法生成的文件
*
* @example
* ```js
* let res = await client.download({
path: "file_path",
}, {
stream: {
onData: (data) => {
// deal data
},
onEnd: () => {
// end
}
}
})
* ```
*/
download(params: RequestType.Download, cb: (chunk: Uint8Array | string) => void, commonReq: RequestType.CommonStreamRequire): Promise<import("@grpc/grpc-js").ClientReadableStream<DownloadFileReply>>;
/**
* 下载算法文件
* @param params
* @param commonReq
*/
downloadAlgoResultFile(fileName: string, taskId: string, cb: (chunk: Uint8Array | string) => void, requestConfig: RequestType.CommonStreamRequire): Promise<import("@grpc/grpc-js").ClientReadableStream<DownloadFileReply>>;
/**
* 导出点或边的数据
*
* @example
* ```js
* let conn = ...
* let res = await client.export({
dbType: ULTIPA.DBType.DBEDGE,
limit: 100,
selectPropertiesName: ["hash"],
schemaName: 'transactions'
}, async(n,e) => {}, {
stream: {
onData: (data) => {
// deal data
},
onEnd: () => {
// end
},
onError: (err) => {
reject(err)
}
}
})
* ```
*/
export(request: RequestType.ExportRequest, cb: (nodes: ULTIPA.Node[], edges: ULTIPA.Edge[]) => void, requestConfig?: RequestType.RequestConfig): Promise<import("@grpc/grpc-js").ClientReadableStream<ExportReply>>;
/**
* 清空所有数据
*
* @example
* ```js
* let conn = ...
* // 清除所有数据
* let res = await client.truncate({name: "graph_set_name"})
* // 清除点数据
* let res = await client.truncate({name: "graph_set_name", schema:'node_name', dbType: ULTIPA.DBType.DBNODE})
* // 清除边数据
* let res = await client.truncate({name: "graph_set_name", schema:'edge_name', dbType: ULTIPA.DBType.DBEDGE})
* ```
*/
truncate(request: RequestType.Truncate, requestConfig?: RequestType.RequestConfig): Promise<ULTIPA.Response<null>>;
/**
* 碎片整理
*/
compact(graphName: string, requestConfig?: RequestType.RequestConfig): Promise<ULTIPA.Response<null>>;
}