ultipa.types package

Submodules

ultipa.types.types module

class ultipa.types.types.ArrayAlias(alias: str, elements)

Bases: object

class ultipa.types.types.Attr(alias: str, values: any, type: ResultType | None = None, type_desc: str | None = None)

Bases: object

class ultipa.types.types.AttrEdge(alias: str, values: List[List[Edge]], type: ResultType | None = None, type_desc: str | None = None)

Bases: object

class ultipa.types.types.AttrNewAlias(alias: str, attr: UltipaAttr)

Bases: object

class ultipa.types.types.AttrNode(alias: str, values: List[List[Node]], type: ResultType | None = None, type_desc: str | None = None)

Bases: object

class ultipa.types.types.AttrPath(alias: str, values: List[List[Path]], type: ResultType | None = None, type_desc: str | None = None)

Bases: object

class ultipa.types.types.BaseUqlReply(paths: List[PathAlias], nodes: List[NodeAlias], edges: List[EdgeAlias], tables: List[Table], attrs: List | None = None, resultAlias: List | None = None, explainPlan: List[ExplainPlan] | None = None)

Bases: object

class ultipa.types.types.ClusterInfo(redirect: str, raftPeers: List[RaftPeerInfo], leader: RaftPeerInfo | None = None)

Bases: object

class ultipa.types.types.Code

Bases: object

BASE_DB_ERROR = 3

ENGINE_ERROR = 4

FAILED = 1

NOT_RAFT_MODE = 10

PARAM_ERROR = 2

PERMISSION_DENIED = 13

RAFT_LEADER_NOT_YET_ELECTED = 7

RAFT_LOG_ERROR = 8

RAFT_NO_AVAILABLE_ALGO_SERVERS = 12

RAFT_NO_AVAILABLE_FOLLOWERS = 11

RAFT_REDIRECT = 6

SUCCESS = 0

SYSTEM_ERROR = 5

UNKNOW_ERROR = 1000

UQL_ERROR = 9

class ultipa.types.types.DataItem(alias: str, data: any, type: str)

Bases: BaseModel

asAlgos() → List[Algo]

asAny() → any

asAttr() → Attr

asEdgeList() → AttrEdge

asEdges() → List[Edge]

asFirstEdges() → Edge

asFirstNodes() → Node

asGraphs() → List[Graph]

asKV()

asNodeList() → AttrNode

asNodes() → List[Node]

asPathList() → AttrPath

asPaths() → List[Path]

asProperties() → List[Property]

asSchemas() → List[Schema]

asTable() → Table

class ultipa.types.types.DirectionType

Bases: object

left = 'left'

right = 'right'

class ultipa.types.types.EdgeAlias(alias: str, edges: List[Edge])

Bases: object

class ultipa.types.types.EdgeEntityTable(schemas: List[object], edgeRows: List[EntityRow] | None = None)

Bases: object

class ultipa.types.types.ExplainPlan(alias, childrenNum, uql, infos)

Bases: object

class ultipa.types.types.ExportReply(data: List[NodeAlias])

Bases: object

class ultipa.types.types.FollowerRole

Bases: object

ROLE_ALGO_EXECUTABLE = 2

ROLE_READABLE = 1

ROLE_UNSET = 0

class ultipa.types.types.NodeEntityTable(schemas: List[object], nodeRows: List[EntityRow] | None = None)

Bases: object

class ultipa.types.types.PaserAttrListData(type, nodes: List[Node] | None = None, edges: List[Edge] | None = None, paths: List[Path] | None = None, attrs: UltipaAttr | None = None)

Bases: object

class ultipa.types.types.RaftPeerInfo(host, status=None, isLeader=False, isAlgoExecutable=False, isFollowerReadable=False, isUnset=False)

Bases: object

class ultipa.types.types.ResultAlias(alias: str, result_type: int)

Bases: object

class ultipa.types.types.ReturnReq(graphSetName: str, uql: str, host: str, retry: Retry, uqlIsExtra: bool)

Bases: object

class ultipa.types.types.Status(code: Code, message: str, clusterInfo: ClusterInfo | None = None)

