C gRPC driver

Closes the driver. Before instantiating a new driver, the driver that’s currently open should first be closed. Closing a driver frees the underlying Rust object.

void

Forcibly closes the driver. To be used in exceptional cases.

void

Checks whether this connection is presently open.

bool

Open a TypeDB C Driver to a TypeDB server available at the provided address.

struct TypeDBDriver*

Open a TypeDB Driver to a TypeDB server available at the provided address. This method allows driver language specification for drivers built on top of the native C layer.

struct TypeDBDriver*

Enables logging in the TypeDB driver.

This function sets up tracing with two environment variables:

If neither is set, the default level is INFO for driver crates.

The logging is initialized only once to prevent multiple initializations in applications that create multiple drivers.

void

class

A connection to a TypeDB server which serves as the starting point for all interaction.

class

User credentials for connecting to TypeDB

class

User connection settings for connecting to TypeDB.

A full schema text as a valid TypeQL define query string.

char*

Returns a DatabaseIterator over all databases present on the TypeDB server.

struct DatabaseIterator*

Checks if a database with the given name exists.

bool

Create a database with the given name.

void

Retrieve the database with the given name.

const struct Database*

Create a database with the given name based on previously exported another database’s data loaded from a file. This is a blocking operation and may take a significant amount of time depending on the database size.

void

class

A TypeDB database

Frees the native rust Database object

void

Deletes this database.

void

Export a database into a schema definition and a data files saved to the disk. This is a blocking operation and may take a significant amount of time depending on the database size.

void

The database name as a string.

char*

The types in the schema as a valid TypeQL define query string.

char*

class

An Iterator over databases present on the TypeDB server.

Frees the native rust DatabaseIterator object.

void

Forwards the DatabaseIterator and returns the next Database if it exists, or null if there are no more elements.

const struct Database*

Retrieves all users which exist on the TypeDB server.

struct UserIterator*

Checks if a user with the given name exists.

bool

Creates a user with the given name & password.

void

Retrieves a user with the given name.

struct User*

Retrieves the username of the user who opened this connection

struct User*

Deletes this database.

void

Frees the native rust User object.

void

Returns the name of this user.

char*

Updates the password for the current authenticated user.

void

class

Iterator over a set of Users

Frees the native rust UserIterator object

void

Forwards the UserIterator and returns the next User if it exists, or null if there are no more elements.

struct User*

class

A transaction with a TypeDB database.

Analyzes a TypeQL query in the transaction.

struct AnalyzedQueryPromise*

Forcibly closes this transaction. To be used in exceptional cases.

struct VoidPromise*

Commits the changes made via this transaction to the TypeDB database. Whether or not the transaction is commited successfully, the transaction is closed after the commit call and the native rust object is freed.

struct VoidPromise*

Checks whether this transaction is open.

bool

Opens a transaction to perform read or write queries on the database connected to the session.

struct Transaction*

Registers a callback function which will be executed when this transaction is closed.

struct VoidPromise*

Performs a TypeQL query in the transaction.

struct QueryAnswerPromise*

Rolls back the uncommitted changes made via this transaction.

struct VoidPromise*

Closes the transaction and frees the native rust object.

void

class

This enum is used to specify the type of transaction.

class

This enum is used to specify the type of transaction.

class

TypeDB transaction options. TransactionOptions object can be used to override the default server behaviour for opened transactions.

Frees the native Rust TransactionOptions object.

void

Returns the value set for the schema lock acquire timeout in this TransactionOptions object. If set, specifies how long the driver should wait if opening a transaction is blocked by an exclusive schema write lock.

int64_t

Returns the value set for the transaction timeout in this TransactionOptions object. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions.

int64_t

Checks whether the option for schema lock acquire timeout was explicitly set for this TransactionOptions object.

bool

Checks whether the option for transaction timeout was explicitly set for this TransactionOptions object.

bool

Produces a new TransactionOptions object.

struct TransactionOptions*

Explicitly sets schema lock acquire timeout. If set, specifies how long the driver should wait if opening a transaction is blocked by an exclusive schema write lock.

void

