typedb · izmalk · Apr 26, 2024 · Apr 29, 2024
@@ -1,4 +1,4 @@
-[#_methods__answer__conceptmap]
+[#_methods_answer_conceptmap]
 === conceptmap
 
 [#_Struct_ConceptMap]

@@ -1,4 +1,4 @@
-[#_explanation]
+[#_methods_answer_explanation]
 === explanation
 
 [#_Struct_Explainable]
@@ -15,6 +15,20 @@ Contains an explainable object.
 
 Contains explainable objects.
 
+[#_Struct_Explanation]
+==== Struct Explanation
+
+
+
+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.
+
+[#_Struct_ExplanationIterator]
+==== Struct ExplanationIterator
+
+
+
+Iterator over the ``Explanation``s in the result of the explain query.
+
 [#_explainable_drop]
 ==== explainable_drop
 
@@ -207,20 +221,6 @@ A string representation of this ``Explainables`` object
 .Returns
 `char*`
 
-[#_Struct_Explanation]
-==== Struct Explanation
-
-
-
-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.
-
-[#_Struct_ExplanationIterator]
-==== Struct ExplanationIterator
-
-
-
-Iterator over the ``Explanation``s in the result of the explain query.
-
 [#_explanation_drop]
 ==== explanation_drop
 

@@ -1,6 +1,13 @@
-[#_primitives]
+[#_methods_answer_primitives]
 === primitives
 
+[#_Struct_BoolPromise]
+==== Struct BoolPromise
+
+
+
+Promise object representing the result of an asynchronous operation. Use bool_promise_resolve(BoolPromise*) to wait for and retrieve the resulting boolean value.
+
 [#_Struct_StringIterator]
 ==== Struct StringIterator
 
@@ -29,6 +36,29 @@ Iterator over the ``StringPair``s representing explainable owner-attribute varia
 
 Promise object representing the result of an asynchronous operation. Use string_promise_resolve(StringPromise*) to wait for and retrieve the resulting string.
 
+[#_Struct_VoidPromise]
+==== Struct VoidPromise
+
+
+
+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.
+
+[#_bool_promise_resolve]
+==== bool_promise_resolve
+
+[source,cpp]
+----
+bool bool_promise_resolve(struct BoolPromise* promise)
+----
+
+
+
+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.
+
+[caption=""]
+.Returns
+`bool`
+
 [#_string_free]
 ==== string_free
 
@@ -141,37 +171,6 @@ Waits for and returns the result of the operation represented by the ``BoolPromi
 .Returns
 `char*`
 
-
-[#_Struct_BoolPromise]
-==== Struct BoolPromise
-
-
-
-Promise object representing the result of an asynchronous operation. Use bool_promise_resolve(BoolPromise*) to wait for and retrieve the resulting boolean value.
-
-[#_bool_promise_resolve]
-==== bool_promise_resolve
-
-[source,cpp]
-----
-bool bool_promise_resolve(struct BoolPromise* promise)
-----
-
-
-
-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.
-
-[caption=""]
-.Returns
-`bool`
-
-[#_Struct_VoidPromise]
-==== Struct VoidPromise
-
-
-
-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.
-
 [#_void_promise_resolve]
 ==== void_promise_resolve
 

@@ -1,4 +1,4 @@
-[#_methods__answer__valuegroup]
+[#_methods_answer_valuegroup]
 === valuegroup
 
 [#_Struct_ValueGroup]

@@ -1,4 +1,4 @@
-[#_methods__concept__attribute]
+[#_methods_concept_attribute]
 === attribute
 
 [#_attribute_get_owners]

@@ -1,4 +1,4 @@
-[#_methods__concept__concept]
+[#_methods_concept_concept]
 === concept
 
 [#_Struct_Concept]

@@ -1,4 +1,4 @@
-[#_methods__concept__entity]
+[#_methods_concept_entity]
 === entity
 
 [#_entity_get_type]

@@ -1,4 +1,4 @@
-[#_methods__concept__relation]
+[#_methods_concept_relation]
 === relation
 
 [#_relation_add_role_player]

@@ -1,4 +1,4 @@
-[#_methods__concept__roleplayer]
+[#_methods_concept_roleplayer]
 === roleplayer
 
 [#_Struct_RolePlayer]

@@ -1,4 +1,4 @@
-[#_methods__concept__thing]
+[#_methods_concept_thing]
 === thing
 
 [#_thing_delete]

@@ -1,4 +1,4 @@
-[#_methods__concept__value]
+[#_methods_concept_value]
 === value
 
 [#_value_get_boolean]

@@ -1,22 +1,6 @@
-[#_methods__connection__connection]
+[#_methods_connection_connection]
 === connection
 
-[#_init_logging]
-==== init_logging
-
-[source,cpp]
-----
-void init_logging(void)
-----
-
-
-
-Enables logging in the TypeDB driver.
-
-[caption=""]
-.Returns
-`void`
-
 [#_Struct_Connection]
 ==== Struct Connection
 
@@ -99,6 +83,34 @@ a| `credential` a| The ``Credential`` to connect with a| `const struct Credentia
 .Returns
 `struct Connection*`
 
+[#_connection_open_cloud_translated]
+==== connection_open_cloud_translated
+
+[source,cpp]
+----
+struct Connection* connection_open_cloud_translated(const char*const* advertised_addresses, const char*const* translated_addresses, const struct Credential* credential)
+----
+
+
+
+Open a TypeDB Driver to TypeDB Cloud server(s), using provided address translation, with the provided credential.
+
+
+[caption=""]
+.Input parameters
+[cols=",,"]
+[options="header"]
+|===
+|Name |Description |Type
+a| `advertised_addresses` a| A null-terminated array holding the address(es) the TypeDB server(s) are configured to advertise a| `const char*const*`
+a| `translated_addresses` a| A null-terminated array holding the address(es) of the TypeDB server(s) the driver will connect to. This array _must_ have the same length as ``advertised_addresses`` a| `const char*const*`
+a| `credential` a| The ``Credential`` to connect with a| `const struct Credential*`
+|===
+
+[caption=""]
+.Returns
+`struct Connection*`
+
 [#_connection_open_core]
 ==== connection_open_core
 
@@ -125,3 +137,19 @@ a| `address` a| The address of the TypeDB server a| `const char*`
 .Returns
 `struct Connection*`
 
+[#_init_logging]
+==== init_logging
+
+[source,cpp]
+----
+void init_logging(void)
+----
+
+
+
+Enables logging in the TypeDB driver.
+
+[caption=""]
+.Returns
+`void`
+
@@ -1,4 +1,4 @@
-[#_methods__connection__credential]
+[#_methods_connection_credential]
 === credential
 
 [#_Struct_Credential]

@@ -1,4 +1,4 @@
-[#_methods__connection__database]
+[#_methods_connection_database]
 === database
 
 [#_Struct_Database]

@@ -1,4 +1,4 @@
-[#_methods__connection__replica]
+[#_methods_connection_replica]
 === replica
 
 [#_Struct_ReplicaInfo]
@@ -31,17 +31,17 @@ Frees the native rust ``ReplicaInfo`` object
 .Returns
 `void`
 
-[#_replica_info_get_address]
-==== replica_info_get_address
+[#_replica_info_get_server]
+==== replica_info_get_server
 
 [source,cpp]
 ----
-char* replica_info_get_address(const struct ReplicaInfo* replica_info)
+char* replica_info_get_server(const struct ReplicaInfo* replica_info)
 ----
 
 
 
-Retrieves the address of the server hosting this replica
+The server hosting this replica
 
 [caption=""]
 .Returns

@@ -1,4 +1,4 @@
-[#_methods__connection__user]
+[#_methods_connection_user]
 === user
 
 [#_Struct_User]

@@ -1,4 +1,4 @@
-[#_methods__errors__error]
+[#_methods_errors_error]
 === error
 
 [#_Struct_Error]
@@ -8,6 +8,22 @@
 
 Represents errors encountered during operation.
 
+[#_check_error]
+==== check_error
+
+[source,cpp]
+----
+bool check_error(void)
+----
+
+
+
+Checks if the error flag was set by the last operation. If true, the error can be retrieved using get_last_error(void)
+
+[caption=""]
+.Returns
+`bool`
+
 [#_error_code]
 ==== error_code
 
@@ -72,20 +88,3 @@ Returns the error which set the error flag.
 .Returns
 `struct Error*`
 
-
-[#_check_error]
-==== check_error
-
-[source,cpp]
-----
-bool check_error(void)
-----
-
-
-
-Checks if the error flag was set by the last operation. If true, the error can be retrieved using get_last_error(void)
-
-[caption=""]
-.Returns
-`bool`
-
@@ -1,4 +1,4 @@
-[#_methods__errors__schemaexception]
+[#_methods_errors_schemaexception]
 === schemaexception
 
 [#_Struct_SchemaException]

@@ -1,4 +1,4 @@
-[#_methods__logic__logic]
+[#_methods_logic_logic]
 === logic
 
 [#_logic_manager_get_rule]

@@ -1,4 +1,4 @@
-[#_methods__logic__rule]
+[#_methods_logic_rule]
 === rule
 
 [#_Struct_Rule]

@@ -1,4 +1,4 @@
-[#_methods__schema__annotation]
+[#_methods_schema_annotation]
 === annotation
 
 [#_Struct_Annotation]

@@ -1,4 +1,4 @@
-[#_methods__schema__attributetype]
+[#_methods_schema_attributetype]
 === attributetype
 
 [#_attribute_type_get]

@@ -1,4 +1,4 @@
-[#_methods__schema__entitytype]
+[#_methods_schema_entitytype]
 === entitytype
 
 [#_entity_type_create]