Bases: object

class ultipa.types.types.Table(table_name: str, headers: List[dict], table_rows: List[List])

Bases: BaseModel

getHeaders()

getName()

getRows()

headerToDicts() → List[Dict]

class ultipa.types.types.TaskStatus

Bases: object

TASK_COMPUTING = 1

TASK_DONE = 3

TASK_FAILED = 4

TASK_STOP = 5

TASK_WAITING = 0

TASK_WRITEBACKING = 2

class ultipa.types.types.TruncateType

Bases: object

EDGES = 'edges'

NODES = 'nodes'

class ultipa.types.types.UltipaAttr(type: PropertyType, values: any, has_attr_data: bool = False, has_ultipa_data: bool = False, type_desc: any | None = None)

Bases: object

class ultipa.types.types.UltipaStatistics(edge_affected: int, node_affected: int, engine_time_cost: int, total_time_cost: int)

Bases: BaseModel

class ultipa.types.types.UqlReply(dataBase: BaseUqlReply, aliasMap: dict | None = None, datas: List | None = None)

Bases: BaseModel

datas: List[DataItem]

ultipa.types.types_request module

class ultipa.types.types_request.AlterPolicy(name: str, graphPrivileges: dict | None = None, systemPrivileges: List[str] | None = None, policies: List[str] | None = None)

Bases: Policy

class ultipa.types.types_request.AlterUser(username: str, password: str = None, graph_privileges: [<class 'dict'>] = None, system_privileges: ~typing.List[str] = None, policies: ~typing.List[str] = None)

Bases: CreateUser

class ultipa.types.types_request.Batch(Schema: Schema | None = None, Nodes: List[EntityRow] | None = None, Edges: List[EntityRow] | None = None)

Bases: object

Edges: List[EntityRow]

Nodes: List[EntityRow]

Schema: Schema

class ultipa.types.types_request.ClearTask(id: int | None = None, name: str | None = None, status: str | None = None, all: bool = False)

Bases: object

class ultipa.types.types_request.CommonSchema(schema: str, property: str)

Bases: object

Data calss for schema with name and description.

property toString

class ultipa.types.types_request.CreateFulltext(type: DBType, schema: str, property: str, name: str)

Bases: Index

class ultipa.types.types_request.CreateIndex(type: DBType, schema: str, property: str)

Bases: Index

class ultipa.types.types_request.CreatePolicy(name: str, graphPrivileges: dict | None = None, systemPrivileges: List[str] | None = None, policies: List[str] | None = None)

Bases: Policy

class ultipa.types.types_request.CreateUser(username: str, password: str, graphPrivileges: [<class 'dict'>] = None, systemPrivileges: ~typing.List[str] = None, policies: ~typing.List[str] = None)

Bases: object

class ultipa.types.types_request.DeleteEdge(uuid: [<class 'int'>] = None, filter: ~ultipa.utils.ufilter.new_ufilter.UltipaFilter = None, silent: bool = False)

Bases: DeleteNode

class ultipa.types.types_request.DeleteNode(uuid: [<class 'int'>] = None, filter: ~ultipa.utils.ufilter.new_ufilter.UltipaFilter = None, silent: bool = False)

Bases: object

class ultipa.types.types_request.Download(fileName: str, taskId: str, savePath: str | None = None)

Bases: object

class ultipa.types.types_request.DropFulltext(type: DBType, name: str = '')

Bases: object

class ultipa.types.types_request.DropIndex(type: DBType, schema: str, property: str)

Bases: Index

class ultipa.types.types_request.DropPolicy(name: str)

Bases: GetPolicy

class ultipa.types.types_request.Export(type: DBType, limit: int, schema: str, properties: List[str] | None = None)

Bases: object

class ultipa.types.types_request.GetPolicy(name: str)

Bases: object

class ultipa.types.types_request.GrantPolicy(username: str = '', graphPrivileges: dict | None = None, systemPrivileges: List[str] | None = None, policies: List[str] | None = None)

Bases: object