Explicitly set a transaction timeout. If set, specifies a timeout for killing transactions automatically, preventing memory leaks in unclosed transactions.

void

class

TypeDB query options. QueryOptions object can be used to override the default server behaviour for executed queries.

Frees the native Rust QueryOptions object.

void

Returns the value set for the "include instance types" flag in this QueryOptions object. If set, specifies if types should be included in instance structs returned in ConceptRow answers. This option allows reducing the amount of unnecessary data transmitted.

bool

Returns the value set for 'include query structure' in this QueryOptions object.

bool

Returns the value set for the prefetch size in this QueryOptions object. If set, specifies the number of extra query responses sent before the client side has to re-request more responses. Increasing this may increase performance for queries with a huge number of answers, as it can reduce the number of network round-trips at the cost of more resources on the server side. Minimal value: 1.

int64_t

Checks whether the "include instance types" flag was explicitly set for this QueryOptions object.

bool

Checks whether the prefetch size was explicitly set for this QueryOptions object.

bool

Checks whether the prefetch size was explicitly set for this QueryOptions object.

bool

Produces a new QueryOptions object.

struct QueryOptions*

Explicitly set the "include instance types" flag. If set, specifies if types should be included in instance structs returned in ConceptRow answers. This option allows reducing the amount of unnecessary data transmitted.

void

Explicitly set the prefetch size. If set, it requests the server to include the query structure in the answer header.

void

Explicitly set the prefetch size. If set, specifies the number of extra query responses sent before the client side has to re-request more responses. Increasing this may increase performance for queries with a huge number of answers, as it can reduce the number of network round-trips at the cost of more resources on the server side. Minimal value: 1.

void

Frees the native rust QueryAnswer object.

void

Retrieve the executed query’s type of the QueryAnswer.

enum QueryType

Produces an Iterator over all JSON ConceptDocuments in this QueryAnswer.

struct StringIterator*

Produces an Iterator over all ConceptRows in this QueryAnswer.

struct ConceptRowIterator*

Checks if the query answer is a ConceptDocumentStream.

bool

Checks if the query answer is a ConceptRowStream.

bool

Checks if the query answer is an Ok.

bool

class

Promise object representing the result of an asynchronous operation. Use query_answer_promise_resolve(QueryAnswerPromise*) to wait for and retrieve the resulting boolean value.

Frees the native rust QueryAnswerPromise object.

void

Waits for and returns the result of the operation represented by the QueryAnswer object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved.

struct QueryAnswer*

class

This enum is used to specify the type of the query resulted in this answer.

class

This enum is used to specify the type of the query resulted in this answer.

class

A single row of concepts representing substitutions for variables in the query. Contains a Header (column names and query type), and the row of optional concepts. An empty concept in a column means the variable does not have a substitution in this answer.

Frees the native rust ConceptRow object.

void

Checks whether the provided ConceptRow objects are equal

bool

Retrieves a concept for a given column name.

struct Concept*

Produces an Iterator over all String column names of the ConceptRow's header.

struct StringIterator*

Produces an Iterator over all Concepts in this ConceptRow.

struct ConceptIterator*

Retrieves a concept for a given column index.

struct Concept*

Retrieve the executed query’s structure from the ConceptRow's header, if set. It must be requested via "include query structure" in QueryOptions

struct Pipeline*

Retrieve the executed query’s type of the ConceptRow's header.

enum QueryType

Retrieve the ConjunctionIDs of Conjunctions that answered this row. May be null.

struct ConjunctionIDIterator*

A string representation of this ConceptRow.

char*

class

Iterator over the ConceptRows returned by an API method or query.

Frees the native rust ConceptRowIterator object

void

Forwards the ConceptRowIterator and returns the next ConceptRow if it exists, or null if there are no more elements.

struct ConceptRow*

class

Promise object representing the result of an asynchronous operation. A VoidPromise does not return a value, but must be resolved using void_promise_resolve(VoidPromise*) to ensure the operation has completed, or for a failed operation to set the error.

Frees the native rust VoidPromise object.

void

Waits for the operation represented by the VoidPromise to complete. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved.

