C driver API reference

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

Closes the driver. Before instantiating a new driver, the driver that’s currently open should first be closed. Closing a connction 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 Driver to TypeDB Cloud server(s) available at the provided addresses, using the provided credential.

struct Connection*

Open a TypeDB Driver to TypeDB Cloud server(s), using provided address translation, with the provided credential.

struct Connection*

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

struct Connection*

Enables logging in the TypeDB driver.

void

User credentials and TLS encryption settings for connecting to TypeDB Cloud.

Frees the native rust Credential object

void

Creates a new Credential for connecting to TypeDB Cloud.

struct Credential*

A TypeDB database

An Iterator over databases present on the TypeDB server

Provides access to all database management methods.

Frees the native rust Database object

void

Deletes this database.

void

The database name as a string.

char*

Returns the preferred replica for this database. Operations which can be run on any replica will prefer to use this replica. Only works in TypeDB Cloud

struct ReplicaInfo*

Returns the primary replica for this database. Only works in TypeDB Cloud

struct ReplicaInfo*

Set of Replica instances for this database. Only works in TypeDB Cloud

struct ReplicaInfoIterator*

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.

struct Database*

Frees the native rust DatabaseManager object

void

Creates and returns a native DatabaseManager for the connection

struct DatabaseManager*

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

char*

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

char*

The types in the schema 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.

struct Database*

The metadata and state of an individual raft replica of a database.

Iterator over the ReplicaInfo corresponding to each replica of a TypeDB cloud database.

Frees the native rust ReplicaInfo object

void

The server hosting this replica

char*

The raft protocol ‘term’ of this replica.

int64_t

Checks whether this is the preferred replica of the raft cluster. If true, Operations which can be run on any replica will prefer to use this replica.

bool

Checks whether this is the primary replica of the raft cluster.

bool

Frees the native rust ReplicaInfoIterator object

void

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

struct ReplicaInfo*

User information

Iterator over a set of Users

Provides access to all user management methods.

Frees the native rust User object.

void

Returns the number of seconds remaining till this user’s current password expires.

int64_t

Returns the name of this user.

char*

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*

Frees the native rust UserManager object

void

Creates a UserManager on the specified connection

struct UserManager*

Updates the password for the current authenticated user.

void

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 the user who opened this connection

struct User*

Deletes the user with the given username.

void

Retrieves a user with the given name.

struct User*

Sets a new password for a user. This operation can only be performed by administrators.

void

A session with a TypeDB database.

This enum is used to specify the type of the session.

This enum is used to specify the type of the session.

Closes the session. Before opening a new session, the session currently open should first be closed. The native rust object is freed on close.

void

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

void

Returns the name of the database of the session.

char*

Checks whether this session is open.

bool

Opens a session to the given database.

struct Session*

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

void

Registers a callback function which will be executed when this session is reopened. A session may be closed if it times out, or loses the connection to the database. In such situations, the session is reopened automatically when opening a new transaction.

void

TypeDB session and transaction options. TypeDBOptions object can be used to override the default server behaviour. Options are specified using properties assignment.

Frees the native rust Options object.

void

Returns the value set for the explanation in this TypeDBOptions object. If set to true, explanations for queries are enabled.

bool

Returns the value set for the inference in this TypeDBOptions object.

bool

Returns the value set for the parallel execution in this TypeDBOptions object. If set to true, the server uses parallel instead of single-threaded execution.

bool

Returns the value set for the prefetching in this TypeDBOptions object. If set to true, the first batch of answers is streamed to the driver even without an explicit request for it.

bool

Returns the value set for the prefetch size in this TypeDBOptions object. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request.

int32_t

Returns the value set for reading data from any replica in this TypeDBOptions object. If set to True, enables reading data from any replica, potentially boosting read throughput.

bool

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

int64_t

Returns the value set for the session idle timeout in this TypeDBOptions object. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive.

int64_t