class ultipa.types.types_request.Index(type: DBType, schema: str, property: str)

Bases: CommonSchema

class ultipa.types.types_request.InsertEdge(edges: List[dict], schema: str, overwrite: bool = False, upsert: bool = False, isReturnID: bool = True)

Bases: object

setSchema(schema: str)

class ultipa.types.types_request.InsertNode(nodes: List[dict], schema: str, overwrite: bool = False, upsert: bool = False, isReturnID: bool = True)

Bases: object

setSchema(schema: str)

class ultipa.types.types_request.InstallAlgo(configPath: str, soPath: str)

Bases: object

class ultipa.types.types_request.InstallExtaAlgo(configPath: str, soPath: str)

Bases: InstallAlgo

class ultipa.types.types_request.LTE(schemaName: CommonSchema, type: DBType)

Bases: object

class ultipa.types.types_request.Policy(name: str, graphPrivileges: dict | None = None, systemPrivileges: List[str] | None = None, policies: List[str] | None = None)

Bases: object

class ultipa.types.types_request.Return(alias: str, propertys: List[str] | None = None, allProperties: bool = False, limit: int = 1)

Bases: object

property toString

class ultipa.types.types_request.RevokePolicy(username: str = '', graphPrivileges: dict | None = None, systemPrivileges: List[str] | None = None, policies: List[str] | None = None)

Bases: GrantPolicy

class ultipa.types.types_request.SearchEdge(select: Return, id=None, filter: UltipaFilter | None = None)

Bases: SearchNode

class ultipa.types.types_request.SearchNode(select: Return, id=None, filter: UltipaFilter | None = None)

Bases: object

class ultipa.types.types_request.ShowTask(id: int | None = None, name: str | None = None, limit: int | None = None, status: str = '')

Bases: object

class ultipa.types.types_request.Truncate(graph: str, truncateType: TruncateType | None = None, allData: bool = False, schema: str | None = None)

Bases: object

class ultipa.types.types_request.UFE(schemaName: CommonSchema, type: DBType)

Bases: LTE

class ultipa.types.types_request.UltipaPath(nodeSchema: List[CommonSchema], edgeSchema: List[CommonSchema])

Bases: object

property toString

class ultipa.types.types_request.UpdateEdge(values: dict, uuid: [<class 'int'>] = None, filter: ~ultipa.utils.ufilter.new_ufilter.UltipaFilter = None, silent: bool = False)

Bases: UpdateNode

class ultipa.types.types_request.UpdateNode(values: dict, uuid: [<class 'int'>] = None, filter: ~ultipa.utils.ufilter.new_ufilter.UltipaFilter = None, silent: bool = False)

Bases: object

ultipa.types.types_response module

class ultipa.types.types_response.Algo

Bases: BaseModel

name: str

param: dict

result_opt: AlgoResultOpt

class ultipa.types.types_response.AlgoResultOpt

Bases: BaseModel

can_realtime: bool

can_visualization: bool

can_write_back: bool

class ultipa.types.types_response.AutoNet

Bases: SearchPath

paths: List[Path]

class ultipa.types.types_response.Cluster

Bases: object

cpuUsage: str

host: str

isAlgoExecutable: bool

isFollowerReadable: bool

isLeader: bool

isUnset: bool

memUsage: str

status: bool