void

class

Promise object representing the result of an asynchronous operation. Use bool_promise_resolve(BoolPromise*) to wait for and retrieve the resulting boolean value.

Frees the native rust BoolPromise object.

void

Waits for and returns the result of the operation represented by the BoolPromise object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved.

bool

class

Promise object representing the result of an asynchronous operation. Use string_promise_resolve(StringPromise*) to wait for and retrieve the resulting string.

Frees the native rust StringPromise object.

void

Waits for and returns the result of the operation represented by the BoolPromise object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved.

char*

class

Promise object representing the result of an asynchronous operation. Use concept_promise_resolve(ConceptPromise*) to wait for and retrieve the resulting boolean value.

Frees the native rust ConceptPromise object.

void

Waits for and returns the result of the operation represented by the ConceptPromise object. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved.

struct Concept*

Frees a native rust string. WARNING: Always use this function to free strings returned by the driver. Using the standard C free function will create a dangling reference on the rust side.

void

class

Iterator over the strings in the result of a request or a TypeQL Fetch query.

Frees the native rust StringIterator object

void

Forwards the StringIterator and returns the next string if it exists, or null if there are no more elements.

char*

class

The fundamental TypeQL object.

Frees the native rust Concept object

void

Checks whether the provided Concept objects are equal

bool

Returns a boolean value of this value concept. If the value has another type, the error is set.

bool

Returns the value of this date value concept as seconds since the start of the UNIX epoch. If the value has another type, the error is set.

int64_t

Returns the value of this datetime value concept as seconds and nanoseconds parts since the start of the UNIX epoch. If the value has another type, the error is set.

struct DatetimeInNanos

Returns the value of this datetime-tz value concept as seconds and nanoseconds parts since the start of the UNIX epoch and timezone information. If the value has another type, the error is set.

struct DatetimeAndTimeZone

Returns the decimal value of this value concept. If the value has another type, the error is set.

struct Decimal

Returns the double value of this value concept. If the value has another type, the error is set.

double

Returns the value of this duration value. If the value has another type, the error is set.

struct Duration

Returns the integer value of this value concept. If the value has another type, the error is set.

int64_t

Retrieves the label of this Concept. If this is an Instance, returns the label of the type of this instance ("unknown" if type fetching is disabled). If this is a Value, returns the label of the value type of the value. If this is a Type, returns the label of the type.

char*

Returns the string value of this value concept. If the value has another type, the error is set.

char*

Returns the value of this struct value concept represented as an iterator of {field_name: value?} pairs. If the value has another type, the error is set.

struct StringAndOptValueIterator*

Checks if this Concept is an Attribute.

bool

Checks if this Concept is an AttributeType.

bool

Returns true if the value which this Concept holds is of type boolean. Otherwise, returns false.

bool

Returns true if the value which this Concept holds is of type date. Otherwise, returns false.

bool

Returns true if the value which this Concept holds is of type datetime. Otherwise, returns false.

bool

Returns true if the value which this Concept holds is of type datetime-tz. Otherwise, returns false.

bool

Returns true if the value which this Concept holds is of type decimal. Otherwise, returns false.

bool

Returns true if the value which this Concept holds is of type double. Otherwise, returns false.

bool

Returns true if the value which this Concept holds is of type duration. Otherwise, returns false.

bool

Checks if this Concept is an Entity.

bool

Checks if this Concept is an EntityType.

bool

Returns true if the value which this Concept holds is of type integer. Otherwise, returns false.

bool

Checks if this Concept is a Relation.

bool

Checks if this Concept is a RelationType.

bool

Checks if this Concept is a RoleType.

bool

Returns true if the value which this Concept holds is of type string. Otherwise, returns false.

bool

Returns true if the value which this Concept holds is of type struct. Otherwise, returns false.

bool

Checks if this Concept is a Value.

bool

A string representation of this Concept object.

char*

Retrieves the unique id (IID) of this Concept. If this is an Entity or Relation Instance, returns the IID of the instance. Otherwise, returns null.

char*