Returns the value set for reasoning tracing in this TypeDBOptions object. If set to true, reasoning tracing graphs are output in the logging directory.

bool

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

int64_t

Checks whether the option for explanation was explicitly set for this TypeDBOptions object.

bool

Checks whether the option for inference was explicitly set for this TypeDBOptions object.

bool

Checks whether the option for parallel execution was explicitly set for this TypeDBOptions object.

bool

Checks whether the option for prefetching was explicitly set for this TypeDBOptions object.

bool

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

bool

Checks whether the option for reading data from any replica was explicitly set for this TypeDBOptions object.

bool

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

bool

Checks whether the option for the session idle timeout was explicitly set for this TypeDBOptions object.

bool

Checks whether the option for reasoning tracing was explicitly set for this TypeDBOptions object.

bool

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

bool

Produces a new TypeDBOptions object.

struct Options*

Explicitly enables or disables explanations. If set to true, enables explanations for queries. Only affects read transactions.

void

Explicitly enables or disables inference. Only settable at transaction level and above. Only affects read transactions.

void

Explicitly enables or disables parallel execution. If set to true, the server uses parallel instead of single-threaded execution.

void

Explicitly enables or disables prefetching. If set to true, the first batch of answers is streamed to the driver even without an explicit request for it.

void

Explicitly sets a prefetch size. If set, specifies a guideline number of answers that the server should send before the driver issues a fresh request.

void

Explicitly enables or disables reading data from any replica. If set to True, enables reading data from any replica, potentially boosting read throughput. Only settable in TypeDB Cloud.

void

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

void

Explicitly sets a session idle timeout. If set, specifies a timeout that allows the server to close sessions if the driver terminates or becomes unresponsive.

void

Explicitly enables or disables reasoning tracing. If set to true, reasoning tracing graphs are output in the logging directory. Should be used with parallel = False.

void

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

void

A transaction with a TypeDB database.

This enum is used to specify the type of transaction.

This enum is used to specify the type of transaction.

Closes the transaction and frees the native rust object.

void

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*

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

void

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.

void

Rolls back the uncommitted changes made via this transaction.

struct VoidPromise*

Performs a TypeQL Define query in the transaction.

struct VoidPromise*

Performs a TypeQL Delete query in the transaction.

struct VoidPromise*

Performs a TypeQL Explain query in the transaction.

struct ExplanationIterator*

Performs a TypeQL Fetch query in the transaction.

struct StringIterator*

Performs a TypeQL Get (Get) query in the transaction.

struct ConceptMapIterator*

Performs a TypeQL Get Aggregate query in the transaction.

struct ConceptPromise*

Performs a TypeQL Get Group query in the transaction.

struct ConceptMapGroupIterator*

Performs a TypeQL Get Group Aggregate query in the transaction.

struct ValueGroupIterator*

Performs a TypeQL Insert query in the transaction.

struct ConceptMapIterator*

Performs a TypeQL Undefine query in the transaction.

struct VoidPromise*

Performs a TypeQL Update query in the transaction.

struct ConceptMapIterator*

Contains a mapping of variables to concepts.

Contains an element of the TypeQL Get Group query result.

Iterator over the ConceptMapGroups in the result of the TypeQL Get Group query.

Iterator over the ConceptMaps in the result of a TypeQL Get query.

Frees the native rust ConceptMap object

void

Checks whether the provided ConceptMap objects are equal

bool

Retrieves a concept for a given variable name.

struct Concept*

Gets the Explainables object for this ConceptMap, exposing which of the concepts in this ConceptMap are explainable.

struct Explainables*

Produces an Iterator over all Concepts in this ConceptMap.

struct ConceptIterator*

Produces an Iterator over all variables in this ConceptMap.

struct StringIterator*

Frees the native rust ConceptMapGroup object

void

Checks whether the provided ConceptMapGroup objects are equal

bool

Retrieves the ConceptMaps of the group.

struct ConceptMapIterator*

Retrieves the concept that is the group owner.

