Response interpretation

The ordinary Get query (without aggregation or grouping) returns a stream/iterator of a ConceptMap objects.

Every iteration returns the result as a ConceptMap object.

The get query with aggregation can only return a singular value (aggregated result). Hence, it returns a Future object of Numeric.

Use Future object’s get() method to wait and retrieve the Numeric object when it’s ready.

The get query with grouping returns a stream/iterator of ConceptMapGroup objects.

Every iteration should return the result as a ConceptMapGroup object.

Use ConceptMapGroup object to retrieve ConceptMap.

The get query with grouping and aggregation returns a stream/iterator of a NumericGroup objects.

Every iteration should return the result as a NumericGroup object.

Use NumericGroup object to retrieve Numeric.

An insert query returns a stream/iterator of a ConceptMap objects.

Every iteration should return the result as a ConceptMap object.

Delete query can only return a Future object of a void (empty response).

We can’t retrieve any useful data from the Future object for delete query.

Similar to an insert query.

Similar to a delete query.

Similar to a delete query.

Explain query returns a stream/iterator of an Explanation objects.

For more information on inference explanation please see the Inferring data page.

ConceptMap is a special object, made for mapping of variables from a query to concepts in a database. Its methods provide a way to interact with the concepts.

Usually represents a single solution/answer from a stream of answers for a TypeDB query.

It’s a container for a ConceptMap object with an owner.

Object to represent a type or an instance of a type (data) from a database.

There are separate methods for every built-in type and for instances of every built-in type.

Numeric object represents a numeric value.

NumericGroup object has not only a Numeric object but also an owner.

Future object represents an asynchronous query result to be able to get the value later, when query execution completes.

Explanation is a special object returned as a response to an explain query. These are used to explain data inference. To perform an explain query use explainables and explainable objects.

Invoking a TypeQL query sends it to a TypeDB server, where it will be completed in the background. Local processing can take place while waiting for responses to be received. Take advantage of these asynchronous queries to mask network round-trip costs and increases throughput.

For example, if we are performing 10 get queries in a transaction, it’s best to send them all to the server before iterating over any of their answers.