Retrieves the optional label of this Concept. If this is an Instance, returns the label of the type of this instance (None if type fetching is disabled). If this is a Value, returns the label of the value type of the value. If this is a Type, returns the label of the type.

char*

Retrieves the value of this Concept, if it exists. If this is an Attribute instance, returns the value of this instance. If this a Value, returns the value. Otherwise, returns null.

struct Concept*

Retrieves the value type of this Concept, if it exists. If this is an Attribute instance, returns the value type of this instance. If this is a Value, returns its value type. If this is an AttributeType, returns the value type that the schema permits for the attribute type, if one is defined. Otherwise, returns null.

char*

class

Iterator over the Conceptss returned by an API method or query.

Frees the native rust ConceptIterator object

void

Forwards the ConceptIterator and returns the next Concept if it exists, or null if there are no more elements.

struct Concept*

class

Kind represents the base of a defined type to describe its capabilities. For example, "define entity person;" defines a type "person" of a kind "entity".

class

Kind represents the base of a defined type to describe its capabilities. For example, "define entity person;" defines a type "person" of a kind "entity".

Retrieves the type which this Entity belongs to.

struct Concept*

Retrieves the type which this Relation belongs to.

struct Concept*

Retrieves the type which this Attribute belongs to.

struct Concept*

class

A DatetimeInNanos used to represent datetime as a pair of seconds part and a number of nanoseconds since the last seconds boundary.

class

A DatetimeAndTimeZone used to represent time zoned datetime in FFI. Time zone can be represented either as an IANA Tz or as a FixedOffset. Either the zone_name (is_fixed_offset == false) or offset (is_fixed_offset == true) is set.

Frees the native rust DatetimeAndTimeZone object

void

class

A StringAndOptValue used to represent the pair of variables involved in an ownership. _0 and _1 are the owner and attribute variables respectively.

Frees the native rust StringAndOptValue object

void

class

Iterator over the StringAndOptValues representing struct value {field_name: value?} info.

Frees the native rust StringAndOptValueIterator object

void

Forwards the StringAndOptValueIterator and returns the next StringAndOptValue if it exists, or null if there are no more elements.

struct StringAndOptValue*

class

A fixed-point decimal number. Holds exactly 19 digits after the decimal point and a 64-bit value before the decimal point.

class

A relative duration, which contains months, days, and nanoseconds. Can be used for calendar-relative durations (eg 7 days forward), or for absolute durations using the nanosecond component When used as an absolute duration, convertible to chrono::Duration

Returns the analyzed fetch

struct Fetch*

Returns the analyzed functions in the preamble of the query.

struct FunctionIterator*

class

An AnalyzedQuery contains the server’s representation of the query and preamble functions; as well as the result of types inferred for each variable by type-inference.

Frees the native rust AnalyzedQuery object.

void

Returns the structure of the query pipeline in the analyzed query.

struct Pipeline*

Frees the native rust AnalyzePromise object.

void

Waits for and returns the result of the Analyze request. In case the operation failed, the error flag will only be set when the promise is resolved. The native promise object is freed when it is resolved.

struct AnalyzedQuery*

class

A representation of a query pipeline.

Frees the native rust Pipeline object.

void

Returns the Conjunction corresponding to the ConjunctionID. The Pipeline must be the one that contains the Conjunction & ConjunctionID.

struct Conjunction*

class

Representation of a stage in a Pipeline.

Unwraps the PipelineStage instance as a Delete stage, and returns the variables deleted. Will panic if the stage is not a Delete.

struct VariableIterator*

Frees the native rust PipelineStage object.

void

Returns the block of the pipeline stage - this is the ConjunctionID of the root conjunction. Will panic if the stage does not have a block.

struct ConjunctionID*

Unwraps the PipelineStage instance as a Limit stage, and returns the limit applied. Will panic if the stage is not a Limit stage.

int64_t

Unwraps the PipelineStage instance as an Offset stage, and returns the offset applied. Will panic if the stage is not an Offset stage.

int64_t

Unwraps the PipelineStage instance as a Reduce stage, and returns the variables being grouped on. Will panic if the stage is not a Reduce stage.

struct VariableIterator*