struct Concept*

Frees the native rust ConceptMapGroupIterator object

void

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

struct ConceptMapGroup*

A string representation of this ConceptMapGroup object

char*

Frees the native rust ConceptMapIterator object

void

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

struct ConceptMap*

A string representation of this ConceptMap.

char*

Contains an element of a TypeQL Get Group Aggregate query result.

Iterator over the ValueGroups in the result of the Get Group Aggregate query.

Frees the native rust ValueGroup object

void

Checks whether the provided ValueGroup objects are equal

bool

Retrieves the concept that is the group owner.

struct Concept*

Retrieves the Value answer of the group.

struct Concept*

Frees the native rust ValueGroupIterator object

void

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

struct ValueGroup*

A string representation of this ValueGroup object

char*

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

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

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

Iterator over the StringPairs representing explainable owner-attribute variable pairs

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

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.

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

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

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*

Frees the native rust StringPair object

void

Frees the native rust StringPairIterator object

void

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

struct StringPair*

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*

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

Contains an explainable object.

Contains explainable objects.

An explanation of which rule was used for inferring the explained concept, the condition of the rule, the conclusion of the rule, and the mapping of variables between the query and the rule’s conclusion.

Iterator over the Explanations in the result of the explain query.

Frees the native rust Explainable object

void

Retrieves the subquery of the original query that is actually being explained.

char*

Retrieves the unique ID that identifies this Explainable.

int64_t

Frees the native rust Explainables object

void

Checks whether the provided Explainables objects are equal

bool

Retrieves the explainable attribute with the given variable name.

struct Explainable*

Retrieves all variables corresponding to this ConceptMap’s explainable attributes.

struct StringIterator*

Retrieves the explainable attribute ownership with the pair of (owner, attribute) variable names.

struct Explainable*

Retrieves all variables corresponding to this ConceptMap’s explainable ownerships.

struct StringPairIterator*

Retrieves the explainable relation with the given variable name.

struct Explainable*

Retrieves all variables corresponding to this ConceptMap’s explainable relations.

struct StringIterator*

A string representation of this Explainables object

char*

Frees the native rust Explanation object

void

Checks whether the provided Explanation objects are equal

bool

Retrieves the Conclusion for this Explanation.

struct ConceptMap*

Retrieves the Condition for this Explanation.

struct ConceptMap*

Retrieves the query variables for this Explanation.

struct StringIterator*

Retrieves the rule variables corresponding to the query variable var for this Explanation.

struct StringIterator*

Retrieves the Rule for this Explanation.

struct Rule*

Frees the native rust ExplanationIterator object

void

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

struct Explanation*

A string representation of this Explanation object

char*

The fundamental TypeQL object. A Concept is either a Type, Thing, or Value. To use subtype specific methods, the Concept must be of the expected subtype.

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

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 Concept object

void

Checks whether the provided Concept objects are equal

bool

Checks if the concept is an Attribute.

bool

Checks if the concept is an AttributeType.

bool

Checks if the concept is an Entity.

bool

Checks if the concept is an EntityType.

bool

Checks if the concept is a Relation.

bool

Checks if the concept is a RelationType.

bool

Checks if the concept is a RoleType.

bool

Checks if the concept is the root thing type.

bool

Checks if the concept is a Value.

bool

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*

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*

A string representation of this Concept object

char*

Retrieves an Attribute instance by its iid.

struct ConceptPromise*

Retrieves an AttributeType by its label.

struct ConceptPromise*

Retrieves an Entity instance by its iid.

struct ConceptPromise*

Retrieves an EntityType by its label.

struct ConceptPromise*

Retrieves a relation instance by its iid.

struct ConceptPromise*

Retrieves a RelationType by its label.

struct ConceptPromise*

Retrieves the root AttributeType, “attribute”.

struct Concept*

Retrieves the root EntityType, “entity”.

struct Concept*

Retrieves the root RelationType, “relation”.

struct Concept*

