showAllProperty()
Method and interface:
showAllProperty(req?: RequestType.ListAllProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<ResponseType.AllProperty>>
interface ListAllProperty {}
Example: Acquire all properties of graphset 'test'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// omit code of establishing server connection 'conn' using graphset 'default'
let resp = await conn.showAllProperty(
{},
{ graphSetName: "test" }
);
console.log(resp.data?.node);
console.log(resp.data?.edge);
};
sdkUsage();
showProperty()
Method and interface:
showProperty(isNode: boolean,
req?: RequestType.ListProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<ResponseType.Property[]>>
interface ListProperty {
schema?: string;
}
示例Example: Acquire properties of node schema 'customer' and edge schema 'transfer' of graphset 'test'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// omit code of establishing server connection 'conn' using graphset 'default'
let resp = await conn.showProperty(
true,
{ schema: "customer" },
{ graphSetName: "test" },
);
console.log(resp.data);
resp = await conn.showProperty(
false,
{ schema: "transfer" },
{ graphSetName: "test" },
);
console.log(resp.data);
};
sdkUsage();
showNodeProperty() | showEdgeProperty()
Method and interface:
showNodeProperty(req?: RequestType.ListProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<ResponseType.Property[]>>
showEdgeProperty(req?: RequestType.ListProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<ResponseType.Property[]>>
interface ListProperty {
schema?: string;
}
Example: Acquire properties of node schema 'customer' and edge schema 'transfer' of graphset 'test'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// omit code of establishing server connection 'conn' using graphset 'default'
let resp = await conn.showNodeProperty(
{ schema: "customer" },
{ graphSetName: "test" },
);
console.log(resp.data);
resp = await conn.showEdgeProperty(
{ schema: "transfer" },
{ graphSetName: "test" },
);
console.log(resp.data);
};
sdkUsage();
createProperty()
Method and interface:
createProperty(isNode: boolean,
req: RequestType.CreateProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
interface CreateProperty {
name: string;
schema?: string;
type?: ULTIPA.PropertyType;
description?: string;
}
Example: Craete node property @customer.level
and edge property @transfer.amount
for graphset 'test'
import { ConnectionPool, ULTIPA } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// omit code of establishing server connection 'conn' using graphset 'default'
let resp = await conn.createProperty(
true,
{
name: "level",
schema: "customer",
type: ULTIPA.PropertyType.PROPERTY_INT32,
description: "customer level",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
resp = await conn.createProperty(
false,
{
name: "amount",
schema: "transfer",
type: ULTIPA.PropertyType.PROPERTY_FLOAT,
description: "customer level",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
};
sdkUsage();
createNodeProperty() | createEdgeProperty()
Method and interface:
createNodeProperty(req: RequestType.CreateProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
createEdgeProperty(req: RequestType.CreateProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
interface CreateProperty {
name: string;
schema?: string;
type?: ULTIPA.PropertyType;
description?: string;
}
Example: Craete node property @customer.level
and edge property @transfer.amount
for graphset 'test'
import { ConnectionPool, ULTIPA } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// omit code of establishing server connection 'conn' using graphset 'default'
let resp = await conn.createNodeProperty(
{
name: "level",
schema: "customer",
type: ULTIPA.PropertyType.PROPERTY_INT32,
description: "customer level",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
resp = await conn.createEdgeProperty(
{
name: "amount",
schema: "transfer",
type: ULTIPA.PropertyType.PROPERTY_FLOAT,
description: "customer level",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
};
sdkUsage();
updateProperty()
Method and interface:
updateProperty(isNode: boolean,
req: RequestType.UpdateProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
interface UpdateProperty {
schema?: string;
name: string;
newName?: string;
newDesc?: string;
}
Example: Modify node property @client.level
and edge property @transfer.type
of graphset 'test'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// omit code of establishing server connection 'conn' using graphset 'default'
let resp = await conn.updateProperty(
true,
{
name: "level",
schema: "client",
newName: "grade",
newDesc: "client grade",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
resp = await conn.updateProperty(
false,
{
name: "type",
schema: "transfer",
newName: "category",
newDesc: "transfer category",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
};
sdkUsage();
updateNodeProperty() | updateEdgeProperty()
Method and interface:
updateNodeProperty(req: RequestType.UpdateProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
updateEdgeProperty(req: RequestType.UpdateProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
interface UpdateProperty {
schema?: string;
name: string;
newName?: string;
newDesc?: string;
}
Example: Modify node property @client.level
and edge property @transfer.type
of graphset 'test'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// omit code of establishing server connection 'conn' using graphset 'default'
let resp = await conn.updateNodeProperty(
{
name: "level",
schema: "client",
newName: "grade",
newDesc: "client grade",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
resp = await conn.updateEdgeProperty(
{
name: "type",
schema: "transfer",
newName: "category",
newDesc: "transfer category",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
};
sdkUsage();
deleteProperty()
Method and interface:
deleteProperty(isNode: boolean,
req: RequestType.DeleteProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
interface DeleteProperty {
schema?: string;
name: string;
}
Example: Delete node property @card.level
and edge property @transfer.category
from graphset 'test'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// omit code of establishing server connection 'conn' using graphset 'default'
let resp = await conn.deleteProperty(
true,
{
name: "level",
schema: "client",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
resp = await conn.deleteProperty(
false,
{
name: "type",
schema: "transfer",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
};
sdkUsage();
deleteNodeProperty() | deleteEdgeProperty()
Method and interface:
deleteNodeProperty(req: RequestType.DeleteProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
deleteEdgeProperty(req: RequestType.DeleteProperty,
commonReq?: RequestType.RequestConfig
): Promise<ULTIPA.Response<null>>
interface DeleteProperty {
schema?: string;
name: string;
}
Example: Delete node property @card.level
and edge property @transfer.category
from graphset 'test'
import { ConnectionPool } from "@ultipa-graph/ultipa-node-sdk";
let sdkUsage = async () => {
// omit code of establishing server connection 'conn' using graphset 'default'
let resp = await conn.deleteNodeProperty(
{
name: "level",
schema: "client",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
resp = await conn.deleteEdgeProperty(
{
name: "type",
schema: "transfer",
},
{ graphSetName: "test" },
);
console.log(resp.status.code_desc);
};
sdkUsage();