Unwraps the PipelineStage instance as a Reduce stage, and returns the reducers applied and the variables their results are assigned to. Will panic if the stage is not a Reduce stage.

struct ReduceAssignmentIterator*

Unwraps the PipelineStage instance as a Require stage, and returns the required variables. Will panic if the stage is not a Require stage.

struct VariableIterator*

Unwraps the PipelineStage instance as a Select stage, and returns the variables selected. Will panic if the stage is not a Select.

struct VariableIterator*

Unwraps the PipelineStage instance as a Sort stage, and returns the SortVariable. Will panic if the stage is not a Sort stage.

struct SortVariableIterator*

Returns a string representation of the pipeline stage

char*

Returns the variant of the Pipeline stage.

enum PipelineStageVariant

Returns an iterator over the stages making up the Pipeline

struct PipelineStageIterator*

Frees the native rust PipelineStageIterator object.

void

Forwards the PipelineStageIterator and returns the next PipelineStage if it exists, or null if there are no more elements.

struct PipelineStage*

class

A representation of the constraints involved in the query, and types inferred for each variable.

Frees the native rust Conjunction object.

void

Returns the variables in the current conjunction for which type annotations are available

struct VariableIterator*

Returns the Constraints in the given conjunction.

struct ConstraintWithSpanIterator*

Returns the inferred types for the specified variable in the specified conjunction.

struct VariableAnnotations*

class

Holds the index of the conjunction in a Pipeline's conjunctions field. Used as indirection in the representation of a pipeline.

Returns the ConjunctionID as u32 to use in hash, equality etc.

uint32_t

Frees the native rust ConjunctionID object.

void

Returns a string representation of the ConjunctionID.

char*

Frees the native rust ConjunctionIDIterator object.

void

Forwards the ConjunctionIDIterator and returns the next ConjunctionID if it exists, or null if there are no more elements.

struct ConjunctionID*

Unwraps the Constraint instance as a Comparison constraint, and returns the comparator used in the comparison. Will panic if the Constraint is not a Comparison constraint.

enum Comparator

Unwraps the Constraint instance as a Comparison constraint, and returns the left-hand side vertex. Will panic if the Constraint is not a Comparison constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Comparison constraint, and returns the right-hand side vertex. Will panic if the Constraint is not a Comparison constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as an Expression constraint, and returns the expression arguments - These are any variables used in the right-hand side of the expression. Will panic if the Constraint is not an Expression constraint.

struct ConstraintVertexIterator*

Unwraps the Constraint instance as an Expression constraint, and returns the variable assigned by the expression. Will panic if the Constraint is not an Expression constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as an Expression constraint, and returns the expression text. Will panic if the Constraint is not an Expression constraint.

char*

Unwraps the Constraint instance as a FunctionCall constraint, and returns the variables passed as arguments to the function call . Will panic if the Constraint is not a FunctionCall constraint.

struct ConstraintVertexIterator*

Unwraps the Constraint instance as a FunctionCall constraint, and returns the variables assigned by the function call. Will panic if the Constraint is not a FunctionCall constraint.

struct ConstraintVertexIterator*

Unwraps the Constraint instance as a FunctionCall constraint, and returns the function name. Will panic if the Constraint is not a FunctionCall constraint.

char*

Unwraps the Constraint instance as a Has constraint, and returns the attribute vertex. Will panic if the Constraint is not a Has constraint.

struct ConstraintVertex*

(FUTURE-USE: Currently always ConstraintExactness::Subtypes) Unwraps the Constraint instance as a Has constraint, and returns the exactness of the attribute match. Will panic if the Constraint is not a Has constraint.

enum ConstraintExactness

Unwraps the Constraint instance as a Has constraint, and returns the owner vertex. Will panic if the Constraint is not a Has constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as an Iid constraint, and returns the iid value as a string. Will panic if the Constraint is not an Iid constraint.

char*