Retrieves a list of all schema exceptions for the current transaction.

struct SchemaExceptionIterator*

Creates a new AttributeType if none exists with the given label, otherwise retrieves the existing one.

struct ConceptPromise*

Creates a new EntityType if none exists with the given label, otherwise retrieves the existing one.

struct ConceptPromise*

Creates a new RelationType if none exists with the given label, otherwise retrieves the existing one.

struct ConceptPromise*

Deletes this Thing.

struct VoidPromise*

Retrieves the Attributes that this Thing owns, optionally filtered by AttributeTypes.

struct ConceptIterator*

Retrieves the unique id of the Thing.

char*

Checks if this Thing is inferred by a [Reasoning Rule].

bool

Retrieves the roles that this Thing is currently playing.

struct ConceptIterator*

Retrieves all the Relations which this Thing plays a role in, optionally filtered by one or more given roles.

struct ConceptIterator*

Checks if this Thing is deleted.

struct BoolPromise*

Assigns an Attribute to be owned by this Thing.

struct VoidPromise*

Deletes this thing type from the database.

struct VoidPromise*

Retrieves the unique label of the thing type.

char*

Retrieves AttributeType that the instances of this ThingType are allowed to own directly or via inheritance. Specify Explicit to only include directly owned types, or Transitive to include inherited

struct ConceptIterator*

Retrieves the AttributeType, ownership of which is overridden for this ThingType by the specified AttributeType.

struct ConceptPromise*

Retrieves all direct and inherited (or direct only) roles that are allowed to be played by the instances of this ThingType. Specify Transitive for direct and inherited roles, Or Explicit for directly played roles only.

struct ConceptIterator*

Retrieves the RoleType that is overridden by the given RoleType for this ThingType.

struct ConceptPromise*

Produces a TypeQL pattern for creating this ThingType in a define query.

struct StringPromise*

Checks if this thing type is prevented from having data instances (i.e., abstract).

bool

Checks if the thing type has been deleted

struct BoolPromise*

Checks if this type is a root type (""entity"", ""relation"", ""attribute"")

bool

Set a ThingType to be abstract, meaning it cannot have instances.

struct VoidPromise*

Renames the label of the type. The new label must remain unique.

struct VoidPromise*

Allows the instances of this ThingType to own the given AttributeType. Optionally, overriding a previously declared ownership. With the specified annotations to the ownership.

struct VoidPromise*

Allows the instances of this ThingType to play the given role. Optionally, overriding the existing ability to play a role.

struct VoidPromise*

Set a ThingType to be non-abstract, meaning it can have instances.

struct VoidPromise*

Disallows the instances of this ThingType from owning the given AttributeType.

struct VoidPromise*

Disallows the instances of this ThingType from playing the given role.

struct VoidPromise*

Unassigns an Attribute from this Thing.

struct VoidPromise*

Retrieves the type which this Entity belongs to.

struct Concept*

Retrieves the instances that own this Attribute.

struct ConceptIterator*

Retrieves the type which this Attribute belongs to.

struct Concept*

Retrieves the type which this Relation belongs to.

struct Concept*

Adds a new role player to play the given role in this Relation.

struct VoidPromise*

Retrieves all role players of this Relation, optionally filtered by given role types.

struct ConceptIterator*

Retrieves all role types currently played in this Relation.

struct ConceptIterator*

Retrieves all instance involved in the Relation, each paired with the role it plays.

struct RolePlayerIterator*

Retrieves the type which this Relation belongs to.

struct Concept*

Removes the association of the given instance that plays the given role in this Relation.

struct VoidPromise*

A pair representing the concept and the role it plays in a relation. The result of relation_get_role_players(Transaction*, Concept*)

An iterator over RolePlayer pairs returned by relation_get_role_players(Transaction*, Concept*)

Frees the native rust RolePlayer object

void

Returns the Concept which plays the role in the RolePlayer

struct Concept*

Returns the role-type played by the RolePlayer

