本节介绍用于管理图中schema与属性的方法。
Schema
showSchema()
获取图中全部schema。
参数
config: RequestConfig（可选）：请求配置。
返回值
list[Schema]：获取的schema列表。
Python
CopyCopied
xxxxxxxxxxrequestConfig = RequestConfig(graph="miniCircle")schemas = Conn.showSchema(requestConfig)data = [[schema.name, schema.dbType.name, schema.stats] for schema in schemas]headers = ["Name", "Type", "Stats"]print(tabulate.tabulate(data, headers=headers, tablefmt="grid"))Output
CopyCopied
xxxxxxxxxx+-----------+--------+------------------------------------------------------------------------------------------------------+| Name | Type | Stats |+===========+========+======================================================================================================+| default | DBNODE | [{'from': '', 'to': '', 'count': 0}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| account | DBNODE | [{'from': '', 'to': '', 'count': 111}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| celebrity | DBNODE | [{'from': '', 'to': '', 'count': 78}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| country | DBNODE | [{'from': '', 'to': '', 'count': 23}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| movie | DBNODE | [{'from': '', 'to': '', 'count': 92}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| default | DBEDGE | [{'from': '', 'to': '', 'count': 0}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| direct | DBEDGE | [{'from': 'celebrity', 'to': 'movie', 'count': 98}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| disagree | DBEDGE | [{'from': 'account', 'to': 'account', 'count': 86}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| filmedIn | DBEDGE | [{'from': 'movie', 'to': 'country', 'count': 192}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| follow | DBEDGE | [{'from': 'account', 'to': 'account', 'count': 152}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| wishlist | DBEDGE | [{'from': 'account', 'to': 'movie', 'count': 175}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| response | DBEDGE | [{'from': 'account', 'to': 'account', 'count': 884}] |+-----------+--------+------------------------------------------------------------------------------------------------------+| review | DBEDGE | [{'from': 'movie', 'to': 'country', 'count': 100}, {'from': 'account', 'to': 'account', 'count': 1}] |+-----------+--------+------------------------------------------------------------------------------------------------------+showNodeSchema()
获取图中全部点schema。
参数
config: RequestConfig（可选）：请求配置。
返回值
list[Schema]：获取的schema列表。
Python
CopyCopied
xxxxxxxxxx# Retrieves all node schemas in the graph 'miniCircle'requestConfig = RequestConfig(graph="miniCircle")schemas = Conn.showNodeSchema(requestConfig)for schema in schemas: print(f"{schema.name}, {schema.dbType.name}")Output
CopyCopied
xxxxxxxxxxdefault, DBNODEaccount, DBNODEcelebrity, DBNODEcountry, DBNODEmovie, DBNODEshowEdgeSchema()
获取图中全部边schema。
参数
config: RequestConfig（可选）：请求配置。
返回值
list[Schema]：获取的schema列表。
Python
CopyCopied
xxxxxxxxxx# Retrieves all edge schemas in the graph 'miniCircle'requestConfig = RequestConfig(graph="miniCircle")schemas = Conn.showEdgeSchema(requestConfig)for schema in schemas: print(f"{schema.name}, {schema.dbType.name}")Output
CopyCopied
xxxxxxxxxxdefault, DBEDGEdirect, DBEDGEdisagree, DBEDGEfilmedIn, DBEDGEfollow, DBEDGEwishlist, DBEDGEresponse, DBEDGEreview, DBEDGEgetSchema()
获取图中一个指定的schema。
参数
schemaName: str：schema名称。dbType: DBtype：schema类型（点或边）。config: RequestConfig（可选）：请求配置。
返回值
Schema：获取的schema。
Python
CopyCopied
xxxxxxxxxx# Retrieves the node schema named 'account'requestConfig = RequestConfig(graph="miniCircle")schema = Conn.getSchema("account", DBType.DBNODE, requestConfig)print(schema.total)Output
CopyCopied
xxxxxxxxxx111getNodeSchema()
获取图中一个指定的点schema。
参数
schemaName: str：schema名称。config: RequestConfig（可选）：请求配置。
返回值
Schema：获取的schema。
Python
CopyCopied
xxxxxxxxxx# Retrieves the node schema named 'account'requestConfig = RequestConfig(graph="miniCircle")schema = Conn.getNodeSchema("account", requestConfig)if schema: for property in schema.properties: print(property.name)else: print("Not found")Output
CopyCopied
xxxxxxxxxxgenderyearindustrynamegetEdgeSchema()
获取图中一个指定的边schema。
参数
schemaName: str：schema名称。config: RequestConfig（可选）：请求配置。
返回值
Schema：获取的schema。
Python
CopyCopied
xxxxxxxxxx# Retrieves the edge schema named 'disagree'requestConfig = RequestConfig(graph="miniCircle")schema = Conn.getEdgeSchema("disagree", requestConfig)if schema: for property in schema.properties: print(property.name)else: print("Not found")Output
CopyCopied
xxxxxxxxxxdatetimetimestamptargetPostcreateSchema()
在图中创建一个schema。
参数
schema: Schema：待创建的schema；name和dbType属性必填，description和properties可选。isCreateProperties: bool（可选）：是否创建属性，默认为False。config: RequestConfig（可选）：请求配置。
返回值
Response：请求结果。
Python
CopyCopied
xxxxxxxxxxrequestConfig = RequestConfig(graph="miniCircle")# Creates node schema 'utility' (with properties)utility = Schema( name="utility", dbType=DBType.DBNODE, properties=[ Property(name="name", type=UltipaPropertyType.STRING), Property(name="type", type=UltipaPropertyType.UINT32) ])response1 = Conn.createSchema(utility, True, requestConfig)print(response1.status.code.name)time.sleep(3)# Creates edge schema 'vote' (without properties)managedBy = Schema( name="vote", dbType=DBType.DBEDGE)response2 = Conn.createSchema(managedBy, False, requestConfig)print(response2.status.code.name)Output
CopyCopied
xxxxxxxxxxSUCCESSSUCCESScreateSchemaIfNotExist()
在图中创建一个schema，并返回是否图中已有同名点或边schema存在。
参数
schema: Schema：待创建的schema；name和dbType属性必填，description和properties可选。isCreateProperties: bool（可选）：是否创建属性，默认为False。config: RequestConfig（可选）：请求配置。
返回值
ResponseWithExistCheck：请求结果。
Python
CopyCopied
xxxxxxxxxxrequestConfig = RequestConfig(graph="miniCircle")schema = Schema( name="utility", dbType=DBType.DBNODE, properties=[ Property(name="name", type=UltipaPropertyType.STRING), Property(name="type", type=UltipaPropertyType.UINT32) ])result = Conn.createSchemaIfNotExist(schema, True, requestConfig)print("Does the schema already exist?", result.exist)if result.response.status is None: print("Schema creation status: No response")else: print("Schema creation status:", result.response.status.code.name)print("----- Creates the schema again -----")result_1 = Conn.createSchemaIfNotExist(schema, True, requestConfig)print("Does the schema already exist?", result_1.exist)if result_1.response.status is None: print("Schema creation status: No response")else: print("Schema creation status:", result_1.response.status.code.name)Output
CopyCopied
xxxxxxxxxxDoes the schema already exist? FalseSchema creation status: SUCCESS----- Creates the schema again -----Does the schema already exist? TrueSchema creation status: No responsealterSchema()
修改图中一个schema的名称和描述。
参数
originalSchema: Schema：待修改的schema；name和dbType属性必填。newSchema:Schema：用于设置新的schemaname和/或description的Schema对象。config: RequestConfig（可选）：请求配置。
返回值
Response：请求结果。
Python
CopyCopied
xxxxxxxxxx# Renames the node schema 'utility' to 'securityUtility' in the graph 'miniCircle'requestConfig = RequestConfig(graph="miniCircle")schema = Conn.getNodeSchema("utility", requestConfig)newSchema = Schema(name="securityUtility")response = Conn.alterSchema(schema, newSchema, requestConfig)print(response.status.code.name)Output
CopyCopied
xxxxxxxxxxSUCCESSdropSchema()
从图中删除一个指定的schema。
参数
schema: Schema：待删除的schema；name和dbType属性必填。config: RequestConfig（可选）：请求配置。
返回值
Response：请求结果。
Python
CopyCopied
xxxxxxxxxx# Drops the edge schema 'vote' from the graph 'miniCircle'requestConfig = RequestConfig(graph="miniCircle")schema = Conn.getEdgeSchema("vote", requestConfig)response = Conn.dropSchema(schema, requestConfig)print(response.status.code.name)Output
CopyCopied
xxxxxxxxxxSUCCESS属性
showProperty()
获取图中全部属性。
参数
dbType: DBType（可选）：属性类型（点或边）。schemaName: str（可选）：schema名称。config: RequestConfig（可选）：请求配置。
返回值
Dict[str, List[Property]：一个字典，键是nodeProperties或edgeProperties，值是属性列表。
Python
CopyCopied
xxxxxxxxxx# Retrieves all properties in the graph 'transaction'requestConfig = RequestConfig(graph="transaction")properties = Conn.showProperty(config=requestConfig)nodeProperties = properties["nodeProperties"]print("Node Properties:")for nodeProperty in nodeProperties: print(f"{nodeProperty.name} is associated with schema {nodeProperty.schema}")edgeProperties = properties["edgeProperties"]print("Edge Properties:")for edgeProperty in edgeProperties: print(f"{edgeProperty.name} is associated with schema {edgeProperty.schema}")Output
CopyCopied
xxxxxxxxxxNode Properties:_id is associated with schema default_id is associated with schema Papertitle is associated with schema Paperscore is associated with schema Paperauthor is associated with schema PaperEdge Properties:weight is associated with schema CitesshowNodeProperty()
获取图中全部点属性。
参数
schemaName: str（可选）：schema名称。config: RequestConfig（可选）：请求配置。
返回值
List[Property]：获取的属性列表。
Python
CopyCopied
xxxxxxxxxx# Retrieves properties associated with the node schema 'Paper' in the graph 'citation'requestConfig = RequestConfig(graph="citation")properties = Conn.showNodeProperty("Paper", requestConfig)for property in properties: print(property.name, "-", property.type.name)Output
CopyCopied
xxxxxxxxxx_id - STRINGtitle - STRINGscore - INT32author - STRINGshowEdgeProperty()
获取图中全部边属性。
参数
schemaName: str（可选）：schema名称。config: RequestConfig（可选）：请求配置。
返回值
List[Property]：获取的属性列表。
Python
CopyCopied
xxxxxxxxxx# Retrieves properties associated with the edge schema 'Cites' in the graph 'citation'requestConfig = RequestConfig(graph="citation")properties = Conn.showEdgeProperty("Cites", requestConfig)for property in properties: print(property.name, "-", property.type.name)Output
CopyCopied
xxxxxxxxxxweight - INT32getProperty()
获取图中一个指定的属性。
参数
dbType: DBType：属性类型（点或边）。propertyName: str：属性名称。schemaName: str：schema名称。config: RequestConfig（可选）：请求配置。
返回值
Property：获取的属性。
Python
CopyCopied
xxxxxxxxxx# Retrieves node property 'title' associated with the node schema 'Paper' in the graph 'citation'requestConfig = RequestConfig(graph="citation")property = Conn.getProperty(DBType.DBNODE, "title", "Paper", requestConfig)print(property.toJSON())Output
CopyCopied
xxxxxxxxxx{'type': <UltipaPropertyType.STRING: 7>, 'subType': None, 'description': '', 'name': 'title', 'lte': False, 'schema': 'Paper', 'encrypt': '', 'extra': None, 'read': None, 'write': None}getNodeProperty()
获取图中一个指定的点属性。
参数
propertyName: str：属性名称。schemaName: str：schema名称。config: RequestConfig（可选）：请求配置。
返回值
Property：获取的属性。
Python
CopyCopied
xxxxxxxxxx# Retrieves node property 'title' associated with the node schema 'Paper' in the graph 'citation'requestConfig = RequestConfig(graph="citation")property = Conn.getNodeProperty("title", "Paper", requestConfig)print(property.toJSON())Output
CopyCopied
xxxxxxxxxx{'type': <UltipaPropertyType.STRING: 7>, 'subType': None, 'description': '', 'name': 'title', 'lte': False, 'schema': 'Paper', 'encrypt': '', 'extra': None, 'read': None, 'write': None}getEdgeProperty()
获取图中一个指定的边属性。
参数
propertyName: str：属性名称。schemaName: str：schema名称。config: RequestConfig（可选）：请求配置。
返回值
Property：获取的属性。
Python
CopyCopied
xxxxxxxxxx# Retrieves edge property 'weight' associated with the edge schema 'Cites' in the graph 'citation'requestConfig = RequestConfig(graph="citation")property = Conn.getEdgeProperty("weight", "Cites", requestConfig)print(property.toJSON())Output
CopyCopied
xxxxxxxxxx{'type': <UltipaPropertyType.INT32: 1>, 'subType': None, 'description': '', 'name': 'weight', 'lte': False, 'schema': 'Cites', 'encrypt': '', 'extra': None, 'read': None, 'write': None}createProperty()
在图中创建一个属性。
参数
dbType: DBType：属性类型（点或边）。schemaName: str：Schema名称，用*可指定全部schema。property: Property：待创建的属性；name和type（以及subType，如果type为SET或LIST）属性必填，encrypt和description可选。config: RequestConfig（可选）：请求配置。
返回值
Response：请求结果。
Python
CopyCopied
xxxxxxxxxx# Creates a property 'year' for all node schemas, creates a property 'tags' for the node schema 'Paper'requestConfig = RequestConfig(graph="citation")property1 = Property( name="year", type=UltipaPropertyType.UINT32, encrypt="AES128")property2 = Property( name="tags", type=UltipaPropertyType.SET, subType=[UltipaPropertyType.STRING])response1 = Conn.createProperty(DBType.DBNODE, "*", property1, requestConfig)print(response1.status.code.name)response2 = Conn.createProperty(DBType.DBNODE, "Paper", property2, requestConfig)print(response2.status.code.name)Output
CopyCopied
xxxxxxxxxxSUCCESSSUCCESScreatePropertyIfNotExist()
在图中创建一个属性，并返回是否图中指定点或边schema下已有同名属性存在。
参数
dbType: DBType：属性类型（点或边）。schemaName: str：Schema名称，用*可指定全部schema。property: Property：待创建的属性；name和type（以及subType，如果type为SET或LIST）属性必填，encrypt和description可选。config: RequestConfig（可选）：请求配置。
返回值
ResponseWithExistCheck：请求结果。
Python
CopyCopied
xxxxxxxxxxrequestConfig = RequestConfig(graph="citation")property = Property( name="tags", type=UltipaPropertyType.SET, subType=[UltipaPropertyType.STRING], encrypt="AES128")result = Conn.createPropertyIfNotExist(DBType.DBNODE, "Paper", property, requestConfig)print("Does the property already exist?", result.exist)if result.response.status is None: print("Property creation status: No response")else: print("Property creation status:", result.response.status.code.name)print("----- Creates the property again -----")result_1 = Conn.createPropertyIfNotExist(DBType.DBNODE, "Paper", property, requestConfig)print("Does the property already exist?", result_1.exist)if result_1.response.status is None: print("Property creation status: No response")else: print("Property creation status:", result_1.response.status.code.name)Output
CopyCopied
xxxxxxxxxxDoes the property already exist? FalseProperty creation status: SUCCESS----- Creates the property again -----Does the property already exist? TrueProperty creation status: No responsealterProperty()
修改图中指定属性的名称和描述。
参数
dbType: DBType：属性类型（点或边）。originProp: Property：待修改的属性；name和schema属性必填（用*可指定全部schema）。newProp: Property：用于设置新的属性name和/或description的Property对象。config: RequestConfig（可选）：请求配置。
返回值
Response：请求结果。
Python
CopyCopied
xxxxxxxxxx# Renames the property 'tags' of the node schema 'Paper' to 'keywords' in the graph 'citation'requestConfig = RequestConfig(graph="citation")property = Property(name="tags", schema="Paper")newProperty = Property(name="keywords")response = Conn.alterProperty(DBType.DBNODE, property, newProperty, requestConfig)print(response.status.code.name)Output
CopyCopied
xxxxxxxxxxSUCCESSdropProperty()
从图中删除指定的属性。
参数
dbType: DBType：属性类型（点或边）。property: Property：待删除的属性；name和schema属性必填（用*可指定全部schema）。config: RequestConfig（可选）：请求配置。
返回值
Response：请求结果。
Python
CopyCopied
xxxxxxxxxx# Drops the property 'tags' of the node schema in the graph 'citation'requestConfig = RequestConfig(graph="citation")property = Property(name="tags", schema="Paper")response = Conn.dropProperty(DBType.DBNODE, property, requestConfig)print(response.status.code.name)Output
CopyCopied
xxxxxxxxxxSUCCESS完整示例
Example.py
CopyCopied
xxxxxxxxxxfrom ultipa import UltipaConfig, Connection, Schema, Property, DBType, RequestConfig, UltipaPropertyTypeultipaConfig = UltipaConfig()# URI example: ultipaConfig.hosts = ["https://mqj4zouys.us-east-1.cloud.ultipa.com:60010"]ultipaConfig.hosts = ["192.168.1.85:60061", "192.168.1.87:60061", "192.168.1.88:60061"]ultipaConfig.username = "<username>"ultipaConfig.password = "<password>"Conn = Connection.NewConnection(defaultConfig=ultipaConfig) # Creates schemas and properties in the graph 'social'requestConfig = RequestConfig(graph="social")movie = Schema( name="movie", dbType=DBType.DBNODE, properties=[ Property(name="name", type=UltipaPropertyType.STRING), Property(name="type", type=UltipaPropertyType.UINT32) ])likes = Schema( name="utility", dbType=DBType.DBEDGE, properties=[ Property(name="time", type=UltipaPropertyType.DATETIME) ])schemas = [movie, likes]for schema in schemas: response = Conn.createSchema(schema, True, requestConfig) print(response.status.code.name)