Unwraps the Constraint instance as an Iid constraint, and returns the concept (variable) the iid applies to. Will panic if the Constraint is not an Iid constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as an Is constraint, and returns the left-hand side vertex. Will panic if the Constraint is not an Is constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as an Is constraint, and returns the right-hand side vertex. Will panic if the Constraint is not an Is constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as an Isa constraint, and returns the exactness of the type match. Will panic if the Constraint is not an Isa constraint.

enum ConstraintExactness

Unwraps the Constraint instance as an Isa constraint, and returns the instance vertex. Will panic if the Constraint is not an Isa constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as an Isa constraint, and returns the type vertex. Will panic if the Constraint is not an Isa constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Kind constraint, and returns the Kind of the type-vertex. Will panic if the Constraint is not a Kind constraint.

enum Kind

Unwraps the Constraint instance as a Kind constraint, and returns the associated type vertex. Will panic if the Constraint is not a Kind constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Label constraint, and returns the label string. Will panic if the Constraint is not a Label constraint.

char*

Unwraps the Constraint instance as a Label constraint, and returns the type-vertex the label applies to. Will panic if the Constraint is not a Label constraint.

struct ConstraintVertex*

(FUTURE-USE: Currently always ConstraintExactness::Subtypes) Unwraps the Constraint instance as a Links constraint, and returns the exactness of the role-type match. Will panic if the Constraint is not a Links constraint.

enum ConstraintExactness

Unwraps the Constraint instance as a Links constraint, and returns the player vertex. Will panic if the Constraint is not a Links constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Links constraint, and returns the relation vertex. Will panic if the Constraint is not a Links constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Links constraint, and returns the role vertex. Will panic if the Constraint is not a Links constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Not constraint, and returns the ConjunctionID of the negated conjunction. Will panic if the Constraint is not a Not constraint.

struct ConjunctionID*

Unwraps the Constraint instance as an Or constraint, and returns the ConjunctionIDs of the conjunction in each of the branches. Will panic if the Constraint is not an Or constraint.

struct ConjunctionIDIterator*

Unwraps the Constraint instance as an Owns constraint, and returns the attribute-type vertex. Will panic if the Constraint is not an Owns constraint.

struct ConstraintVertex*

(FUTURE-USE: Currently always ConstraintExactness::Subtypes) Will panic if the Constraint is not an Owns constraint.

enum ConstraintExactness

Unwraps the Constraint instance as an Owns constraint, and returns the owner-type vertex. Will panic if the Constraint is not an Owns constraint.

struct ConstraintVertex*

(FUTURE-USE: Currently always ConstraintExactness::Subtypes)

enum ConstraintExactness

Unwraps the Constraint instance as a Plays constraint, and returns the player type vertex. Will panic if the Constraint is not a Plays constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Plays constraint, and returns the role-type vertex. Will panic if the Constraint is not a Plays constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Relates constraint, and returns the exactness of the relation match. Will panic if the Constraint is not a Relates constraint.

enum ConstraintExactness

Unwraps the Constraint instance as a Relates constraint, and returns the relation-type vertex. Will panic if the Constraint is not a Relates constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Relates constraint, and returns the role-type vertex. Will panic if the Constraint is not a Relates constraint.

struct ConstraintVertex*

Returns a string representation of the constraint

char*

Unwraps the Constraint instance as a Sub constraint, and returns the exactness of the subtype match. If Exact (i.e. sub!), only the immediate subtype is returned else, (i.e. sub) the type itself and all subtypes are returned. Will panic if the Constraint is not a Sub constraint.

enum ConstraintExactness

Unwraps the Constraint instance as a Sub constraint, and returns the subtype vertex. Will panic if the Constraint is not a Sub constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Sub constraint, and returns the supertype vertex. Will panic if the Constraint is not a Sub constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Try constraint, and returns the ConjunctionID of the optionally matched conjunction. Will panic if the Constraint is not a Try constraint.

struct ConjunctionID*

Unwraps the Constraint instance as a Value constraint, and returns the attribute type vertex. Will panic if the Constraint is not a Value constraint.

struct ConstraintVertex*

Unwraps the Constraint instance as a Value constraint, and returns the specified ValueType as a string. Will panic if the Constraint is not a Value constraint.

char*

The variant of the specified constraint

enum ConstraintVariant