struct Concept*

Frees the native rust RolePlayerIterator object

void

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

struct RolePlayer*

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

bool

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

int64_t

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

double

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

int64_t

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

char*

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

bool

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

bool

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

bool

Returns true if the value which this Value concept holds is of type long. Otherwise, returns false.

bool

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

bool

Creates a new Value object of the specified boolean value.

struct Concept*

Creates a new Value object of the specified datetime value.

struct Concept*

Creates a new Value object of the specified double value.

struct Concept*

Creates a new Value object of the specified long value.

struct Concept*

Creates a new Value object of the specified string value.

struct Concept*

Creates and returns a new instance of this EntityType.

struct ConceptPromise*

Retrieves all Entity objects that are instances of this EntityType or its subtypes. Specify Transitive for instances of this EntityType and subtypes, Or Explicit of this EntityType only

struct ConceptIterator*

Retrieves all direct and indirect (or direct only) subtypes of the given EntityType. Specify Transitive for direct and indirect subtypes, Or Explicit for directly subtypes only.

struct ConceptIterator*

Retrieves the most immediate supertype of the given EntityType.

struct ConceptPromise*

Retrieves all supertypes of the given EntityType.

struct ConceptIterator*

Sets the supplied EntityType as the supertype of the current EntityType.

struct VoidPromise*

Retrieves an Attribute of this AttributeType with the given Value if such Attribute exists. Otherwise, returns null.

struct ConceptPromise*

Retrieves all Attribute objects that are instances of this AttributeType or its subtypes. Specify Transitive for instances of this AttributeType and subtypes, Or Explicit of this AttributeType only

struct ConceptIterator*

Retrieve all Things that own an attribute of this AttributeType directly or through inheritance. Specify Transitive for direct and inherited ownership, or Explicit for direct ownership only

struct ConceptIterator*

Retrieves the regular expression that is defined for this AttributeType.

struct StringPromise*

Retrieves all direct and indirect (or direct only) subtypes of the given AttributeType. Specify Transitive for direct and indirect subtypes, Or Explicit for directly subtypes only.

struct ConceptIterator*

Retrieves subtypes of this AttributeType with given ValueType. Specify Transitive for direct and indirect subtypes, Or Explicit for directly subtypes only.

struct ConceptIterator*

Retrieves the most immediate supertype of the given AttributeType.

struct ConceptPromise*

Retrieves all supertypes of the given AttributeType.

struct ConceptIterator*

Retrieves the ValueType of this AttributeType.

enum ValueType

Creates and returns a new instance of this AttributeType, with the specified Value.

struct ConceptPromise*

Sets a regular expression as a constraint for this AttributeType. Values of all Attributes of this type (inserted earlier or later) should match this regex.

Can only be applied for AttributeTypes with a string value type.

struct VoidPromise*

Sets the supplied AttributeType as the supertype of the current AttributeType.

struct VoidPromise*

Removes the regular expression that is defined for this AttributeType.

struct VoidPromise*

Creates and returns a new instance of this RelationType.

struct ConceptPromise*

Retrieves all Relation objects that are instances of this RelationType or its subtypes. Specify Transitive for instances of this RelationType and subtypes, Or Explicit of this RelationType only

struct ConceptIterator*

Retrieves roles that this RelationType relates to directly or via inheritance. Specify Transitive for direct and inherited relates Or Explicit for direct relates only

struct ConceptIterator*

Retrieves the role with the specified label that this RelationType relates to, directly or via inheritance.

struct ConceptPromise*

Retrieves the RoleType that is overridden by the role with the role_label.

struct ConceptPromise*

Retrieves all direct and indirect (or direct only) subtypes of the given RelationType. Specify Transitive for direct and indirect subtypes, Or Explicit for directly subtypes only.

struct ConceptIterator*

Retrieves the most immediate supertype of the given RelationType.

struct ConceptPromise*

Retrieves all supertypes of the given RelationType.

