Result Processing

The results from database read and write operations must be properly processed before being utilized in your application.

Return a Response

Methods such as gql() and uql() return a Response object. To serve the application, you need to first extract the DataItem from the Response object, and then transform it into an appropriate driver data class.

A Response object includes the following attributes:

Extract DataItem

To extract DataItem from a Response object, use the get() or alias() method.

A DataItem object includes the following attributes:

get()

Retrieves data by the alias index.

Parameters

• index: int: Index of the alias.

Returns

• DataItem: The returned data.

response = Conn.gql("MATCH (n)-[e]->() RETURN n, e LIMIT 3")
print(response.get(0).toJSON())

The GQL query returns two aliases (n, e), and the get() method gets the DataItem of the alias n at index 0.

{"alias": "n", "entities": [{"uuid": 72059793061183504, "id": "ULTIPA800000000000003B", "schema": "account", "values": {"gender": "female", "industry": "Publishing", "name": "Velox", "year": 1976}}, {"uuid": 648520545364606993, "id": "ULTIPA800000000000003E", "schema": "account", "values": {"gender": "female", "industry": "Food&Beverage", "name": "Claire", "year": 1989}}, {"uuid": 720578139402534937, "id": "ULTIPA8000000000000050", "schema": "account", "values": {"gender": "male", "industry": "Education", "name": "Holly", "year": 2000}}], "type": "NODE"}

alias()

Retrieves data by the alias name.

Parameters

• alias: str: Name of the alias.

Returns

• DataItem: The returned data.

response = Conn.gql("MATCH (n)-[e]->() RETURN n, e LIMIT 3")
print(response.alias("e").toJSON())

The GQL query returns two aliases (n, e), and the alias() method gets DataItem of the alias e.

{"alias": "e", "entities": [{"schema": "agree", "uuid": 139, "fromId": "ULTIPA800000000000000E", "toId": "ULTIPA800000000000000D", "fromUuid": 6269012880322985990, "toUuid": 7998395137233256453, "values": {"targetPost": 905, "timestamp": 1572662452, "datetime": "2019-11-02 18:40:52"}}, {"schema": "agree", "uuid": 167, "fromId": "ULTIPA800000000000000E", "toId": "ULTIPA800000000000000F", "fromUuid": 6269012880322985990, "toUuid": 8214567919347040263, "values": {"targetPost": 1419, "timestamp": 1554431053, "datetime": "2019-04-05 18:24:13"}}, {"schema": "agree", "uuid": 15, "fromId": "ULTIPA8000000000000065", "toId": "ULTIPA8000000000000067", "fromUuid": 6629300850512625701, "toUuid": 5764609722057490465, "values": {"targetPost": 1374, "timestamp": 1552775174, "datetime": "2019-03-17 14:26:14"}}], "type": "EDGE"}

Transform DataItem

You should use a as<DataStructure>() method to convert the DataItem.entities into the corresponding driver data class.

For example, the GQL query contained in the request below retrieves 3 nodes from the graph, the asNodes() method is used to convert the DataItem associated with the alias n into a list of Node objects:

response = Conn.gql("MATCH (n) RETURN n LIMIT 3")
nodeList = response.alias('n').asNodes()
for node in nodeList:
    print(node.getID())

The following lists all the transformation methods available on DataItem. Please note the applicable DataItem.type and DataItem.alias of each method.

Return a ResponseWithExistCheck

Methods such as createGraphIfNotExist() return a ResponseWithExistCheck object.

A ResponseWithExistCheck object includes the following attributes:

Return an InsertResponse

Some data insertion methods such as insertNodesBatchBySchema() and insertNodesBatchAuto() return an InsertResponse object.

An InsertResponse object includes the following attributes:

Return a JobResponse

Methods such as createFulltext() return a JobResponse object.

A JobResponse object includes the following attributes:

Return Driver Data Classes

Some methods return either a single instance or a list of driver data class, which can be used directly. For example:

• The getGraph() method returns a single GraphSet object.
• The showGraph() method returns List[GraphSet].