ultipa.structs package

Submodules

ultipa.structs.Algo module

class ultipa.structs.Algo.ALGO_RESULT

Bases: object

ALGO_RESULT_UNSET = -1

WRITE_TO_CLIENT = 4

WRITE_TO_DB = 2

WRITE_TO_FILE = 1

WRITE_TO_VISUALIZATION = 8

class ultipa.structs.Algo.Algo(name, description, version, result_opt, parameters, write_to_stats_parameters, write_to_db_parameters, write_to_file_parameters)

Bases: BaseModel

Data class for algorithm.

description: str

name: str

parameters: dict

result_opt: str

version: str

write_to_db_parameters: dict

write_to_file_parameters: dict

write_to_stats_parameters: dict

class ultipa.structs.Algo.AlgoResultOpt

Bases: BaseModel

can_realtime: bool

can_visualization: bool

can_write_back: bool

ultipa.structs.BaseModel module

class ultipa.structs.BaseModel.BaseModel

Bases: object

Processing class that defines settings for returned data related operations.

toDict()

toJSON(pretty=False)

ultipa.structs.DBType module

class ultipa.structs.DBType.DBType

Bases: object

Data class for data type

DBEDGE = 1

DBNODE = 0

ultipa.structs.Edge module

class ultipa.structs.Edge.Edge(values: Dict, from_id: str | None = None, from_uuid: int | None = None, to_id: str | None = None, to_uuid: int | None = None, schema: str | None = None, uuid: int | None = None, **kwargs)

Bases: BaseModel

Data class for edge.

get(propertyName: str)

getFrom()

getFromUUID()

getSchema()

getTo()

getToUUID()

getUUID()

getValues()

set(propertyName: str, value)

ultipa.structs.EntityRow module

class ultipa.structs.EntityRow.EntityRow(values: Dict, schema: str | None = None, id: str | None = None, from_id: str | None = None, to_id: str | None = None, uuid: int | None = None, from_uuid: int | None = None, to_uuid: int | None = None, **kwargs)

Bases: object

Data class for data rows (nodes or edges) to be inserted.

ultipa.structs.Graph module

class ultipa.structs.Graph.Graph(name: str, description: str | None = None)

Bases: BaseModel

Data class for graphset.

description: str

id: str

name: str

status: str

totalEdges: str

totalNodes: str

ultipa.structs.InsertType module

class ultipa.structs.InsertType.InsertType

Bases: object

Data class for insert type.

NORMAL = 0

OVERWRITE = 1

UPSERT = 2

ultipa.structs.Node module

class ultipa.structs.Node.Node(values: Dict, schema: str | None = None, id: str | None = None, uuid: int | None = None, **kwargs)

Bases: BaseModel

Data calss for node.

get(propertyName: str)

getID()

getSchema()

getUUID()

getValues()

set(propertyName: str, value)

class ultipa.structs.Node.NodeAlias(alias: str, nodes: List[Node] | None = None)

Bases: object

ultipa.structs.Path module

class ultipa.structs.Path.Path(nodes: List[Node], edges: List[Edge], nodeSchemas, edgeSchemas)

Bases: BaseModel

Data class for path.

edgeSchemas: Dict[str, Schema] = {}

getEdges()

getNodes()

length()

nodeSchemas: Dict[str, Schema] = {}

class ultipa.structs.Path.PathAlias(alias: str, paths: List[Path] | None = None)

Bases: object

Data class for path with alias.

getEdges()

getNodes()

length()

ultipa.structs.Property module

class ultipa.structs.Property.Property(name: str, type: PropertyTypeStr = 'string', description: str = '', subTypes: List[PropertyTypeStr] | None = None, lte: bool | None = None, schema: str | None = None)

Bases: object

Data class for property.

description: str

getPropertyTypeByString(v)

getStringByPropertyType(v)

getStringType()

isIdType() → bool

isIgnore()

lte: bool

name: str

schema: str

setSubTypesbyType(type: str)

setTypeInt(value)

setTypeStr(value)

subTypes: List[PropertyTypeStr]

type: PropertyTypeStr

ultipa.structs.PropertyType module

class ultipa.structs.PropertyType.PropertyType

Bases: object

Data class for property type mapping to gRPC.

PROPERTY_BLOB = 11

PROPERTY_DATETIME = 8

PROPERTY_DECIMAL = 13

PROPERTY_DOUBLE = 6

PROPERTY_FLOAT = 5

PROPERTY_FROM = -3

PROPERTY_FROM_UUID = -4

PROPERTY_ID = -2

PROPERTY_IGNORE = -7

PROPERTY_INT32 = 1

PROPERTY_INT64 = 3

PROPERTY_LIST = 14

PROPERTY_MAP = 16

PROPERTY_NULL = 17

PROPERTY_POINT = 12

PROPERTY_SET = 15

PROPERTY_STRING = 7

PROPERTY_TEXT = 10

PROPERTY_TIMESTAMP = 9

PROPERTY_TO = -5

PROPERTY_TO_UUID = -6

PROPERTY_UINT32 = 2

PROPERTY_UINT64 = 4

PROPERTY_UNSET = 0

PROPERTY_UUID = -1

class ultipa.structs.PropertyType.PropertyTypeStr

Bases: object

Data class for property type mapping to string.

PROPERTY_BLOB = 'blob'

PROPERTY_DATETIME = 'datetime'

static PROPERTY_DECIMAL(accuracy, scale)

PROPERTY_DOUBLE = 'double'

PROPERTY_FLOAT = 'float'

PROPERTY_INT = 'int32'

PROPERTY_INT64 = 'int64'

PROPERTY_LIST = 'list'

PROPERTY_MAP = 'map'

PROPERTY_POINT = 'point'

PROPERTY_SET = 'set'

PROPERTY_STRING = 'string'

PROPERTY_TEXT = 'text'

PROPERTY_TIMESTAMP = 'timestamp'

PROPERTY_UINT32 = 'uint32'

PROPERTY_UINT64 = 'uint64'

PROPERTY_UNSET = 'unset'

ultipa.structs.ResultType module

class ultipa.structs.ResultType.ResultType

Bases: object

Data class for returned result type.

RESULT_TYPE_ATTR = 4

RESULT_TYPE_EDGE = 3

RESULT_TYPE_ExplainPlan = 'ExplainPlan'

RESULT_TYPE_NODE = 2

RESULT_TYPE_PATH = 1

RESULT_TYPE_TABLE = 5

RESULT_TYPE_UNSET = 0

static getTypeStr(type)

ultipa.structs.Retry module

class ultipa.structs.Retry.Retry(current: int = 0, max: int = 3)

Bases: object

Processing class that defines settings for retry.

class ultipa.structs.Retry.RetryResponse(canRetry, currentRetry, nextRetry)

Bases: object

Processing class that defines settings for retry response.

ultipa.structs.Schema module

class ultipa.structs.Schema.Schema(name: str, dbType: DBType, type: str | None = None, description: str | None = None, properties: List[Property] | None = None, total: int | None = None)

Bases: BaseModel

Data class for schema.

getProperty(name: str)

Module contents