class ultipa.types.types_response.ClusterInfo(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[Cluster]

class ultipa.types.types_response.Index

Bases: BaseModel

name: str

properties: str

schema: str

status: str

class ultipa.types.types_response.IndexTable

Bases: object

data: List[Index]

name: str

class ultipa.types.types_response.InsertResponse(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: ResponseBulk

class ultipa.types.types_response.NodeSpread

Bases: SearchPath

paths: List[Path]

class ultipa.types.types_response.Path

Bases: BaseModel

edges: List[Edge]

nodes: List[Node]

class ultipa.types.types_response.Policy

Bases: BaseModel

graphPrivileges: dict

name: str

policies: List[str]

systemPrivileges: List[str]

class ultipa.types.types_response.Privilege

Bases: BaseModel

graphPrivileges: List[str]

systemPrivileges: List[str]

class ultipa.types.types_response.PropertyTable(name, data)

Bases: BaseModel

data: List[Property]

name: str

class ultipa.types.types_response.Response(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: BaseModel

Print()

class ultipa.types.types_response.ResponseBatchAutoInsert(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: Dict[str, ResponseBulk]

class ultipa.types.types_response.ResponseBulk

Bases: object

errorItem: Dict

uuids: List[int]

class ultipa.types.types_response.ResponseCommon(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: None

class ultipa.types.types_response.ResponseExport(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[Node]

class ultipa.types.types_response.ResponseGetProperty(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[Property]

class ultipa.types.types_response.ResponseGraph(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: Graph

class ultipa.types.types_response.ResponseInsert(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[int]

class ultipa.types.types_response.ResponseListAlgo(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[Algo]

class ultipa.types.types_response.ResponseListFulltextIndex(status: Status | None = None, items: Dict | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None, explainPlan: List[ExplainPlan] | None = None)

Bases: ResponseListIndex

data: List[IndexTable]

class ultipa.types.types_response.ResponseListGraph(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[Graph]

class ultipa.types.types_response.ResponseListIndex(status: Status | None = None, items: Dict | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None, explainPlan: List[ExplainPlan] | None = None)

Bases: UltipaResponse

data: List[IndexTable]

class ultipa.types.types_response.ResponseListPolicy(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[Policy]

class ultipa.types.types_response.ResponseListPrivilege(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[Privilege]

class ultipa.types.types_response.ResponseListProperty(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[PropertyTable]

class ultipa.types.types_response.ResponseListTask(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[Task]

class ultipa.types.types_response.ResponseListTop(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[Top]

class ultipa.types.types_response.ResponseListUser(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: List[User]

class ultipa.types.types_response.ResponsePolicy(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: Policy

class ultipa.types.types_response.ResponseSearchEdge(status: Status | None = None, items: Dict | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None, explainPlan: List[ExplainPlan] | None = None)

Bases: UltipaResponse

items: List[DataItem]

class ultipa.types.types_response.ResponseSearchNode(status: Status | None = None, items: Dict | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None, explainPlan: List[ExplainPlan] | None = None)

Bases: UltipaResponse

items: List[DataItem]

class ultipa.types.types_response.ResponseStat(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: Stat

class ultipa.types.types_response.ResponseUser(status: Status | None = None, data: BaseUqlReply | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None)

Bases: Response

data: User

class ultipa.types.types_response.Return_Type

Bases: BaseModel

is_realtime: bool

is_visualization: bool

is_wirte_back: bool

class ultipa.types.types_response.SearchKhop

Bases: BaseModel

nodes: List[Node]

values: dict

class ultipa.types.types_response.SearchPath

Bases: BaseModel

paths: List[Path]

class ultipa.types.types_response.Stat

Bases: BaseModel

company: str

cpuCores: str

cpuUsage: str

expiredDate: str

memUsage: str

serverType: str

version: str

class ultipa.types.types_response.Task

Bases: BaseModel

param: dict

result: dict

task_info: Task_info

class ultipa.types.types_response.Task_info

Bases: BaseModel

TASK_STATUS: int

algo_name: str

end_time: int

engine_cost: int

return_type: Return_Type

start_time: int

status_code: str

task_id: int

time_cost: int

writing_start_time: int

class ultipa.types.types_response.Top

Bases: BaseModel

duration: str

process_id: str

process_uql: str

class ultipa.types.types_response.UltipaResponse(status: Status | None = None, items: Dict | None = None, req: ReturnReq | None = None, statistics: UltipaStatistics | None = None, aliases: List[ResultAlias] | None = None, explainPlan: List[ExplainPlan] | None = None)

Bases: BaseModel

Print()

alias(alias: str) → DataItem

get(index: int) → DataItem

getExplainPlan()

class ultipa.types.types_response.User

Bases: BaseModel

create: str

graphPrivileges: dict

last_login_time: str

policies: List[str]

systemPrivileges: List[str]

username: str

Module contents