class

Tells apart exact variants of constraints from the ones allowing subtype-polymorphism. e.g. isa! would be represented as an Constraint::Isa with its exactness field ConstraintExactness::Exact.

class

Tells apart exact variants of constraints from the ones allowing subtype-polymorphism. e.g. isa! would be represented as an Constraint::Isa with its exactness field ConstraintExactness::Exact.

Indicates the constraint matches exactly the specified type - e.g. isa! or sub!

Indicates the constraint matches the specified type and its subtypes - e.g. isa! or sub!

The offset of the first character of the specified constraint in the source query .

int64_t

The offset after the last character of the specified constraint in the source query .

int64_t

Frees the native rust Constraint object.

void

Frees the native rust ConstraintWithSpanIterator object.

void

Forwards the ConstraintWithSpanIterator and returns the next ConstraintWithSpan if it exists, or null if there are no more elements.

struct ConstraintWithSpan*

class

The answer to a TypeDB query is a set of concepts which satisfy the Constraints in the query. A ConstraintVertex is either a variable, or some identifier of the concept.

Unwraps the ConstraintVertex instance as a Label. Will panic if the instance is not a Label variant.

struct Concept*

Unwraps the ConstraintVertex instance as a NamedRole. 'links' & 'relates' constraints accept unscoped role names. Since an unscoped role-name does not uniquely identify a role-type, (Different role-types belonging to different relation types may share the same name) an internal variable is introduced to handle the ambiguity Will panic if the instance is not a NamedRole variant.

struct NamedRole*

Unwraps the ConstraintVertex instance as a Value. Will panic if the instance is not a Value variant.

struct Concept*

Unwraps the ConstraintVertex instance as a Variable. Will panic if the instance is not a Variable variant.

struct Variable*

Frees the native rust ConstraintVertex object.

void

Returns the variant of the constraint

enum ConstraintVertexVariant

Frees the native rust ConstraintVertexIterator object.

void

Forwards the ConstraintVertexIterator and returns the next ConstraintVertex if it exists, or null if there are no more elements.

struct ConstraintVertex*

class

Uniquely identifies a variable in a Pipelinepipeline. Its name (if any) can be retrieved from the variable_names field in Pipeline

Frees the native rust Variable object.

void

Returns the name of the specified variable if it has one, and null otherwise. The Pipeline must be the one that contains the variable.

char*

Returns the Variable id as u32 to use in hash, equality etc.

uint32_t

Returns a string representation of the variable. Does not resolve the name.

char*

Frees the native rust VariableAnnotations object.

void

Unwraps the VariableAnnotations instance as annotations for an Instance variable, and returns the possible types of the instances the variable may hold. Will panic if the variable is not an Instance variable.

struct ConceptIterator*

Unwraps the VariableAnnotations instance as annotations for a Type variable, and returns the possible types the variable may be. Will panic if the variable is not a Type variable.

struct ConceptIterator*

Unwraps the VariableAnnotations instance as annotations for a Value variable, and returns the possible ValueTypes the value may be. Will panic if the variable is not a Value variable.

struct StringIterator*

Returns the variant of the specified VariableAnnotations. This tells us whether the variable holds an instance, a type or a raw value.

enum VariableAnnotationsVariant

Frees the native rust VariableAnnotationsIterator object.

void

Forwards the VariableAnnotationsIterator and returns the next VariableAnnotations if it exists, or null if there are no more elements.

struct VariableAnnotations*

Frees the native rust VariableIterator object.

void

Forwards the VariableIterator and returns the next Variable if it exists, or null if there are no more elements.

struct Variable*

class

A representation of the 'fetch' stage of a query

Frees the native rust Fetch object.

void

Unwraps the Fetch instance as a Leaf variant, and returns an iterator over possible value types. Will panic if the instance is not a Leaf variant.

struct StringIterator*

Unwraps the Fetch instance as a List variant, and returns the Fetch for an element of the list. Will panic if the instance is not a List variant.

struct Fetch*

Unwraps the Fetch instance as an Object variant, and returns the available fields. Will panic if the instance is not an Object variant.

