showSchema()
方法及相关接口:
showSchema(commonReq?: RequestType.RequestConfig): Promise<ULTIPA.Response<ResponseType.AllSchema>>
示例:获取 test 图集的 schema 列表
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// 创建名为 conn 的连接并使用 default 图集,此部分代码省略
let resp = await conn.showSchema({ graphSetName: "test" });
console.log(resp.data?.nodeSchema);
console.log(resp.data?.edgeSchema);
};
sdkUsage();
showNodeSchema() | showEdgeSchema()
方法及相关接口:
showNodeSchema(req?: RequestType.GetSchema,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<ResponseType.Schema>>
showEdgeSchema(req?: RequestType.GetSchema,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<ResponseType.Schema>>
interface GetSchema {
name: string;
}
示例:获取 test 图集的点 schema 'account' 和边 schema 'transfer' 的信息
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// 创建名为 conn 的连接并使用 default 图集,此部分代码省略
let resp = await conn.showNodeSchema({ name: "account" }, { graphSetName: "test" });
console.log(resp.data);
resp = await conn.showEdgeSchema({ name: "transfer" }, { graphSetName: "test" });
console.log(resp.data);
};
sdkUsage();
createSchema()
方法及相关接口:
createSchema(isNode: boolean,
req: RequestType.CreateSchema,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
interface CreateSchema {
name: string;
desc?: string;
}
示例:为图集 test 创建点 schema 'card' 和边 schema 'own'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// 创建名为 conn 的连接并使用 default 图集,此部分代码省略
let resp = await conn.createSchema(
true,
{ name: "card", desc: "bank card" },
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
resp = await conn.createSchema(
false,
{ name: "own", desc: "card owned by customer" },
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
};
sdkUsage();
createNodeSchema() | createEdgeSchema()
方法及相关接口:
createNodeSchema(req: RequestType.CreateSchema,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
createEdgeSchema(req: RequestType.CreateSchema,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
interface CreateSchema {
name: string;
desc?: string;
}
示例:为图集 test 创建点 schema 'card' 和边 schema 'own'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// 创建名为 conn 的连接并使用 default 图集,此部分代码省略
let resp = await conn.createNodeSchema(
{ name: "card", desc: "bank card" },
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
resp = await conn.createEdgeSchema(
{ name: "own", desc: "customer owns card" },
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
};
sdkUsage();
updateNodeSchema() | updateEdgeSchema()
方法及相关接口:
updateNodeSchema(req: RequestType.UpdateSchema,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
updateEdgeSchema(req: RequestType.UpdateSchema,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
interface UpdateSchema {
name: string;
newName?: string;
newDesc?: string;
}
示例:修改图集 test 的点 schema 'card' 和边 schema 'own'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// 创建名为 conn 的连接并使用 default 图集,此部分代码省略
let resp = await conn.updateNodeSchema(
{ name: "card", newName: "account", newDesc: "bank account" },
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
resp = await conn.updateEdgeSchema(
{ name: "own", newName: "has", newDesc: "customer has card" },
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
};
sdkUsage();
dropSchema()
方法及相关接口:
dropSchema(isNode: boolean,
req: RequestType.DeleteSchema,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
interface DeleteSchema {
name: string;
}
示例:删除图集 test 的点 schema 'account' 和边 schema 'has'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// 创建名为 conn 的连接并使用 default 图集,此部分代码省略
let resp = await conn.dropSchema(
true,
{ name: "account" },
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
resp = await conn.dropSchema(
false,
{ name: "has" },
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
};
sdkUsage();
dropNodeSchema() | dropEdgeSchema()
方法及相关接口:
dropNodeSchema(req: RequestType.DeleteSchema,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
dropEdgeSchema(req: RequestType.DeleteSchema,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
interface DeleteSchema {
name: string;
}
示例:删除图集 test 的点 schema 'account' 和边 schema 'has'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// 创建名为 conn 的连接并使用 default 图集,此部分代码省略
let resp = await conn.dropNodeSchema(
{ name: "account" },
{ graphSetName: "test" },
);
resp = await conn.dropEdgeSchema(
{ name: "has" },
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
};
sdkUsage();