struct ConceptIterator*

Sets the new role that this RelationType relates to. If we are setting an overriding type this way, we have to also pass overridden_role_label.

struct VoidPromise*

Sets the supplied RelationType as the supertype of the current RelationType.

struct VoidPromise*

Disallows this RelationType from relating to the given role.

struct VoidPromise*

Deletes this role type from the database.

struct VoidPromise*

Gets the name of this role type.

char*

Retrieves the Thing instances that play this role. Specify Transitive for direct and indirect playing, or Explicit for direct playing only

struct ConceptIterator*

Retrieves the ThingTypes whose instances play this role. Specify Transitive for direct and indirect playing, or Explicit for direct playing only

struct ConceptIterator*

Retrieves the Relation instances that this role is related to. Specify Transitive for direct and indirect relation, or Explicit for direct relation only

struct ConceptIterator*

Retrieves the RelationType that this role is directly related to.

struct ConceptPromise*

Retrieves RelationTypes that this role is related to (directly or indirectly).

struct ConceptIterator*

Gets the 'scope' of this role type. This corresponds to the label of the RelationType it is directly related to.

char*

Retrieves all direct and indirect (or direct only) subtypes of the given RoleType. Specify Transitive for direct and indirect subtypes, Or Explicit for directly subtypes only.

struct ConceptIterator*

Retrieves the most immediate supertype of the given RoleType.

struct ConceptPromise*

Retrieves all supertypes of the given RoleType.

struct ConceptIterator*

Checks if the role type is prevented from having data instances (i.e., abstract).

bool

Check if the role type has been deleted

struct BoolPromise*

Checks if the role type is the root role type, ""relation:role""

bool

Renames the label of the type. The new label must remain unique in the hierarchy of a relation type.

struct VoidPromise*

Annotations are used to specify extra schema constraints.

Frees the native rust Annotation object

void

Checks whether the provided Annotation objects are equal

bool

Checks whether the provided Annotation is @key

bool

Checks whether the provided Annotation is @unique

bool

Produces a @key annotation.

struct Annotation*

Produces a @unique annotation.

struct Annotation*

A string representation of this Annotation object

char*

Used for specifying whether we need explicit or transitive subtyping, instances, etc.

Used for specifying whether we need explicit or transitive subtyping, instances, etc.

Represents the type of primitive value is held by a Value or Attribute.

Represents the type of primitive value is held by a Value or Attribute.

Retrieves the Rule that has the given label.

struct RulePromise*

Returns a RuleIterator over all rules in the database for the transaction.

struct RuleIterator*

Creates a new Rule if none exists with the given label, or replaces the existing one.

struct RulePromise*

Rules are a part of schema and define embedded logic. The reasoning engine uses rules as a set of logic to infer new data. A rule consists of a condition and a conclusion, and is uniquely identified by a label.

An iterator over Rules in the database

Promise object representing the result of an asynchronous operation. Use rule_promise_resolve(RulePromise*) to wait for and retrieve the resulting Rule.

Deletes this rule.

struct VoidPromise*

Frees the native rust ReplicaInfoIterator object.

void

Retrieves the unique label of the rule.

char*

The single statement that constitutes the ‘then’ of the rule.

char*

The statements that constitute the ‘when’ of the rule.

char*

Check if this rule has been deleted.

struct BoolPromise*

Frees the native rust RuleIterator object.

void

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

struct Rule*

Waits for and returns the result of the operation represented by the RulePromise 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 Rule*

Renames the label of the rule. The new label must remain unique.

struct VoidPromise*

A string representation of this Rule object

char*

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*

Represents invalid schema constructs discovered during schema validation.

Iterator over the SchemaExceptions in the result of concepts_get_schema_exceptions(Transaction*).

Returns the error code of the SchemaException object

char*

Frees the native rust SchemaException object

void

Frees the native rust SchemaExceptionIterator object

void

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

struct SchemaException*

Returns the error message of the SchemaException object

char*