struct StringIterator*

Unwraps the Fetch instance as an Object variant, and returns the value of the specified field. Will panic if the instance is not an Object variant.

struct Fetch*

Returns the variant of the Fetch instance.

enum FetchVariant

class

Holds a representation of the function, and the result of type-inference for each variable.

Returns the inferred type for each argument of the function.

struct VariableAnnotationsIterator*

Returns the Variables which are the arguments of the function.

struct VariableIterator*

A representation of the Pipeline which forms the body of the function.

struct Pipeline*

Frees the native rust Function object.

void

Returns the inferred type for each concept returned by the function.

struct VariableAnnotationsIterator*

A representation of the ReturnOperation of the function.

struct ReturnOperation*

Frees the native rust FunctionIterator object.

void

Forwards the FunctionIterator and returns the next Function if it exists, or null if there are no more elements.

struct Function*

class

A representation of the return operation of the function

Frees the native rust ReturnOperation object.

void

Unwraps the ReturnOperation instance as a Reduce variant, and returns the reducers applied. Will panic if the instance is not a Reduce variant.

struct ReducerIterator*

Unwraps the ReturnOperation instance as a Single variant, and returns the selector applied. Will panic if the instance is not a Single variant.

char*

Unwraps the ReturnOperation instance as a Single variant, and returns the returned variables. Will panic if the instance is not a Single variant.

struct VariableIterator*

Unwraps the ReturnOperation instance as a Stream variant, and returns the returned variables. Will panic if the instance is not a Stream variant.

struct VariableIterator*

Returns the variant of the ReturnOperation.

enum ReturnOperationVariant

class

Representation of a reducer used either in a PipelineStage::Reduce or in a function’s ReturnOperation.

Frees the native rust Reducer object.

void

The arguments to this Reducer. e.g. $x in sum($x)

struct VariableIterator*

The name of the operation applied by this Reducer. e.g. sum in sum($x)

char*

Frees the native rust ReducerIterator object.

void

Forwards the ReducerIterator and returns the next Reducer if it exists, or null if there are no more elements.

struct Reducer*

class

Representation of an assignment from a reduction in a PipelineStage::Reduce, such as reduce $c = sum($x);

Frees the native rust ReduceAssignment object.

void

The variable being assigned to in this ReduceAssignment. e.g. $c in $c = sum($x)

struct Variable*

The reducer applied in this ReduceAssignment. e.g. sum($x) in $c = sum($x)

struct Reducer*

Frees the native rust ReduceAssignmentIterator object.

void

Forwards the ReduceAssignmentIterator and returns the next ReduceAssignment if it exists, or null if there are no more elements.

struct ReduceAssignment*

class

The variable being sorted on and the ordering of the sort, as used in a PipelineStage::Sort, e.g. sort $v desc

Frees the native rust SortVariable object.

void

Returns the sort order for the variable being sorted on.

enum SortOrder

Returns the variable being sorted on.

struct Variable*

Frees the native rust SortVariableIterator object.

void

Forwards the SortVariableIterator and returns the next SortVariable if it exists, or null if there are no more elements.

struct SortVariable*

class

The order of a variable being sorted on in a PipelineStage::Sort

class

The order of a variable being sorted on in a PipelineStage::Sort

class

A NamedRole vertex is used in links & relates constraints, as multiple relations may have roles with the same name.

Returns a u32 identifying the named role instance. Meant to be used to implement hash, equality etc.

uint32_t

Frees the native rust NamedRole object.

void

Returns the role name associated with the NamedRole.

char*

Returns the role-type variable associated with the NamedRole.

struct Variable*

Returns a string representation of the NamedRole

char*

class

A representation of the comparator used in a comparison constraint.

class

A representation of the comparator used in a comparison constraint.

Unwraps the Comparator and returns its name (or symbol).

char*

class

Represents errors encountered during operation.

Checks if the error flag was set by the last operation. If true, the error can be retrieved using get_last_error(void)

bool

Returns the error code of the Error object

char*

Frees the native rust Error object

void

Returns the error message of the Error object

char*

Returns the error which set the error flag.

struct Error*