From c2244aaa570a51a2bc19e2535d5abc7349ea6a5e Mon Sep 17 00:00:00 2001 From: Vladimir Izmalkov Date: Fri, 26 Apr 2024 18:37:31 +0100 Subject: [PATCH 1/2] Replace content with adoc files from the drivers repo --- .../ROOT/partials/c/answer/explanation.adoc | 30 ++++---- .../ROOT/partials/c/answer/primitives.adoc | 63 ++++++++------- .../partials/c/connection/connection.adoc | 60 +++++++++++---- .../ROOT/partials/c/connection/replica.adoc | 8 +- .../modules/ROOT/partials/c/errors/error.adoc | 33 ++++---- .../ROOT/partials/c/schema/valuetype.adoc | 11 ++- .../ROOT/partials/cpp/answer/Future.adoc | 8 +- .../ROOT/partials/cpp/answer/Iterable.adoc | 8 +- .../ROOT/partials/cpp/answer/Iterator.adoc | 12 +-- .../ROOT/partials/cpp/answer/JSON.adoc | 40 ++++++++++ .../cpp/answer/OwnerAttributePair.adoc | 2 +- .../ROOT/partials/cpp/answer/typedefs.adoc | 77 ++++++++++--------- .../ROOT/partials/cpp/connection/Driver.adoc | 12 +-- .../partials/cpp/connection/ReplicaInfo.adoc | 28 +++---- .../partials/cpp/connection/UserManager.adoc | 2 +- .../modules/ROOT/partials/cpp/data/Thing.adoc | 8 +- .../partials/cpp/schema/AttributeType.adoc | 2 +- .../partials/cpp/schema/RelationType.adoc | 6 +- .../ROOT/partials/cpp/schema/ThingType.adoc | 18 ++--- .../ROOT/partials/cpp/schema/Type.adoc | 2 +- .../java/connection/Database.Replica.adoc | 28 +++---- .../ROOT/partials/java/connection/TypeDB.adoc | 33 ++++++++ .../partials/nodejs/connection/Replica.adoc | 2 +- .../partials/nodejs/connection/TypeDB.adoc | 4 +- .../partials/python/connection/Replica.adoc | 28 +++---- .../partials/python/connection/TypeDB.adoc | 6 +- .../partials/rust/connection/Connection.adoc | 48 ++++++++++++ .../partials/rust/connection/ReplicaInfo.adoc | 2 +- .../partials/rust/errors/ConnectionError.adoc | 1 + .../partials/rust/errors/InternalError.adoc | 2 +- 30 files changed, 362 insertions(+), 222 deletions(-) diff --git a/drivers-src/modules/ROOT/partials/c/answer/explanation.adoc b/drivers-src/modules/ROOT/partials/c/answer/explanation.adoc index 4cf03877d..00a1464b9 100644 --- a/drivers-src/modules/ROOT/partials/c/answer/explanation.adoc +++ b/drivers-src/modules/ROOT/partials/c/answer/explanation.adoc @@ -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 diff --git a/drivers-src/modules/ROOT/partials/c/answer/primitives.adoc b/drivers-src/modules/ROOT/partials/c/answer/primitives.adoc index 0d424a4bd..a9ac0f4ca 100644 --- a/drivers-src/modules/ROOT/partials/c/answer/primitives.adoc +++ b/drivers-src/modules/ROOT/partials/c/answer/primitives.adoc @@ -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 diff --git a/drivers-src/modules/ROOT/partials/c/connection/connection.adoc b/drivers-src/modules/ROOT/partials/c/connection/connection.adoc index b0b872fd8..ad33acd5d 100644 --- a/drivers-src/modules/ROOT/partials/c/connection/connection.adoc +++ b/drivers-src/modules/ROOT/partials/c/connection/connection.adoc @@ -1,22 +1,6 @@ [#_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` + diff --git a/drivers-src/modules/ROOT/partials/c/connection/replica.adoc b/drivers-src/modules/ROOT/partials/c/connection/replica.adoc index 77cedf593..f93370f3a 100644 --- a/drivers-src/modules/ROOT/partials/c/connection/replica.adoc +++ b/drivers-src/modules/ROOT/partials/c/connection/replica.adoc @@ -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 diff --git a/drivers-src/modules/ROOT/partials/c/errors/error.adoc b/drivers-src/modules/ROOT/partials/c/errors/error.adoc index 75e1660a8..5db98eaef 100644 --- a/drivers-src/modules/ROOT/partials/c/errors/error.adoc +++ b/drivers-src/modules/ROOT/partials/c/errors/error.adoc @@ -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` - diff --git a/drivers-src/modules/ROOT/partials/c/schema/valuetype.adoc b/drivers-src/modules/ROOT/partials/c/schema/valuetype.adoc index df23f7a1d..cb6ebfe27 100644 --- a/drivers-src/modules/ROOT/partials/c/schema/valuetype.adoc +++ b/drivers-src/modules/ROOT/partials/c/schema/valuetype.adoc @@ -8,12 +8,12 @@ Represents the type of primitive value is held by a Value or Attribute. -[#_Enum_ValueType2] +[#_Enum_ValueType] ==== Enum ValueType -Retrieves the ``ValueType`` of this ``AttributeType``. +Represents the type of primitive value is held by a Value or Attribute. [caption=""] .Enum constants @@ -31,10 +31,15 @@ a| `String` |=== // end::enum_constants[] +[#_Enum_ValueType] +==== Enum ValueType + +Retrieves the ``ValueType`` of this ``AttributeType``. + [caption=""] -.Example +.Enum constants // tag::enum_constants[] [cols=""] [options="header"] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/Future.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/Future.adoc index de5c06c08..136f02942 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/Future.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/Future.adoc @@ -1,13 +1,9 @@ -[#_Future__RETURN__NATIVE_PROMISE__HELPER_] -=== Future +[#_Future] +=== Future< RETURN, NATIVE_PROMISE, HELPER > *Package*: `TypeDB` - template> - - class TypeDB::Future< RETURN, NATIVE_PROMISE, HELPER > - A structure emulating std::future, used as result of an asynchronous call to the server. diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/Iterable.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/Iterable.adoc index aae659b9b..150e69a3d 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/Iterable.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/Iterable.adoc @@ -1,13 +1,9 @@ -[#_Iterable__NATIVE_ITER__NATIVE_T__T__HELPER_] -=== Iterable +[#_Iterable] +=== Iterable< NATIVE_ITER, NATIVE_T, T, HELPER > *Package*: `TypeDB` - template> - - class TypeDB::Iterable< NATIVE_ITER, NATIVE_T, T, HELPER > - Result representing a stream of query results. diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/Iterator.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/Iterator.adoc index c459fe3fa..af1407fe5 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/Iterator.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/Iterator.adoc @@ -1,17 +1,9 @@ -[#_Iterator__NATIVE_ITER__NATIVE_T__T__HELPER_] -=== Iterator +[#_Iterator] +=== Iterator< NATIVE_ITER, NATIVE_T, T, HELPER > *Package*: `TypeDB` -[,cpp] ----- -template> ----- -[,cpp] ----- -class TypeDB::Iterator< NATIVE_ITER, NATIVE_T, T, HELPER > ----- A structure emulating std::iterator, used for streaming of query results from the server. diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/JSON.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/JSON.adoc index 3bdf0f169..f184b9d22 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/JSON.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/JSON.adoc @@ -216,5 +216,45 @@ Parses a JSON string into a ``JSON`` object. .Returns `static JSON` +[#_const_stdstring_TypeDBJSONtoString_____const] +==== toString + +[source,cpp] +---- +const std::string TypeDB::JSON::toString() const +---- + + + +Convert a JSON object to a string + +[caption=""] +.Returns +`const std::string` + +[#_JSONType_TypeDBJSONtype_____const] +==== type + +[source,cpp] +---- +JSONType TypeDB::JSON::type() const +---- + + + +The JSONType of this JSON object + + +[caption=""] +.Returns +`JSONType` + +[caption=""] +.Code examples +[source,cpp] +---- +switch(json.type() { ... } +---- + // end::methods[] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/OwnerAttributePair.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/OwnerAttributePair.adoc index d764a794f..14a9266dc 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/OwnerAttributePair.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/OwnerAttributePair.adoc @@ -5,7 +5,7 @@ -Simple class holding the owner concept & owned attribute identifying an explainable ownership. +Simple class holding the owner concept & owned attribute identifying an explainable ownership. [caption=""] .Fields diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/typedefs.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/typedefs.adoc index 9548a0d85..4469300ec 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/typedefs.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/typedefs.adoc @@ -1,180 +1,183 @@ +[#_aliases] +=== Aliases + [#_ConceptMapIterator] -=== ConceptMapIterator +==== ConceptMapIterator Alias for Iterator<_native::ConceptMapIterator, _native::ConceptMap, TypeDB::ConceptMap> [#_ConceptMapIterable] -=== ConceptMapIterable +==== ConceptMapIterable Alias for Iterable<_native::ConceptMapIterator, _native::ConceptMap, TypeDB::ConceptMap> [#_ConceptMapGroupIterable] -=== ConceptMapGroupIterable +==== ConceptMapGroupIterable Alias for Iterable<_native::ConceptMapGroupIterator, _native::ConceptMapGroup, TypeDB::ConceptMapGroup> [#_ConceptMapGroupIterator] -=== ConceptMapGroupIterator +==== ConceptMapGroupIterator Alias for Iterator<_native::ConceptMapGroupIterator, _native::ConceptMapGroup, TypeDB::ConceptMapGroup> [#_OwnerAttributePairIterator] -=== OwnerAttributePairIterator +==== OwnerAttributePairIterator Alias for Iterator<_native::StringPairIterator, _native::StringPair, OwnerAttributePair> [#_OwnerAttributePairIterable] -=== OwnerAttributePairIterable +==== OwnerAttributePairIterable Alias for Iterable<_native::StringPairIterator, _native::StringPair, OwnerAttributePair> [#_JSONMap] -=== JSONMap +==== JSONMap Alias for std::map [#_JSONArray] -=== JSONArray +==== JSONArray Alias for std::vector [#_JSONBoolean] -=== JSONBoolean +==== JSONBoolean Alias for bool [#_JSONLong] -=== JSONLong +==== JSONLong Alias for long [#_JSONDouble] -=== JSONDouble +==== JSONDouble Alias for double [#_JSONString] -=== JSONString +==== JSONString Alias for std::string [#_AggregateResult] -=== AggregateResult +==== AggregateResult Alias for std::optional> [#_AggregateFuture] -=== AggregateFuture +==== AggregateFuture Alias for Future [#_ValueGroupIterable] -=== ValueGroupIterable +==== ValueGroupIterable Alias for Iterable<_native::ValueGroupIterator, _native::ValueGroup, TypeDB::ValueGroup> [#_ValueGroupIterator] -=== ValueGroupIterator +==== ValueGroupIterator Alias for Iterator<_native::ValueGroupIterator, _native::ValueGroup, TypeDB::ValueGroup> [#_VoidFuture] -=== VoidFuture +==== VoidFuture Alias for Future [#_BoolFuture] -=== BoolFuture +==== BoolFuture Alias for Future [#_StringFuture] -=== StringFuture +==== StringFuture Alias for Future [#_OptionalStringFuture] -=== OptionalStringFuture +==== OptionalStringFuture Alias for Future, _native::StringPromise> [#_StringIterable] -=== StringIterable +==== StringIterable Alias for Iterable<_native::StringIterator, char, std::string> [#_StringIterator] -=== StringIterator +==== StringIterator Alias for Iterator<_native::StringIterator, char, std::string> [#_DateTime] -=== DateTime +==== DateTime -Alias for std::chrono::time_point< std::chrono::system_clock, std::chrono::milliseconds > +Alias for std::chrono::time_point [#_DatabaseIterator] -=== DatabaseIterator +==== DatabaseIterator Alias for Iterator<_native::DatabaseIterator, _native::Database, TypeDB::Database> [#_DatabaseIterable] -=== DatabaseIterable +==== DatabaseIterable Alias for Iterable<_native::DatabaseIterator, _native::Database, TypeDB::Database> [#_ReplicaInfoIterable] -=== ReplicaInfoIterable +==== ReplicaInfoIterable Alias for Iterable<_native::ReplicaInfoIterator, _native::ReplicaInfo, ReplicaInfo> [#_ReplicaInfoIterator] -=== ReplicaInfoIterator +==== ReplicaInfoIterator Alias for Iterator<_native::ReplicaInfoIterator, _native::ReplicaInfo, ReplicaInfo> [#_ExplanationIterator] -=== ExplanationIterator +==== ExplanationIterator Alias for Iterator<_native::ExplanationIterator, _native::Explanation, Explanation> [#_ExplanationIterable] -=== ExplanationIterable +==== ExplanationIterable Alias for Iterable<_native::ExplanationIterator, _native::Explanation, Explanation> [#_RuleFuture] -=== RuleFuture +==== RuleFuture Alias for Future [#_OptionalRuleFuture] -=== OptionalRuleFuture +==== OptionalRuleFuture Alias for Future, _native::RulePromise> [#_RuleIterable] -=== RuleIterable +==== RuleIterable Alias for Iterable<_native::RuleIterator, _native::Rule, Rule> [#_RuleIterator] -=== RuleIterator +==== RuleIterator Alias for Iterator<_native::RuleIterator, _native::Rule, Rule> [#_JSONIterable] -=== JSONIterable +==== JSONIterable Alias for Iterable<_native::StringIterator, char, JSON> [#_UserIterator] -=== UserIterator +==== UserIterator Alias for Iterator<_native::UserIterator, _native::User, User> [#_UserIterable] -=== UserIterable +==== UserIterable Alias for Iterable<_native::UserIterator, _native::User, User> diff --git a/drivers-src/modules/ROOT/partials/cpp/connection/Driver.adoc b/drivers-src/modules/ROOT/partials/cpp/connection/Driver.adoc index 18324459e..c67f56423 100644 --- a/drivers-src/modules/ROOT/partials/cpp/connection/Driver.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/connection/Driver.adoc @@ -44,12 +44,12 @@ Closes the driver. Before instantiating a new driver, the driver that’s curren driver.close() ---- -[#_static_Driver_TypeDBDrivercloudDriver___const_stdvector__stdstring____cloudAddresses__const_Credential__credential_] +[#_static_Driver_TypeDBDrivercloudDriver___const_stdvector__stdstring____addresses__const_Credential__credential_] ==== cloudDriver [source,cpp] ---- -static Driver TypeDB::Driver::cloudDriver(const std::vector< std::string >& cloudAddresses, const Credential& credential) +static Driver TypeDB::Driver::cloudDriver(const std::vector< std::string >& addresses, const Credential& credential) ---- @@ -63,7 +63,7 @@ Open a TypeDB Driver to TypeDB Cloud server(s) available at the provided address [options="header"] |=== |Name |Description |Type -a| `addresses` a| The address(es) of the TypeDB server(s) a| +a| `addresses` a| The address(es) of the TypeDB server(s) or translation map from addresses received from the TypeDB server(s) to addresses to be used by the driver for connection a| `const std::vector< std::string >&` a| `credential` a| The Credential to connect with a| `const Credential&` |=== @@ -78,12 +78,12 @@ a| `credential` a| The Credential to connect with a| `const Credential&` Driver::cloudDriver(addresses, credential); ---- -[#_static_Driver_TypeDBDrivercoreDriver___const_stdstring__coreAddress_] +[#_static_Driver_TypeDBDrivercoreDriver___const_stdstring__address_] ==== coreDriver [source,cpp] ---- -static Driver TypeDB::Driver::coreDriver(const std::string& coreAddress) +static Driver TypeDB::Driver::coreDriver(const std::string& address) ---- @@ -97,7 +97,7 @@ Open a TypeDB Driver to a TypeDB Core server available at the provided address. [options="header"] |=== |Name |Description |Type -a| `address` a| The address of the TypeDB server a| +a| `address` a| The address of the TypeDB server a| `const std::string&` |=== [caption=""] diff --git a/drivers-src/modules/ROOT/partials/cpp/connection/ReplicaInfo.adoc b/drivers-src/modules/ROOT/partials/cpp/connection/ReplicaInfo.adoc index 6cfb6ee7f..28294967d 100644 --- a/drivers-src/modules/ROOT/partials/cpp/connection/ReplicaInfo.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/connection/ReplicaInfo.adoc @@ -8,53 +8,53 @@ The metadata and state of an individual raft replica of a database. // tag::methods[] -[#_stdstring_TypeDBReplicaInfoaddress___] -==== address +[#_bool_TypeDBReplicaInfoisPreferred___] +==== isPreferred [source,cpp] ---- -std::string TypeDB::ReplicaInfo::address() +bool TypeDB::ReplicaInfo::isPreferred() ---- -Retrieves the address of the server hosting this replica +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. [caption=""] .Returns -`std::string` +`bool` -[#_bool_TypeDBReplicaInfoisPreferred___] -==== isPreferred +[#_bool_TypeDBReplicaInfoisPrimary___] +==== isPrimary [source,cpp] ---- -bool TypeDB::ReplicaInfo::isPreferred() +bool TypeDB::ReplicaInfo::isPrimary() ---- -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. +Checks whether this is the primary replica of the raft cluster. [caption=""] .Returns `bool` -[#_bool_TypeDBReplicaInfoisPrimary___] -==== isPrimary +[#_stdstring_TypeDBReplicaInfoserver___] +==== server [source,cpp] ---- -bool TypeDB::ReplicaInfo::isPrimary() +std::string TypeDB::ReplicaInfo::server() ---- -Checks whether this is the primary replica of the raft cluster. +The server hosting this replica [caption=""] .Returns -`bool` +`std::string` [#_int64_t_TypeDBReplicaInfoterm___] ==== term diff --git a/drivers-src/modules/ROOT/partials/cpp/connection/UserManager.adoc b/drivers-src/modules/ROOT/partials/cpp/connection/UserManager.adoc index 2152ae91e..45debd286 100644 --- a/drivers-src/modules/ROOT/partials/cpp/connection/UserManager.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/connection/UserManager.adoc @@ -75,7 +75,7 @@ void TypeDB::UserManager::create(const std::string& username, const std::string& -Creates a user with the given name & password. +Creates a user with the given name & password. [caption=""] diff --git a/drivers-src/modules/ROOT/partials/cpp/data/Thing.adoc b/drivers-src/modules/ROOT/partials/cpp/data/Thing.adoc index 73958f85c..cda304ef9 100644 --- a/drivers-src/modules/ROOT/partials/cpp/data/Thing.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/data/Thing.adoc @@ -90,7 +90,7 @@ ConceptIterable< Attribute > TypeDB::Thing::getHas(Transaction& transaction, con -See <<#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__stdunique_ptr__AttributeType______attributeTypes_,getHas(Transaction&, const std::vector<std::unique_ptr<AttributeType>>&)>> +See <<#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__stdunique_ptr__AttributeType______attributeTypes_,getHas(Transaction&, const std::vector>&)>> [caption=""] .Returns @@ -140,7 +140,7 @@ ConceptIterable< Attribute > TypeDB::Thing::getHas(Transaction& transaction, con -See <<#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__stdunique_ptr__AttributeType______attributeTypes_,getHas(Transaction& transaction, const std::vector<std::unique_ptr<AttributeType>>& attributeTypes)>> +See <<#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__stdunique_ptr__AttributeType______attributeTypes_,getHas(Transaction& transaction, const std::vector>& attributeTypes)>> [caption=""] .Returns @@ -156,7 +156,7 @@ ConceptIterable< Attribute > TypeDB::Thing::getHas(Transaction& transaction, con -See <<#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdinitializer_list__Annotation____annotations___,getHas(Transaction&, const std::initializer_list<Annotation>&)>> +See <<#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdinitializer_list__Annotation____annotations___,getHas(Transaction&, const std::initializer_list&)>> [caption=""] .Returns @@ -264,7 +264,7 @@ ConceptIterable< Relation > TypeDB::Thing::getRelations(Transaction& transaction -See <<#_ConceptIterable__Relation___TypeDBThinggetRelations___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes___,getRelations(Transaction& transaction, const std::vector<std::unique_ptr<RoleType>>& roleTypes)>> +See <<#_ConceptIterable__Relation___TypeDBThinggetRelations___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes___,getRelations(Transaction& transaction, const std::vector>& roleTypes)>> [caption=""] .Returns diff --git a/drivers-src/modules/ROOT/partials/cpp/schema/AttributeType.adoc b/drivers-src/modules/ROOT/partials/cpp/schema/AttributeType.adoc index 7d369bd84..a2d269f1d 100644 --- a/drivers-src/modules/ROOT/partials/cpp/schema/AttributeType.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/schema/AttributeType.adoc @@ -307,7 +307,7 @@ ConceptIterable< ThingType > TypeDB::AttributeType::getOwners(Transaction& trans -Variant of <<#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwners>>(Transaction& transaction, const std::vector<Annotation>& annotations, Transitivity transitivity = Transitivity::TRANSITIVE) for convenience +Variant of <<#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwners>>(Transaction& transaction, const std::vector& annotations, Transitivity transitivity = Transitivity::TRANSITIVE) for convenience [caption=""] diff --git a/drivers-src/modules/ROOT/partials/cpp/schema/RelationType.adoc b/drivers-src/modules/ROOT/partials/cpp/schema/RelationType.adoc index 63f3b3fa9..24c91f8d2 100644 --- a/drivers-src/modules/ROOT/partials/cpp/schema/RelationType.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/schema/RelationType.adoc @@ -263,7 +263,7 @@ VoidFuture TypeDB::RelationType::setRelates(Transaction& transaction, const std: -Variant of <<#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel__const_stdstring__overriddenLabel_,setRelates(Transaction& transaction, const std::string& roleLabel, const std::string& overriddenLabel)>> where the RoleType does not override an existing role. +Variant of <<#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel__const_stdstring__overriddenLabel_,setRelates(Transaction& transaction, const std::string& roleLabel, const std::string& overriddenLabel)>> where the RoleType does not override an existing role. [caption=""] .Returns @@ -279,7 +279,7 @@ VoidFuture TypeDB::RelationType::setRelates(Transaction& transaction, const std: -Variant of <<#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel__const_stdstring__overriddenLabel_,setRelates(Transaction& transaction, const std::string& roleLabel, const std::string& overriddenLabel)>> where the RoleType is specified directly rather than the label. +Variant of <<#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel__const_stdstring__overriddenLabel_,setRelates(Transaction& transaction, const std::string& roleLabel, const std::string& overriddenLabel)>> where the RoleType is specified directly rather than the label. [caption=""] .Returns @@ -365,7 +365,7 @@ VoidFuture TypeDB::RelationType::unsetRelates(Transaction& transaction, RoleType -Variant of <<#_VoidFuture_TypeDBRelationTypeunsetRelates___Transaction__transaction__const_stdstring__roleLabel_,unsetRelates(Transaction& transaction, const std::string& roleLabel)>> where the RoleType is specified directly rather than the label. +Variant of <<#_VoidFuture_TypeDBRelationTypeunsetRelates___Transaction__transaction__const_stdstring__roleLabel_,unsetRelates(Transaction& transaction, const std::string& roleLabel)>> where the RoleType is specified directly rather than the label. [caption=""] .Returns diff --git a/drivers-src/modules/ROOT/partials/cpp/schema/ThingType.adoc b/drivers-src/modules/ROOT/partials/cpp/schema/ThingType.adoc index 471a8b371..bf8842067 100644 --- a/drivers-src/modules/ROOT/partials/cpp/schema/ThingType.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/schema/ThingType.adoc @@ -88,7 +88,7 @@ ConceptIterable< AttributeType > TypeDB::ThingType::getOwns(Transaction& transac -Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector<Annotation>&, Transitivity)>> without filtering on ``ValueType`` or ``Annotation``s +Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``ValueType`` or ``Annotation``s [caption=""] .Returns @@ -106,7 +106,7 @@ ConceptIterable< AttributeType > TypeDB::ThingType::getOwns(Transaction& transac -Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector<Annotation>&, Transitivity)>> without filtering on ``ValueType`` +Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``ValueType`` [caption=""] .Returns @@ -122,7 +122,7 @@ ConceptIterable< AttributeType > TypeDB::ThingType::getOwns(Transaction& transac -Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector<Annotation>&, Transitivity)>> without filtering on ``ValueType`` +Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``ValueType`` [caption=""] .Returns @@ -138,7 +138,7 @@ ConceptIterable< AttributeType > TypeDB::ThingType::getOwns(Transaction& transac -Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector<Annotation>&, Transitivity)>> without filtering on ``Annotation``s +Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``Annotation``s [caption=""] .Returns @@ -154,7 +154,7 @@ ConceptIterable< AttributeType > TypeDB::ThingType::getOwns(Transaction& transac -See <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector<Annotation>&, Transitivity)>> +See <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> [caption=""] .Returns @@ -612,7 +612,7 @@ VoidFuture TypeDB::ThingType::setOwns(Transaction& transaction, AttributeType* a -Variant of <<#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__AttributeType__ptr__overriddenType__const_stdvector__Annotation____annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector<Annotation>&)>> with no overridden attribute type +Variant of <<#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__AttributeType__ptr__overriddenType__const_stdvector__Annotation____annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector&)>> with no overridden attribute type [caption=""] .Returns @@ -628,7 +628,7 @@ VoidFuture TypeDB::ThingType::setOwns(Transaction& transaction, AttributeType* a -Variant of <<#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__AttributeType__ptr__overriddenType__const_stdvector__Annotation____annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector<Annotation>&)>> with no overridden attribute type +Variant of <<#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__AttributeType__ptr__overriddenType__const_stdvector__Annotation____annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector&)>> with no overridden attribute type [caption=""] .Returns @@ -644,7 +644,7 @@ VoidFuture TypeDB::ThingType::setOwns(Transaction& transaction, AttributeType* a -See <<#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__AttributeType__ptr__overriddenType__const_stdvector__Annotation____annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector<Annotation>&)>> +See <<#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__AttributeType__ptr__overriddenType__const_stdvector__Annotation____annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector&)>> [caption=""] .Returns @@ -697,7 +697,7 @@ VoidFuture TypeDB::ThingType::setPlays(Transaction& transaction, RoleType* roleT -Variant of <<#_VoidFuture_TypeDBThingTypesetPlays___Transaction__transaction__RoleType__ptr__roleType__RoleType__ptr__overriddenRoleType_,setPlays(Transaction&, RoleType*, RoleType*)>> with no overridden role type. +Variant of <<#_VoidFuture_TypeDBThingTypesetPlays___Transaction__transaction__RoleType__ptr__roleType__RoleType__ptr__overriddenRoleType_,setPlays(Transaction&, RoleType*, RoleType*)>> with no overridden role type. [caption=""] .Returns diff --git a/drivers-src/modules/ROOT/partials/cpp/schema/Type.adoc b/drivers-src/modules/ROOT/partials/cpp/schema/Type.adoc index 67853a9f8..da1913616 100644 --- a/drivers-src/modules/ROOT/partials/cpp/schema/Type.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/schema/Type.adoc @@ -9,7 +9,7 @@ -Common super-type of RoleType & ThingType. +Common super-type of RoleType & ThingType. // tag::methods[] [#_virtual_VoidFuture_TypeDBTypedeleteType___Transaction__transaction_] diff --git a/drivers-src/modules/ROOT/partials/java/connection/Database.Replica.adoc b/drivers-src/modules/ROOT/partials/java/connection/Database.Replica.adoc index 115a27b25..3f5426cf3 100644 --- a/drivers-src/modules/ROOT/partials/java/connection/Database.Replica.adoc +++ b/drivers-src/modules/ROOT/partials/java/connection/Database.Replica.adoc @@ -6,50 +6,50 @@ The metadata and state of an individual raft replica of a database. // tag::methods[] -[#_Database_Replica_address__] -==== address +[#_Database_Replica_isPreferred__] +==== isPreferred [source,java] ---- @CheckReturnValue -java.lang.String address() +boolean isPreferred() ---- -Retrieves the address of the server hosting this replica +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. [caption=""] .Returns -`java.lang.String` +`boolean` -[#_Database_Replica_isPreferred__] -==== isPreferred +[#_Database_Replica_isPrimary__] +==== isPrimary [source,java] ---- @CheckReturnValue -boolean isPreferred() +boolean isPrimary() ---- -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. +Checks whether this is the primary replica of the raft cluster. [caption=""] .Returns `boolean` -[#_Database_Replica_isPrimary__] -==== isPrimary +[#_Database_Replica_server__] +==== server [source,java] ---- @CheckReturnValue -boolean isPrimary() +java.lang.String server() ---- -Checks whether this is the primary replica of the raft cluster. +The server hosting this replica [caption=""] .Returns -`boolean` +`java.lang.String` [#_Database_Replica_term__] ==== term diff --git a/drivers-src/modules/ROOT/partials/java/connection/TypeDB.adoc b/drivers-src/modules/ROOT/partials/java/connection/TypeDB.adoc index 3608520d0..6411f63d1 100644 --- a/drivers-src/modules/ROOT/partials/java/connection/TypeDB.adoc +++ b/drivers-src/modules/ROOT/partials/java/connection/TypeDB.adoc @@ -95,6 +95,39 @@ a| `credential` a| The credential to connect with a| `TypeDBCredential` TypeDB.cloudDriver(addresses, credential); ---- +[#_TypeDB_cloudDriver__java_util_Map_java_lang_String_​java_lang_String___TypeDBCredential] +==== cloudDriver + +[source,java] +---- +public static TypeDBDriver cloudDriver​(java.util.Map addressTranslation, + TypeDBCredential 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| `addressTranslation` a| Translation map from addresses received from the TypeDB server(s) to addresses to be used by the driver for connection a| `java.util.Map` +a| `credential` a| The credential to connect with a| `TypeDBCredential` +|=== + +[caption=""] +.Returns +`public static TypeDBDriver` + +[caption=""] +.Code examples +[source,java] +---- +TypeDB.cloudDriver(addressTranslation, credential); +---- + [#_TypeDB_coreDriver__java_lang_String] ==== coreDriver diff --git a/drivers-src/modules/ROOT/partials/nodejs/connection/Replica.adoc b/drivers-src/modules/ROOT/partials/nodejs/connection/Replica.adoc index 3464de5cd..e42d26308 100644 --- a/drivers-src/modules/ROOT/partials/nodejs/connection/Replica.adoc +++ b/drivers-src/modules/ROOT/partials/nodejs/connection/Replica.adoc @@ -10,10 +10,10 @@ The metadata and state of an individual raft replica of a database. [options="header"] |=== |Name |Type |Description -a| `address` a| `string` a| The address of the server hosting this replica a| `databaseName` a| `string` a| The database for which this is a replica. a| `preferred` a| `boolean` a| 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. a| `primary` a| `boolean` a| Checks whether this is the primary replica of the raft cluster. +a| `server` a| `string` a| The server hosting this replica a| `term` a| `number` a| The raft protocol ‘term’ of this replica. |=== // end::properties[] diff --git a/drivers-src/modules/ROOT/partials/nodejs/connection/TypeDB.adoc b/drivers-src/modules/ROOT/partials/nodejs/connection/TypeDB.adoc index 705cc9ad4..23e1f0659 100644 --- a/drivers-src/modules/ROOT/partials/nodejs/connection/TypeDB.adoc +++ b/drivers-src/modules/ROOT/partials/nodejs/connection/TypeDB.adoc @@ -13,7 +13,7 @@ a| `DEFAULT_ADDRESS` // end::enum_constants[] // tag::methods[] -[#_TypeDB_cloudDriver__addresses_string__string____credential_TypeDBCredential] +[#_TypeDB_cloudDriver__addresses_string__string____Record_string__string___credential_TypeDBCredential] ==== cloudDriver [source,nodejs] @@ -29,7 +29,7 @@ Creates a connection to TypeDB Cloud, authenticating with the provided credentia [options="header"] |=== |Name |Description |Type -a| `addresses` a| List of addresses of the individual TypeDB Cloud servers. As long one specified address is provided, the driver will discover the other addresses from that server. a| `string \| string[]` +a| `addresses` a| List of addresses of the individual TypeDB Cloud servers. As long one specified address is provided, the driver will discover the other addresses from that server. a| `string \| string[] \| Record` a| `credential` a| The credentials to log in, and encryption settings. See ``TypeDBCredential`` Examples ``const driver = TypeDB.cloudDriver(["127.0.0.1:11729"], new TypeDBCredential(username, password)); diff --git a/drivers-src/modules/ROOT/partials/python/connection/Replica.adoc b/drivers-src/modules/ROOT/partials/python/connection/Replica.adoc index 72e8c9568..d686bd4f8 100644 --- a/drivers-src/modules/ROOT/partials/python/connection/Replica.adoc +++ b/drivers-src/modules/ROOT/partials/python/connection/Replica.adoc @@ -4,20 +4,6 @@ The metadata and state of an individual raft replica of a database. // tag::methods[] -[#_Replica_address__] -==== address - -[source,python] ----- -address() -> str ----- - -Retrieves address of the server hosting this replica - -[caption=""] -.Returns -`str` - [#_Replica_database__] ==== database @@ -60,6 +46,20 @@ Checks whether this is the primary replica of the raft cluster. .Returns `bool` +[#_Replica_server__] +==== server + +[source,python] +---- +server() -> str +---- + +The server hosting this replica + +[caption=""] +.Returns +`str` + [#_Replica_term__] ==== term diff --git a/drivers-src/modules/ROOT/partials/python/connection/TypeDB.adoc b/drivers-src/modules/ROOT/partials/python/connection/TypeDB.adoc index 2c6a39f78..49c8a01fb 100644 --- a/drivers-src/modules/ROOT/partials/python/connection/TypeDB.adoc +++ b/drivers-src/modules/ROOT/partials/python/connection/TypeDB.adoc @@ -2,12 +2,12 @@ === TypeDB // tag::methods[] -[#_TypeDB_cloud_driver__addresses_Iterable_str___str__credential_TypeDBCredential] +[#_TypeDB_cloud_driver__addresses_Mapping_str__str___Iterable_str___str__credential_TypeDBCredential] ==== cloud_driver [source,python] ---- -static cloud_driver(addresses: Iterable[str] | str, credential: TypeDBCredential) -> TypeDBDriver +static cloud_driver(addresses: Mapping[str, str] | Iterable[str] | str, credential: TypeDBCredential) -> TypeDBDriver ---- Creates a connection to TypeDB Cloud, authenticating with the provided credentials. @@ -18,7 +18,7 @@ Creates a connection to TypeDB Cloud, authenticating with the provided credentia [options="header"] |=== |Name |Description |Type |Default Value -a| `addresses` a| – a| `Iterable[str] \| str` a| +a| `addresses` a| – a| `Mapping[str, str] \| Iterable[str] \| str` a| a| `credential` a| – a| `TypeDBCredential` a| |=== diff --git a/drivers-src/modules/ROOT/partials/rust/connection/Connection.adoc b/drivers-src/modules/ROOT/partials/rust/connection/Connection.adoc index 4a63a18e2..639d3222a 100644 --- a/drivers-src/modules/ROOT/partials/rust/connection/Connection.adoc +++ b/drivers-src/modules/ROOT/partials/rust/connection/Connection.adoc @@ -128,6 +128,54 @@ Connection::new_cloud( ) ---- +[#_struct_Connection_new_cloud_with_translation__address_translation_HashMap_T__credential_Credential] +==== new_cloud_with_translation + +[source,rust] +---- +pub fn new_cloud_with_translation( + address_translation: HashMap, + credential: Credential +) -> Resultwhere + T: AsRef + Sync, + U: AsRef + Sync, +---- + +Creates a new TypeDB Cloud connection. + +[caption=""] +.Input parameters +[cols=",,"] +[options="header"] +|=== +|Name |Description |Type +a| `address_translation` a| Translation map from addresses received from the TypeDB server(s) to addresses to be used by the driver for connection a| `HashMapwhere + T: AsRef + Sync, + U: AsRef + Sync, +---- + +[caption=""] +.Code examples +[source,rust] +---- +Connection::new_cloud_with_translation( + [ + ("typedb-cloud.ext:11729", "localhost:11729"), + ("typedb-cloud.ext:21729", "localhost:21729"), + ("typedb-cloud.ext:31729", "localhost:31729"), + ].into(), + credential, +) +---- + [#_struct_Connection_new_core__address_impl_AsRef_str_] ==== new_core diff --git a/drivers-src/modules/ROOT/partials/rust/connection/ReplicaInfo.adoc b/drivers-src/modules/ROOT/partials/rust/connection/ReplicaInfo.adoc index 4afca870f..f84cf2439 100644 --- a/drivers-src/modules/ROOT/partials/rust/connection/ReplicaInfo.adoc +++ b/drivers-src/modules/ROOT/partials/rust/connection/ReplicaInfo.adoc @@ -14,9 +14,9 @@ The metadata and state of an individual raft replica of a database. [options="header"] |=== |Name |Type |Description -a| `address` a| `Address` a| The address of the server hosting this replica a| `is_preferred` a| `bool` a| 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. a| `is_primary` a| `bool` a| Whether this is the primary replica of the raft cluster. +a| `server` a| `String` a| The server hosting this replica a| `term` a| `i64` a| The raft protocol ‘term’ of this replica. |=== // end::properties[] diff --git a/drivers-src/modules/ROOT/partials/rust/errors/ConnectionError.adoc b/drivers-src/modules/ROOT/partials/rust/errors/ConnectionError.adoc index a054d17d6..4d243d8d3 100644 --- a/drivers-src/modules/ROOT/partials/rust/errors/ConnectionError.adoc +++ b/drivers-src/modules/ROOT/partials/rust/errors/ConnectionError.adoc @@ -8,6 +8,7 @@ [options="header"] |=== |Variant +a| `AddressTranslationMismatch` a| `BrokenPipe` a| `CloudAllNodesFailed` a| `CloudEndpointEncrypted` diff --git a/drivers-src/modules/ROOT/partials/rust/errors/InternalError.adoc b/drivers-src/modules/ROOT/partials/rust/errors/InternalError.adoc index a59d2cc82..78f7c480b 100644 --- a/drivers-src/modules/ROOT/partials/rust/errors/InternalError.adoc +++ b/drivers-src/modules/ROOT/partials/rust/errors/InternalError.adoc @@ -13,7 +13,7 @@ a| `RecvError` a| `SendError` a| `UnexpectedRequestType` a| `UnexpectedResponseType` -a| `UnknownConnectionAddress` +a| `UnknownServer` |=== // end::enum_constants[] From fc6c5989ad14ce5eca59642026f953379b48cb33 Mon Sep 17 00:00:00 2001 From: Vladimir Izmalkov Date: Mon, 29 Apr 2024 11:45:13 +0100 Subject: [PATCH 2/2] Update after generator fixes --- .../ROOT/partials/c/answer/conceptmap.adoc | 2 +- .../ROOT/partials/c/answer/explanation.adoc | 2 +- .../ROOT/partials/c/answer/primitives.adoc | 2 +- .../ROOT/partials/c/answer/valuegroup.adoc | 2 +- .../ROOT/partials/c/concept/attribute.adoc | 2 +- .../ROOT/partials/c/concept/concept.adoc | 2 +- .../ROOT/partials/c/concept/entity.adoc | 2 +- .../ROOT/partials/c/concept/relation.adoc | 2 +- .../ROOT/partials/c/concept/roleplayer.adoc | 2 +- .../ROOT/partials/c/concept/thing.adoc | 2 +- .../ROOT/partials/c/concept/value.adoc | 2 +- .../partials/c/connection/connection.adoc | 2 +- .../partials/c/connection/credential.adoc | 2 +- .../ROOT/partials/c/connection/database.adoc | 2 +- .../ROOT/partials/c/connection/replica.adoc | 2 +- .../ROOT/partials/c/connection/user.adoc | 2 +- .../modules/ROOT/partials/c/errors/error.adoc | 2 +- .../partials/c/errors/schemaexception.adoc | 2 +- .../modules/ROOT/partials/c/logic/logic.adoc | 2 +- .../modules/ROOT/partials/c/logic/rule.adoc | 2 +- .../ROOT/partials/c/schema/annotation.adoc | 2 +- .../ROOT/partials/c/schema/attributetype.adoc | 2 +- .../ROOT/partials/c/schema/entitytype.adoc | 2 +- .../ROOT/partials/c/schema/relationtype.adoc | 2 +- .../ROOT/partials/c/schema/roletype.adoc | 2 +- .../ROOT/partials/c/schema/transitivity.adoc | 2 +- .../ROOT/partials/c/schema/valuetype.adoc | 20 +---- .../ROOT/partials/c/session/options.adoc | 2 +- .../ROOT/partials/c/session/session.adoc | 2 +- .../ROOT/partials/c/transaction/query.adoc | 2 +- .../partials/c/transaction/transaction.adoc | 2 +- .../ROOT/partials/cpp/answer/ConceptMap.adoc | 12 +-- .../partials/cpp/answer/ConceptMapGroup.adoc | 6 +- .../ROOT/partials/cpp/answer/Explainable.adoc | 4 +- .../partials/cpp/answer/Explainables.adoc | 14 ++-- .../ROOT/partials/cpp/answer/Explanation.adoc | 12 +-- .../ROOT/partials/cpp/answer/Future.adoc | 6 +- .../ROOT/partials/cpp/answer/Iterable.adoc | 10 +-- .../ROOT/partials/cpp/answer/Iterator.adoc | 2 +- .../ROOT/partials/cpp/answer/JSON.adoc | 30 ++++---- .../ROOT/partials/cpp/answer/ValueGroup.adoc | 6 +- .../ROOT/partials/cpp/answer/typedefs.adoc | 70 ++++++++--------- .../ROOT/partials/cpp/concept/Concept.adoc | 48 ++++++------ .../partials/cpp/concept/ConceptManager.adoc | 26 +++---- .../partials/cpp/connection/Credential.adoc | 2 +- .../partials/cpp/connection/Database.adoc | 16 ++-- .../cpp/connection/DatabaseManager.adoc | 8 +- .../ROOT/partials/cpp/connection/Driver.adoc | 14 ++-- .../partials/cpp/connection/ReplicaInfo.adoc | 8 +- .../ROOT/partials/cpp/connection/User.adoc | 6 +- .../partials/cpp/connection/UserManager.adoc | 12 +-- .../ROOT/partials/cpp/data/Attribute.adoc | 8 +- .../ROOT/partials/cpp/data/Entity.adoc | 2 +- .../ROOT/partials/cpp/data/Relation.adoc | 16 ++-- .../modules/ROOT/partials/cpp/data/Thing.adoc | 38 +++++----- .../modules/ROOT/partials/cpp/data/Value.adoc | 36 ++++----- .../partials/cpp/errors/DriverException.adoc | 4 +- .../ROOT/partials/cpp/logic/LogicManager.adoc | 6 +- .../modules/ROOT/partials/cpp/logic/Rule.adoc | 14 ++-- .../ROOT/partials/cpp/schema/Annotation.adoc | 10 +-- .../partials/cpp/schema/AttributeType.adoc | 46 +++++------ .../ROOT/partials/cpp/schema/EntityType.adoc | 8 +- .../partials/cpp/schema/RelationType.adoc | 32 ++++---- .../ROOT/partials/cpp/schema/RoleType.adoc | 32 ++++---- .../ROOT/partials/cpp/schema/ThingType.adoc | 76 +++++++++---------- .../ROOT/partials/cpp/schema/Type.adoc | 16 ++-- .../ROOT/partials/cpp/session/Options.adoc | 42 +++++----- .../ROOT/partials/cpp/session/Session.adoc | 14 ++-- .../cpp/transaction/QueryManager.adoc | 22 +++--- .../partials/cpp/transaction/Transaction.adoc | 14 ++-- 70 files changed, 405 insertions(+), 423 deletions(-) diff --git a/drivers-src/modules/ROOT/partials/c/answer/conceptmap.adoc b/drivers-src/modules/ROOT/partials/c/answer/conceptmap.adoc index d4b85d78a..7bcb453ca 100644 --- a/drivers-src/modules/ROOT/partials/c/answer/conceptmap.adoc +++ b/drivers-src/modules/ROOT/partials/c/answer/conceptmap.adoc @@ -1,4 +1,4 @@ -[#_methods__answer__conceptmap] +[#_methods_answer_conceptmap] === conceptmap [#_Struct_ConceptMap] diff --git a/drivers-src/modules/ROOT/partials/c/answer/explanation.adoc b/drivers-src/modules/ROOT/partials/c/answer/explanation.adoc index 00a1464b9..0cdd4a119 100644 --- a/drivers-src/modules/ROOT/partials/c/answer/explanation.adoc +++ b/drivers-src/modules/ROOT/partials/c/answer/explanation.adoc @@ -1,4 +1,4 @@ -[#_methods__answer__explanation] +[#_methods_answer_explanation] === explanation [#_Struct_Explainable] diff --git a/drivers-src/modules/ROOT/partials/c/answer/primitives.adoc b/drivers-src/modules/ROOT/partials/c/answer/primitives.adoc index a9ac0f4ca..12db2da22 100644 --- a/drivers-src/modules/ROOT/partials/c/answer/primitives.adoc +++ b/drivers-src/modules/ROOT/partials/c/answer/primitives.adoc @@ -1,4 +1,4 @@ -[#_methods__answer__primitives] +[#_methods_answer_primitives] === primitives [#_Struct_BoolPromise] diff --git a/drivers-src/modules/ROOT/partials/c/answer/valuegroup.adoc b/drivers-src/modules/ROOT/partials/c/answer/valuegroup.adoc index 4a06fe5c9..862f56949 100644 --- a/drivers-src/modules/ROOT/partials/c/answer/valuegroup.adoc +++ b/drivers-src/modules/ROOT/partials/c/answer/valuegroup.adoc @@ -1,4 +1,4 @@ -[#_methods__answer__valuegroup] +[#_methods_answer_valuegroup] === valuegroup [#_Struct_ValueGroup] diff --git a/drivers-src/modules/ROOT/partials/c/concept/attribute.adoc b/drivers-src/modules/ROOT/partials/c/concept/attribute.adoc index ee1c0e181..34848bca2 100644 --- a/drivers-src/modules/ROOT/partials/c/concept/attribute.adoc +++ b/drivers-src/modules/ROOT/partials/c/concept/attribute.adoc @@ -1,4 +1,4 @@ -[#_methods__concept__attribute] +[#_methods_concept_attribute] === attribute [#_attribute_get_owners] diff --git a/drivers-src/modules/ROOT/partials/c/concept/concept.adoc b/drivers-src/modules/ROOT/partials/c/concept/concept.adoc index 4b78d05a3..aa89b4e38 100644 --- a/drivers-src/modules/ROOT/partials/c/concept/concept.adoc +++ b/drivers-src/modules/ROOT/partials/c/concept/concept.adoc @@ -1,4 +1,4 @@ -[#_methods__concept__concept] +[#_methods_concept_concept] === concept [#_Struct_Concept] diff --git a/drivers-src/modules/ROOT/partials/c/concept/entity.adoc b/drivers-src/modules/ROOT/partials/c/concept/entity.adoc index 459987d90..d10ad1460 100644 --- a/drivers-src/modules/ROOT/partials/c/concept/entity.adoc +++ b/drivers-src/modules/ROOT/partials/c/concept/entity.adoc @@ -1,4 +1,4 @@ -[#_methods__concept__entity] +[#_methods_concept_entity] === entity [#_entity_get_type] diff --git a/drivers-src/modules/ROOT/partials/c/concept/relation.adoc b/drivers-src/modules/ROOT/partials/c/concept/relation.adoc index c040ecc73..ee6f912b5 100644 --- a/drivers-src/modules/ROOT/partials/c/concept/relation.adoc +++ b/drivers-src/modules/ROOT/partials/c/concept/relation.adoc @@ -1,4 +1,4 @@ -[#_methods__concept__relation] +[#_methods_concept_relation] === relation [#_relation_add_role_player] diff --git a/drivers-src/modules/ROOT/partials/c/concept/roleplayer.adoc b/drivers-src/modules/ROOT/partials/c/concept/roleplayer.adoc index a0347b9eb..9379c0bde 100644 --- a/drivers-src/modules/ROOT/partials/c/concept/roleplayer.adoc +++ b/drivers-src/modules/ROOT/partials/c/concept/roleplayer.adoc @@ -1,4 +1,4 @@ -[#_methods__concept__roleplayer] +[#_methods_concept_roleplayer] === roleplayer [#_Struct_RolePlayer] diff --git a/drivers-src/modules/ROOT/partials/c/concept/thing.adoc b/drivers-src/modules/ROOT/partials/c/concept/thing.adoc index 8164aac17..649925695 100644 --- a/drivers-src/modules/ROOT/partials/c/concept/thing.adoc +++ b/drivers-src/modules/ROOT/partials/c/concept/thing.adoc @@ -1,4 +1,4 @@ -[#_methods__concept__thing] +[#_methods_concept_thing] === thing [#_thing_delete] diff --git a/drivers-src/modules/ROOT/partials/c/concept/value.adoc b/drivers-src/modules/ROOT/partials/c/concept/value.adoc index d7144cfe4..de08b9be9 100644 --- a/drivers-src/modules/ROOT/partials/c/concept/value.adoc +++ b/drivers-src/modules/ROOT/partials/c/concept/value.adoc @@ -1,4 +1,4 @@ -[#_methods__concept__value] +[#_methods_concept_value] === value [#_value_get_boolean] diff --git a/drivers-src/modules/ROOT/partials/c/connection/connection.adoc b/drivers-src/modules/ROOT/partials/c/connection/connection.adoc index ad33acd5d..11d9d82b7 100644 --- a/drivers-src/modules/ROOT/partials/c/connection/connection.adoc +++ b/drivers-src/modules/ROOT/partials/c/connection/connection.adoc @@ -1,4 +1,4 @@ -[#_methods__connection__connection] +[#_methods_connection_connection] === connection [#_Struct_Connection] diff --git a/drivers-src/modules/ROOT/partials/c/connection/credential.adoc b/drivers-src/modules/ROOT/partials/c/connection/credential.adoc index a3dfd0812..cdce67588 100644 --- a/drivers-src/modules/ROOT/partials/c/connection/credential.adoc +++ b/drivers-src/modules/ROOT/partials/c/connection/credential.adoc @@ -1,4 +1,4 @@ -[#_methods__connection__credential] +[#_methods_connection_credential] === credential [#_Struct_Credential] diff --git a/drivers-src/modules/ROOT/partials/c/connection/database.adoc b/drivers-src/modules/ROOT/partials/c/connection/database.adoc index e8ef2b9f6..9a1b00412 100644 --- a/drivers-src/modules/ROOT/partials/c/connection/database.adoc +++ b/drivers-src/modules/ROOT/partials/c/connection/database.adoc @@ -1,4 +1,4 @@ -[#_methods__connection__database] +[#_methods_connection_database] === database [#_Struct_Database] diff --git a/drivers-src/modules/ROOT/partials/c/connection/replica.adoc b/drivers-src/modules/ROOT/partials/c/connection/replica.adoc index f93370f3a..47a743ec9 100644 --- a/drivers-src/modules/ROOT/partials/c/connection/replica.adoc +++ b/drivers-src/modules/ROOT/partials/c/connection/replica.adoc @@ -1,4 +1,4 @@ -[#_methods__connection__replica] +[#_methods_connection_replica] === replica [#_Struct_ReplicaInfo] diff --git a/drivers-src/modules/ROOT/partials/c/connection/user.adoc b/drivers-src/modules/ROOT/partials/c/connection/user.adoc index a295fb054..3381fb2c4 100644 --- a/drivers-src/modules/ROOT/partials/c/connection/user.adoc +++ b/drivers-src/modules/ROOT/partials/c/connection/user.adoc @@ -1,4 +1,4 @@ -[#_methods__connection__user] +[#_methods_connection_user] === user [#_Struct_User] diff --git a/drivers-src/modules/ROOT/partials/c/errors/error.adoc b/drivers-src/modules/ROOT/partials/c/errors/error.adoc index 5db98eaef..9071154e7 100644 --- a/drivers-src/modules/ROOT/partials/c/errors/error.adoc +++ b/drivers-src/modules/ROOT/partials/c/errors/error.adoc @@ -1,4 +1,4 @@ -[#_methods__errors__error] +[#_methods_errors_error] === error [#_Struct_Error] diff --git a/drivers-src/modules/ROOT/partials/c/errors/schemaexception.adoc b/drivers-src/modules/ROOT/partials/c/errors/schemaexception.adoc index d831d4c30..beafeb3f2 100644 --- a/drivers-src/modules/ROOT/partials/c/errors/schemaexception.adoc +++ b/drivers-src/modules/ROOT/partials/c/errors/schemaexception.adoc @@ -1,4 +1,4 @@ -[#_methods__errors__schemaexception] +[#_methods_errors_schemaexception] === schemaexception [#_Struct_SchemaException] diff --git a/drivers-src/modules/ROOT/partials/c/logic/logic.adoc b/drivers-src/modules/ROOT/partials/c/logic/logic.adoc index ac6ef7600..687bdf8d7 100644 --- a/drivers-src/modules/ROOT/partials/c/logic/logic.adoc +++ b/drivers-src/modules/ROOT/partials/c/logic/logic.adoc @@ -1,4 +1,4 @@ -[#_methods__logic__logic] +[#_methods_logic_logic] === logic [#_logic_manager_get_rule] diff --git a/drivers-src/modules/ROOT/partials/c/logic/rule.adoc b/drivers-src/modules/ROOT/partials/c/logic/rule.adoc index b5cb6fadc..3e1463db2 100644 --- a/drivers-src/modules/ROOT/partials/c/logic/rule.adoc +++ b/drivers-src/modules/ROOT/partials/c/logic/rule.adoc @@ -1,4 +1,4 @@ -[#_methods__logic__rule] +[#_methods_logic_rule] === rule [#_Struct_Rule] diff --git a/drivers-src/modules/ROOT/partials/c/schema/annotation.adoc b/drivers-src/modules/ROOT/partials/c/schema/annotation.adoc index e1f53b897..450f5a7ee 100644 --- a/drivers-src/modules/ROOT/partials/c/schema/annotation.adoc +++ b/drivers-src/modules/ROOT/partials/c/schema/annotation.adoc @@ -1,4 +1,4 @@ -[#_methods__schema__annotation] +[#_methods_schema_annotation] === annotation [#_Struct_Annotation] diff --git a/drivers-src/modules/ROOT/partials/c/schema/attributetype.adoc b/drivers-src/modules/ROOT/partials/c/schema/attributetype.adoc index 618c58556..59b4c65ba 100644 --- a/drivers-src/modules/ROOT/partials/c/schema/attributetype.adoc +++ b/drivers-src/modules/ROOT/partials/c/schema/attributetype.adoc @@ -1,4 +1,4 @@ -[#_methods__schema__attributetype] +[#_methods_schema_attributetype] === attributetype [#_attribute_type_get] diff --git a/drivers-src/modules/ROOT/partials/c/schema/entitytype.adoc b/drivers-src/modules/ROOT/partials/c/schema/entitytype.adoc index b1c668765..c8ac5fe1f 100644 --- a/drivers-src/modules/ROOT/partials/c/schema/entitytype.adoc +++ b/drivers-src/modules/ROOT/partials/c/schema/entitytype.adoc @@ -1,4 +1,4 @@ -[#_methods__schema__entitytype] +[#_methods_schema_entitytype] === entitytype [#_entity_type_create] diff --git a/drivers-src/modules/ROOT/partials/c/schema/relationtype.adoc b/drivers-src/modules/ROOT/partials/c/schema/relationtype.adoc index 53db5c5f8..fe095832b 100644 --- a/drivers-src/modules/ROOT/partials/c/schema/relationtype.adoc +++ b/drivers-src/modules/ROOT/partials/c/schema/relationtype.adoc @@ -1,4 +1,4 @@ -[#_methods__schema__relationtype] +[#_methods_schema_relationtype] === relationtype [#_relation_type_create] diff --git a/drivers-src/modules/ROOT/partials/c/schema/roletype.adoc b/drivers-src/modules/ROOT/partials/c/schema/roletype.adoc index 154d3941b..d596752ea 100644 --- a/drivers-src/modules/ROOT/partials/c/schema/roletype.adoc +++ b/drivers-src/modules/ROOT/partials/c/schema/roletype.adoc @@ -1,4 +1,4 @@ -[#_methods__schema__roletype] +[#_methods_schema_roletype] === roletype [#_role_type_delete] diff --git a/drivers-src/modules/ROOT/partials/c/schema/transitivity.adoc b/drivers-src/modules/ROOT/partials/c/schema/transitivity.adoc index 4eb18a8e1..864f23f12 100644 --- a/drivers-src/modules/ROOT/partials/c/schema/transitivity.adoc +++ b/drivers-src/modules/ROOT/partials/c/schema/transitivity.adoc @@ -1,4 +1,4 @@ -[#_methods__schema__transitivity] +[#_methods_schema_transitivity] === transitivity [#_Struct_Transitivity] diff --git a/drivers-src/modules/ROOT/partials/c/schema/valuetype.adoc b/drivers-src/modules/ROOT/partials/c/schema/valuetype.adoc index cb6ebfe27..8f53b1d00 100644 --- a/drivers-src/modules/ROOT/partials/c/schema/valuetype.adoc +++ b/drivers-src/modules/ROOT/partials/c/schema/valuetype.adoc @@ -1,4 +1,4 @@ -[#_methods__schema__valuetype] +[#_methods_schema_valuetype] === valuetype [#_Struct_ValueType] @@ -31,21 +31,3 @@ a| `String` |=== // end::enum_constants[] -[#_Enum_ValueType] -==== Enum ValueType - - - -Retrieves the ``ValueType`` of this ``AttributeType``. - -[caption=""] -.Enum constants -// tag::enum_constants[] -[cols=""] -[options="header"] -|=== -|Name -a| `attribute_type_get_value_type (const struct Concept *attribute_type)` -|=== -// end::enum_constants[] - diff --git a/drivers-src/modules/ROOT/partials/c/session/options.adoc b/drivers-src/modules/ROOT/partials/c/session/options.adoc index e3d961d7e..91923d882 100644 --- a/drivers-src/modules/ROOT/partials/c/session/options.adoc +++ b/drivers-src/modules/ROOT/partials/c/session/options.adoc @@ -1,4 +1,4 @@ -[#_methods__session__options] +[#_methods_session_options] === options [#_Struct_Options] diff --git a/drivers-src/modules/ROOT/partials/c/session/session.adoc b/drivers-src/modules/ROOT/partials/c/session/session.adoc index eff3db292..e2bc48dcb 100644 --- a/drivers-src/modules/ROOT/partials/c/session/session.adoc +++ b/drivers-src/modules/ROOT/partials/c/session/session.adoc @@ -1,4 +1,4 @@ -[#_methods__session__session] +[#_methods_session_session] === session [#_Struct_Session] diff --git a/drivers-src/modules/ROOT/partials/c/transaction/query.adoc b/drivers-src/modules/ROOT/partials/c/transaction/query.adoc index 463d5dd93..d0c0a54a6 100644 --- a/drivers-src/modules/ROOT/partials/c/transaction/query.adoc +++ b/drivers-src/modules/ROOT/partials/c/transaction/query.adoc @@ -1,4 +1,4 @@ -[#_methods__transaction__query] +[#_methods_transaction_query] === query [#_query_define] diff --git a/drivers-src/modules/ROOT/partials/c/transaction/transaction.adoc b/drivers-src/modules/ROOT/partials/c/transaction/transaction.adoc index fbb3e2960..54354e6b0 100644 --- a/drivers-src/modules/ROOT/partials/c/transaction/transaction.adoc +++ b/drivers-src/modules/ROOT/partials/c/transaction/transaction.adoc @@ -1,4 +1,4 @@ -[#_methods__transaction__transaction] +[#_methods_transaction_transaction] === transaction [#_Struct_Transaction] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/ConceptMap.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/ConceptMap.adoc index 56c7b1a1e..1a1b92f04 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/ConceptMap.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/ConceptMap.adoc @@ -8,7 +8,7 @@ Contains a mapping of variables to concepts. // tag::methods[] -[#_ConceptIterable__Concept___TypeDBConceptMapconcepts___] +[#_ConceptIterable_Concept_TypeDBConceptMapconcepts_] ==== concepts [source,cpp] @@ -32,7 +32,7 @@ Produces an ``Iterator`` over all concepts in this ``ConceptMap``. conceptMap.concepts(); ---- -[#_Explainables_TypeDBConceptMapexplainables___] +[#_Explainables_TypeDBConceptMapexplainables_] ==== explainables [source,cpp] @@ -56,7 +56,7 @@ Gets the ``Explainables`` object for this ``ConceptMap``, exposing which of the conceptMap.explainables(); ---- -[#_stdunique_ptr__Concept___TypeDBConceptMapget___const_stdstring__variableName_] +[#_stdunique_ptr_Concept_TypeDBConceptMapget_const_stdstring_variableName_] ==== get [source,cpp] @@ -89,7 +89,7 @@ a| `variable` a| The string representation of a variable a| conceptMap.get(variable); ---- -[#_stdmap__stdstring__stdunique_ptr__Concept_____TypeDBConceptMapmap___] +[#_stdmap_stdstring_stdunique_ptr_Concept_TypeDBConceptMapmap_] ==== map [source,cpp] @@ -113,7 +113,7 @@ Returns the inner ``Map`` where keys are query variables, and values are concept conceptMap.map(); ---- -[#_stdstring_TypeDBConceptMaptoString___] +[#_stdstring_TypeDBConceptMaptoString_] ==== toString [source,cpp] @@ -129,7 +129,7 @@ A string representation of this ConceptMap. .Returns `std::string` -[#_StringIterable_TypeDBConceptMapvariables___] +[#_StringIterable_TypeDBConceptMapvariables_] ==== variables [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/ConceptMapGroup.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/ConceptMapGroup.adoc index e440dda03..d3cce09bb 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/ConceptMapGroup.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/ConceptMapGroup.adoc @@ -8,7 +8,7 @@ Contains an element of the group query result. // tag::methods[] -[#_ConceptMapIterable_TypeDBConceptMapGroupconceptMaps___] +[#_ConceptMapIterable_TypeDBConceptMapGroupconceptMaps_] ==== conceptMaps [source,cpp] @@ -32,7 +32,7 @@ Retrieves the ``ConceptMap``s of the group. conceptMapGroup.conceptMaps(); ---- -[#_stdunique_ptr__Concept___TypeDBConceptMapGroupowner___] +[#_stdunique_ptr_Concept_TypeDBConceptMapGroupowner_] ==== owner [source,cpp] @@ -56,7 +56,7 @@ Retrieves the concept that is the group owner. conceptMapGroup.owner(); ---- -[#_stdstring_TypeDBConceptMapGrouptoString___] +[#_stdstring_TypeDBConceptMapGrouptoString_] ==== toString [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/Explainable.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/Explainable.adoc index e41c18747..a8d7da749 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/Explainable.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/Explainable.adoc @@ -8,7 +8,7 @@ Contains an explainable object. // tag::methods[] -[#_stdstring_TypeDBExplainableconjunction___] +[#_stdstring_TypeDBExplainableconjunction_] ==== conjunction [source,cpp] @@ -32,7 +32,7 @@ Retrieves the subquery of the original query that is actually being explained. explainable.conjunction(); ---- -[#_int64_t_TypeDBExplainableexplainableId___] +[#_int64_t_TypeDBExplainableexplainableId_] ==== explainableId [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/Explainables.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/Explainables.adoc index eeac15a81..7f7fcecef 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/Explainables.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/Explainables.adoc @@ -8,7 +8,7 @@ Contains explainable objects. // tag::methods[] -[#_Explainable_TypeDBExplainablesattribute___stdstring__variable_] +[#_Explainable_TypeDBExplainablesattribute_stdstring_variable_] ==== attribute [source,cpp] @@ -41,7 +41,7 @@ a| `variable` a| The string representation of a variable a| `std::string&` conceptMap.explainables().attribute(variable); ---- -[#_StringIterable_TypeDBExplainablesattributes___] +[#_StringIterable_TypeDBExplainablesattributes_] ==== attributes [source,cpp] @@ -65,7 +65,7 @@ Retrieves all of this ``ConceptMap``’s explainable attributes. conceptMap.explainables().attributes(); ---- -[#_Explainable_TypeDBExplainablesownership___stdstring__owner__stdstring__attribute_] +[#_Explainable_TypeDBExplainablesownership_stdstring_owner_stdstring_attribute_] ==== ownership [source,cpp] @@ -99,7 +99,7 @@ a| `attribute` a| The string representation of the attribute variable a| `std::s conceptMap.explainables().ownership(owner, attribute); ---- -[#_OwnerAttributePairIterable_TypeDBExplainablesownerships___] +[#_OwnerAttributePairIterable_TypeDBExplainablesownerships_] ==== ownerships [source,cpp] @@ -123,7 +123,7 @@ Retrieves all of this ``ConceptMap``’s explainable ownerships. conceptMap.explainables().ownerships(); ---- -[#_Explainable_TypeDBExplainablesrelation___stdstring__variable_] +[#_Explainable_TypeDBExplainablesrelation_stdstring_variable_] ==== relation [source,cpp] @@ -156,7 +156,7 @@ a| `variable` a| The string representation of a variable a| `std::string&` conceptMap.explainables().relation(variable); ---- -[#_StringIterable_TypeDBExplainablesrelations___] +[#_StringIterable_TypeDBExplainablesrelations_] ==== relations [source,cpp] @@ -180,7 +180,7 @@ Retrieves all of this ``ConceptMap``’s explainable relations. conceptMap.explainables().relations(); ---- -[#_stdstring_TypeDBExplainablestoString___] +[#_stdstring_TypeDBExplainablestoString_] ==== toString [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/Explanation.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/Explanation.adoc index 035a3aeef..c1420814d 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/Explanation.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/Explanation.adoc @@ -10,7 +10,7 @@ An explanation of which rule was used to infer the concept and the satisfying Co 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. // tag::methods[] -[#_ConceptMap_TypeDBExplanationconclusion___] +[#_ConceptMap_TypeDBExplanationconclusion_] ==== conclusion [source,cpp] @@ -34,7 +34,7 @@ Retrieves the Conclusion for this Explanation. explanation.conclusion() ---- -[#_ConceptMap_TypeDBExplanationcondition___] +[#_ConceptMap_TypeDBExplanationcondition_] ==== condition [source,cpp] @@ -58,7 +58,7 @@ Retrieves the Condition for this Explanation. explanation.condition() ---- -[#_stdvector__stdstring___TypeDBExplanationqueryVariableMapping___const_stdstring__var_] +[#_stdvector_stdstring_TypeDBExplanationqueryVariableMapping_const_stdstring_var_] ==== queryVariableMapping [source,cpp] @@ -91,7 +91,7 @@ a| `var` a| The query variable to map to rule variables. a| `const std::string&` explanation.variableMapping(var) ---- -[#_stdvector__stdstring___TypeDBExplanationqueryVariables___] +[#_stdvector_stdstring_TypeDBExplanationqueryVariables_] ==== queryVariables [source,cpp] @@ -115,7 +115,7 @@ Retrieves the query variables for this ``Explanation``. explanation.queryVariables() ---- -[#_Rule_TypeDBExplanationrule___] +[#_Rule_TypeDBExplanationrule_] ==== rule [source,cpp] @@ -139,7 +139,7 @@ Retrieves the Rule for this Explanation. explanation.rule() ---- -[#_stdstring_TypeDBExplanationtoString___] +[#_stdstring_TypeDBExplanationtoString_] ==== toString [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/Future.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/Future.adoc index 136f02942..19e027ebb 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/Future.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/Future.adoc @@ -1,5 +1,5 @@ [#_Future] -=== Future< RETURN, NATIVE_PROMISE, HELPER > +=== Future *Package*: `TypeDB` @@ -10,7 +10,7 @@ A structure emulating std::future, used as result of an asynchronous call to the Note that a future must be evaluated for any server-side exceptions to be raised. // tag::methods[] -[#_RETURN_TypeDBFuture__RETURN__NATIVE_PROMISE__HELPER__get___] +[#_RETURN_TypeDBFuture_RETURN_NATIVE_PROMISE_HELPER_get_] ==== get [source,cpp] @@ -26,7 +26,7 @@ Waits for the call to complete and returns the result. .Returns `RETURN` -[#_void_TypeDBFuture__RETURN__NATIVE_PROMISE__HELPER__wait___] +[#_void_TypeDBFuture_RETURN_NATIVE_PROMISE_HELPER_wait_] ==== wait [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/Iterable.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/Iterable.adoc index 150e69a3d..d70dcbd07 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/Iterable.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/Iterable.adoc @@ -1,5 +1,5 @@ [#_Iterable] -=== Iterable< NATIVE_ITER, NATIVE_T, T, HELPER > +=== Iterable *Package*: `TypeDB` @@ -7,8 +7,8 @@ Result representing a stream of query results. -Exposes ``<<#_ITERATOR_TypeDBIterable__NATIVE_ITER__NATIVE_T__T__HELPER__begin___,begin()>>`` to get an iterator over the results and ``<<#_ITERATOR_TypeDBIterable__NATIVE_ITER__NATIVE_T__T__HELPER__end___,end()>>`` to check if the end has been reached. - Note: <<#_ITERATOR_TypeDBIterable__NATIVE_ITER__NATIVE_T__T__HELPER__begin___,begin()>> must be called for any server-side exceptions encountered while evaluating the query to be thrown +Exposes ``<<#_ITERATOR_TypeDBIterable_NATIVE_ITER_NATIVE_T_T_HELPER_begin_,begin()>>`` to get an iterator over the results and ``<<#_ITERATOR_TypeDBIterable_NATIVE_ITER_NATIVE_T_T_HELPER_end_,end()>>`` to check if the end has been reached. + Note: <<#_ITERATOR_TypeDBIterable_NATIVE_ITER_NATIVE_T_T_HELPER_begin_,begin()>> must be called for any server-side exceptions encountered while evaluating the query to be thrown [caption=""] @@ -20,7 +20,7 @@ for (auto it = iterable.begin(); it != iterable.end(); ++it ) { ... } // Note: i ---- // tag::methods[] -[#_ITERATOR_TypeDBIterable__NATIVE_ITER__NATIVE_T__T__HELPER__begin___] +[#_ITERATOR_TypeDBIterable_NATIVE_ITER_NATIVE_T_T_HELPER_begin_] ==== begin [source,cpp] @@ -36,7 +36,7 @@ Returns an iterator pointing to the first element. .Returns `ITERATOR` -[#_ITERATOR_TypeDBIterable__NATIVE_ITER__NATIVE_T__T__HELPER__end___] +[#_ITERATOR_TypeDBIterable_NATIVE_ITER_NATIVE_T_T_HELPER_end_] ==== end [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/Iterator.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/Iterator.adoc index af1407fe5..ea160d78e 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/Iterator.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/Iterator.adoc @@ -1,5 +1,5 @@ [#_Iterator] -=== Iterator< NATIVE_ITER, NATIVE_T, T, HELPER > +=== Iterator *Package*: `TypeDB` diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/JSON.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/JSON.adoc index f184b9d22..3ef7a0409 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/JSON.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/JSON.adoc @@ -8,7 +8,7 @@ Simple JSON structure for results of fetch queries. // tag::methods[] -[#_const_JSONArray__TypeDBJSONasArray_____const] +[#_const_JSONArray_TypeDBJSONasArray_const] ==== asArray [source,cpp] @@ -24,7 +24,7 @@ if this JSON object holds an array, returns the underlying array. Else throws an .Returns `const JSONArray&` -[#_const_JSONBoolean__TypeDBJSONasBoolean_____const] +[#_const_JSONBoolean_TypeDBJSONasBoolean_const] ==== asBoolean [source,cpp] @@ -40,7 +40,7 @@ if this JSON object holds a boolean value, returns the value. Else throws an exc .Returns `const JSONBoolean&` -[#_const_JSONDouble__TypeDBJSONasDouble_____const] +[#_const_JSONDouble_TypeDBJSONasDouble_const] ==== asDouble [source,cpp] @@ -56,7 +56,7 @@ if this JSON object holds a double value, returns the value. Else throws an exce .Returns `const JSONDouble&` -[#_const_JSONLong__TypeDBJSONasLong_____const] +[#_const_JSONLong_TypeDBJSONasLong_const] ==== asLong [source,cpp] @@ -72,7 +72,7 @@ if this JSON object holds a long value, returns the value. Else throws an except .Returns `const JSONLong&` -[#_const_JSONMap__TypeDBJSONasMap_____const] +[#_const_JSONMap_TypeDBJSONasMap_const] ==== asMap [source,cpp] @@ -88,7 +88,7 @@ if this JSON object holds a map, returns the underlying map. Else throws an exce .Returns `const JSONMap&` -[#_const_JSONString__TypeDBJSONasString_____const] +[#_const_JSONString_TypeDBJSONasString_const] ==== asString [source,cpp] @@ -104,7 +104,7 @@ if this JSON object holds a string value, returns the value. Else throws an exce .Returns `const JSONString&` -[#_bool_TypeDBJSONisArray_____const] +[#_bool_TypeDBJSONisArray_const] ==== isArray [source,cpp] @@ -120,7 +120,7 @@ true if this JSON object holds an array, else false .Returns `bool` -[#_bool_TypeDBJSONisBoolean_____const] +[#_bool_TypeDBJSONisBoolean_const] ==== isBoolean [source,cpp] @@ -136,7 +136,7 @@ true if this JSON object holds a boolean value, else false .Returns `bool` -[#_bool_TypeDBJSONisDouble_____const] +[#_bool_TypeDBJSONisDouble_const] ==== isDouble [source,cpp] @@ -152,7 +152,7 @@ true if this JSON object holds a double value, else false .Returns `bool` -[#_bool_TypeDBJSONisLong_____const] +[#_bool_TypeDBJSONisLong_const] ==== isLong [source,cpp] @@ -168,7 +168,7 @@ true if this JSON object holds a long value, else false .Returns `bool` -[#_bool_TypeDBJSONisMap_____const] +[#_bool_TypeDBJSONisMap_const] ==== isMap [source,cpp] @@ -184,7 +184,7 @@ true if this JSON object holds a map, else false .Returns `bool` -[#_bool_TypeDBJSONisString_____const] +[#_bool_TypeDBJSONisString_const] ==== isString [source,cpp] @@ -200,7 +200,7 @@ true if this JSON object holds a string value, else false .Returns `bool` -[#_static_JSON_TypeDBJSONparse___const_stdstring__string_] +[#_static_JSON_TypeDBJSONparse_const_stdstring_string_] ==== parse [source,cpp] @@ -216,7 +216,7 @@ Parses a JSON string into a ``JSON`` object. .Returns `static JSON` -[#_const_stdstring_TypeDBJSONtoString_____const] +[#_const_stdstring_TypeDBJSONtoString_const] ==== toString [source,cpp] @@ -232,7 +232,7 @@ Convert a JSON object to a string .Returns `const std::string` -[#_JSONType_TypeDBJSONtype_____const] +[#_JSONType_TypeDBJSONtype_const] ==== type [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/ValueGroup.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/ValueGroup.adoc index bd8829b44..81f386e2f 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/ValueGroup.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/ValueGroup.adoc @@ -8,7 +8,7 @@ Contains an element of the group aggregate query result. // tag::methods[] -[#_stdunique_ptr__Concept___TypeDBValueGroupowner___] +[#_stdunique_ptr_Concept_TypeDBValueGroupowner_] ==== owner [source,cpp] @@ -32,7 +32,7 @@ Retrieves the concept that is the group owner. conceptMapGroup.owner() ---- -[#_stdstring_TypeDBValueGrouptoString___] +[#_stdstring_TypeDBValueGrouptoString_] ==== toString [source,cpp] @@ -48,7 +48,7 @@ A string representation of this ConceptMap. .Returns `std::string` -[#_AggregateResult_TypeDBValueGroupvalue___] +[#_AggregateResult_TypeDBValueGroupvalue_] ==== value [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/answer/typedefs.adoc b/drivers-src/modules/ROOT/partials/cpp/answer/typedefs.adoc index 4469300ec..c803cae2c 100644 --- a/drivers-src/modules/ROOT/partials/cpp/answer/typedefs.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/answer/typedefs.adoc @@ -4,112 +4,112 @@ [#_ConceptMapIterator] ==== ConceptMapIterator -Alias for Iterator<_native::ConceptMapIterator, _native::ConceptMap, TypeDB::ConceptMap> +Alias for ``Iterator<_native::ConceptMapIterator, _native::ConceptMap, TypeDB::ConceptMap>`` [#_ConceptMapIterable] ==== ConceptMapIterable -Alias for Iterable<_native::ConceptMapIterator, _native::ConceptMap, TypeDB::ConceptMap> +Alias for ``Iterable<_native::ConceptMapIterator, _native::ConceptMap, TypeDB::ConceptMap>`` [#_ConceptMapGroupIterable] ==== ConceptMapGroupIterable -Alias for Iterable<_native::ConceptMapGroupIterator, _native::ConceptMapGroup, TypeDB::ConceptMapGroup> +Alias for ``Iterable<_native::ConceptMapGroupIterator, _native::ConceptMapGroup, TypeDB::ConceptMapGroup>`` [#_ConceptMapGroupIterator] ==== ConceptMapGroupIterator -Alias for Iterator<_native::ConceptMapGroupIterator, _native::ConceptMapGroup, TypeDB::ConceptMapGroup> +Alias for ``Iterator<_native::ConceptMapGroupIterator, _native::ConceptMapGroup, TypeDB::ConceptMapGroup>`` [#_OwnerAttributePairIterator] ==== OwnerAttributePairIterator -Alias for Iterator<_native::StringPairIterator, _native::StringPair, OwnerAttributePair> +Alias for ``Iterator<_native::StringPairIterator, _native::StringPair, OwnerAttributePair>`` [#_OwnerAttributePairIterable] ==== OwnerAttributePairIterable -Alias for Iterable<_native::StringPairIterator, _native::StringPair, OwnerAttributePair> +Alias for ``Iterable<_native::StringPairIterator, _native::StringPair, OwnerAttributePair>`` [#_JSONMap] ==== JSONMap -Alias for std::map +Alias for ``std::map`` [#_JSONArray] ==== JSONArray -Alias for std::vector +Alias for ``std::vector`` [#_JSONBoolean] ==== JSONBoolean -Alias for bool +Alias for ``bool`` [#_JSONLong] ==== JSONLong -Alias for long +Alias for ``long`` [#_JSONDouble] ==== JSONDouble -Alias for double +Alias for ``double`` [#_JSONString] ==== JSONString -Alias for std::string +Alias for ``std::string`` [#_AggregateResult] ==== AggregateResult -Alias for std::optional> +Alias for ``std::optional>`` [#_AggregateFuture] ==== AggregateFuture -Alias for Future +Alias for ``Future`` [#_ValueGroupIterable] ==== ValueGroupIterable -Alias for Iterable<_native::ValueGroupIterator, _native::ValueGroup, TypeDB::ValueGroup> +Alias for ``Iterable<_native::ValueGroupIterator, _native::ValueGroup, TypeDB::ValueGroup>`` [#_ValueGroupIterator] ==== ValueGroupIterator -Alias for Iterator<_native::ValueGroupIterator, _native::ValueGroup, TypeDB::ValueGroup> +Alias for ``Iterator<_native::ValueGroupIterator, _native::ValueGroup, TypeDB::ValueGroup>`` [#_VoidFuture] ==== VoidFuture -Alias for Future +Alias for ``Future`` [#_BoolFuture] ==== BoolFuture -Alias for Future +Alias for ``Future`` [#_StringFuture] ==== StringFuture -Alias for Future +Alias for ``Future`` [#_OptionalStringFuture] ==== OptionalStringFuture -Alias for Future, _native::StringPromise> +Alias for ``Future, _native::StringPromise>`` [#_StringIterable] ==== StringIterable -Alias for Iterable<_native::StringIterator, char, std::string> +Alias for ``Iterable<_native::StringIterator, char, std::string>`` [#_StringIterator] ==== StringIterator -Alias for Iterator<_native::StringIterator, char, std::string> +Alias for ``Iterator<_native::StringIterator, char, std::string>`` [#_DateTime] ==== DateTime @@ -119,65 +119,65 @@ Alias for std::chrono::time_point +Alias for ``Iterator<_native::DatabaseIterator, _native::Database, TypeDB::Database>`` [#_DatabaseIterable] ==== DatabaseIterable -Alias for Iterable<_native::DatabaseIterator, _native::Database, TypeDB::Database> +Alias for ``Iterable<_native::DatabaseIterator, _native::Database, TypeDB::Database>`` [#_ReplicaInfoIterable] ==== ReplicaInfoIterable -Alias for Iterable<_native::ReplicaInfoIterator, _native::ReplicaInfo, ReplicaInfo> +Alias for ``Iterable<_native::ReplicaInfoIterator, _native::ReplicaInfo, ReplicaInfo>`` [#_ReplicaInfoIterator] ==== ReplicaInfoIterator -Alias for Iterator<_native::ReplicaInfoIterator, _native::ReplicaInfo, ReplicaInfo> +Alias for ``Iterator<_native::ReplicaInfoIterator, _native::ReplicaInfo, ReplicaInfo>`` [#_ExplanationIterator] ==== ExplanationIterator -Alias for Iterator<_native::ExplanationIterator, _native::Explanation, Explanation> +Alias for ``Iterator<_native::ExplanationIterator, _native::Explanation, Explanation>`` [#_ExplanationIterable] ==== ExplanationIterable -Alias for Iterable<_native::ExplanationIterator, _native::Explanation, Explanation> +Alias for ``Iterable<_native::ExplanationIterator, _native::Explanation, Explanation>`` [#_RuleFuture] ==== RuleFuture -Alias for Future +Alias for ``Future`` [#_OptionalRuleFuture] ==== OptionalRuleFuture -Alias for Future, _native::RulePromise> +Alias for ``Future, _native::RulePromise>`` [#_RuleIterable] ==== RuleIterable -Alias for Iterable<_native::RuleIterator, _native::Rule, Rule> +Alias for ``Iterable<_native::RuleIterator, _native::Rule, Rule>`` [#_RuleIterator] ==== RuleIterator -Alias for Iterator<_native::RuleIterator, _native::Rule, Rule> +Alias for ``Iterator<_native::RuleIterator, _native::Rule, Rule>`` [#_JSONIterable] ==== JSONIterable -Alias for Iterable<_native::StringIterator, char, JSON> +Alias for ``Iterable<_native::StringIterator, char, JSON>`` [#_UserIterator] ==== UserIterator -Alias for Iterator<_native::UserIterator, _native::User, User> +Alias for ``Iterator<_native::UserIterator, _native::User, User>`` [#_UserIterable] ==== UserIterable -Alias for Iterable<_native::UserIterator, _native::User, User> +Alias for ``Iterable<_native::UserIterator, _native::User, User>`` diff --git a/drivers-src/modules/ROOT/partials/cpp/concept/Concept.adoc b/drivers-src/modules/ROOT/partials/cpp/concept/Concept.adoc index f6454c792..5ac39ae41 100644 --- a/drivers-src/modules/ROOT/partials/cpp/concept/Concept.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/concept/Concept.adoc @@ -8,7 +8,7 @@ The fundamental TypeQL object. A Concept is either a Type, Thing, or Value. // tag::methods[] -[#_Attribute__ptr__TypeDBConceptasAttribute___] +[#_Attribute_ptr_TypeDBConceptasAttribute_] ==== asAttribute [source,cpp] @@ -32,7 +32,7 @@ Casts the concept to ``Attribute``. concept.asAttribute(); ---- -[#_AttributeType__ptr__TypeDBConceptasAttributeType___] +[#_AttributeType_ptr_TypeDBConceptasAttributeType_] ==== asAttributeType [source,cpp] @@ -56,7 +56,7 @@ Casts the concept to ``EntityType``. concept.asEntityType(); ---- -[#_Entity__ptr__TypeDBConceptasEntity___] +[#_Entity_ptr_TypeDBConceptasEntity_] ==== asEntity [source,cpp] @@ -80,7 +80,7 @@ Casts the concept to ``Entity``. concept.asEntity(); ---- -[#_EntityType__ptr__TypeDBConceptasEntityType___] +[#_EntityType_ptr_TypeDBConceptasEntityType_] ==== asEntityType [source,cpp] @@ -104,7 +104,7 @@ Casts the concept to ``EntityType``. concept.asEntityType(); ---- -[#_Relation__ptr__TypeDBConceptasRelation___] +[#_Relation_ptr_TypeDBConceptasRelation_] ==== asRelation [source,cpp] @@ -128,7 +128,7 @@ Casts the concept to ``Relation``. concept.asRelation(); ---- -[#_RelationType__ptr__TypeDBConceptasRelationType___] +[#_RelationType_ptr_TypeDBConceptasRelationType_] ==== asRelationType [source,cpp] @@ -152,7 +152,7 @@ Casts the concept to ``RelationType``. concept.asRelationType(); ---- -[#_RoleType__ptr__TypeDBConceptasRoleType___] +[#_RoleType_ptr_TypeDBConceptasRoleType_] ==== asRoleType [source,cpp] @@ -176,7 +176,7 @@ Casts the concept to ``RoleType``. concept.asRoleType(); ---- -[#_Thing__ptr__TypeDBConceptasThing___] +[#_Thing_ptr_TypeDBConceptasThing_] ==== asThing [source,cpp] @@ -200,7 +200,7 @@ Casts the concept to ``Thing``. concept.asThing(); ---- -[#_ThingType__ptr__TypeDBConceptasThingType___] +[#_ThingType_ptr_TypeDBConceptasThingType_] ==== asThingType [source,cpp] @@ -224,7 +224,7 @@ Casts the concept to ``ThingType``. concept.asThingType(); ---- -[#_Value__ptr__TypeDBConceptasValue___] +[#_Value_ptr_TypeDBConceptasValue_] ==== asValue [source,cpp] @@ -248,7 +248,7 @@ Casts the concept to ``Value``. concept.asValue(); ---- -[#_static_bool_TypeDBConceptequals___Concept__ptr__first__Concept__ptr__second_] +[#_static_bool_TypeDBConceptequals_Concept_ptr_first_Concept_ptr_second_] ==== equals [source,cpp] @@ -264,7 +264,7 @@ Checks equality of two concepts. .Returns `static bool` -[#_ConceptType_TypeDBConceptgetConceptType___] +[#_ConceptType_TypeDBConceptgetConceptType_] ==== getConceptType [source,cpp] @@ -288,7 +288,7 @@ Returns the ConceptType of this concept. switch(concept.getConceptType()) { ... } ---- -[#_bool_TypeDBConceptisAttribute___] +[#_bool_TypeDBConceptisAttribute_] ==== isAttribute [source,cpp] @@ -312,7 +312,7 @@ Checks if the concept is a ``Relation``. concept.isRelation(); ---- -[#_bool_TypeDBConceptisAttributeType___] +[#_bool_TypeDBConceptisAttributeType_] ==== isAttributeType [source,cpp] @@ -336,7 +336,7 @@ Checks if the concept is an ``AttributeType``. concept.isAttributeType(); ---- -[#_bool_TypeDBConceptisEntity___] +[#_bool_TypeDBConceptisEntity_] ==== isEntity [source,cpp] @@ -360,7 +360,7 @@ Checks if the concept is an ``Entity``. concept.isEntity(); ---- -[#_bool_TypeDBConceptisEntityType___] +[#_bool_TypeDBConceptisEntityType_] ==== isEntityType [source,cpp] @@ -384,7 +384,7 @@ Checks if the concept is an ``EntityType``. concept.isEntityType(); ---- -[#_bool_TypeDBConceptisRelation___] +[#_bool_TypeDBConceptisRelation_] ==== isRelation [source,cpp] @@ -408,7 +408,7 @@ Checks if the concept is a ``Value``. concept.isValue(); ---- -[#_bool_TypeDBConceptisRelationType___] +[#_bool_TypeDBConceptisRelationType_] ==== isRelationType [source,cpp] @@ -432,7 +432,7 @@ Checks if the concept is a ``RelationType``. concept.isRelationType(); ---- -[#_bool_TypeDBConceptisRoleType___] +[#_bool_TypeDBConceptisRoleType_] ==== isRoleType [source,cpp] @@ -456,7 +456,7 @@ Checks if the concept is a ``RoleType``. concept.isRoleType(); ---- -[#_bool_TypeDBConceptisThing___] +[#_bool_TypeDBConceptisThing_] ==== isThing [source,cpp] @@ -480,7 +480,7 @@ Checks if the concept is a ``Thing``. concept.isThing(); ---- -[#_bool_TypeDBConceptisThingType___] +[#_bool_TypeDBConceptisThingType_] ==== isThingType [source,cpp] @@ -504,7 +504,7 @@ Checks if the concept is a ``ThingType``. concept.isThingType(); ---- -[#_bool_TypeDBConceptisValue___] +[#_bool_TypeDBConceptisValue_] ==== isValue [source,cpp] @@ -528,7 +528,7 @@ Checks if the concept is a ``Value``. concept.isValue(); ---- -[#_bool_TypeDBConceptoperator___const_Concept__other_] +[#_bool_TypeDBConceptoperator_const_Concept_other_] ==== operator== [source,cpp] @@ -544,7 +544,7 @@ Checks equality with the ``other`` concept. .Returns `bool` -[#_stdstring_TypeDBConcepttoString___] +[#_stdstring_TypeDBConcepttoString_] ==== toString [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/concept/ConceptManager.adoc b/drivers-src/modules/ROOT/partials/cpp/concept/ConceptManager.adoc index 76899cfa9..8322402cb 100644 --- a/drivers-src/modules/ROOT/partials/cpp/concept/ConceptManager.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/concept/ConceptManager.adoc @@ -8,7 +8,7 @@ Provides access for all Concept API methods. // tag::methods[] -[#_ConceptPtrFuture__Attribute___TypeDBConceptManagergetAttribute___const_stdstring__iid___const] +[#_ConceptPtrFuture_Attribute_TypeDBConceptManagergetAttribute_const_stdstring_iid_const] ==== getAttribute [source,cpp] @@ -41,7 +41,7 @@ a| `iid` a| The iid of the ``Attribute`` to retrieve a| `const std::string&` transaction.concepts.getAttribute(iid).get(); ---- -[#_ConceptPtrFuture__AttributeType___TypeDBConceptManagergetAttributeType___const_stdstring__label___const] +[#_ConceptPtrFuture_AttributeType_TypeDBConceptManagergetAttributeType_const_stdstring_label_const] ==== getAttributeType [source,cpp] @@ -74,7 +74,7 @@ a| `label` a| The label of the ``AttributeType`` to retrieve a| `const std::stri transaction.concepts.getAttributeType(label).get(); ---- -[#_ConceptPtrFuture__Entity___TypeDBConceptManagergetEntity___const_stdstring__iid___const] +[#_ConceptPtrFuture_Entity_TypeDBConceptManagergetEntity_const_stdstring_iid_const] ==== getEntity [source,cpp] @@ -107,7 +107,7 @@ a| `iid` a| The iid of the ``Entity`` to retrieve a| `const std::string&` transaction.concepts.getEntity(iid).get(); ---- -[#_ConceptPtrFuture__EntityType___TypeDBConceptManagergetEntityType___const_stdstring__label___const] +[#_ConceptPtrFuture_EntityType_TypeDBConceptManagergetEntityType_const_stdstring_label_const] ==== getEntityType [source,cpp] @@ -140,7 +140,7 @@ a| `label` a| The label of the ``EntityType`` to retrieve a| `const std::string& transaction.concepts.getEntityType(label).get(); ---- -[#_ConceptPtrFuture__Relation___TypeDBConceptManagergetRelation___const_stdstring__iid___const] +[#_ConceptPtrFuture_Relation_TypeDBConceptManagergetRelation_const_stdstring_iid_const] ==== getRelation [source,cpp] @@ -173,7 +173,7 @@ a| `iid` a| The iid of the ``Relation`` to retrieve a| `const std::string&` transaction.concepts.getRelation(iid).get(); ---- -[#_ConceptPtrFuture__RelationType___TypeDBConceptManagergetRelationType___const_stdstring__label___const] +[#_ConceptPtrFuture_RelationType_TypeDBConceptManagergetRelationType_const_stdstring_label_const] ==== getRelationType [source,cpp] @@ -206,7 +206,7 @@ a| `label` a| The label of the ``RelationType`` to retrieve a| `const std::strin transaction.concepts.getRelationType(label).get(); ---- -[#_stdunique_ptr__AttributeType___TypeDBConceptManagergetRootAttributeType_____const] +[#_stdunique_ptr_AttributeType_TypeDBConceptManagergetRootAttributeType_const] ==== getRootAttributeType [source,cpp] @@ -230,7 +230,7 @@ Retrieve the root ``AttributeType``, “attribute”. transaction.concepts.getRootAttributeType(); ---- -[#_stdunique_ptr__EntityType___TypeDBConceptManagergetRootEntityType_____const] +[#_stdunique_ptr_EntityType_TypeDBConceptManagergetRootEntityType_const] ==== getRootEntityType [source,cpp] @@ -254,7 +254,7 @@ Retrieves the root ``EntityType``, “entity”. transaction.concepts.getRootEntityType(); ---- -[#_stdunique_ptr__RelationType___TypeDBConceptManagergetRootRelationType_____const] +[#_stdunique_ptr_RelationType_TypeDBConceptManagergetRootRelationType_const] ==== getRootRelationType [source,cpp] @@ -278,7 +278,7 @@ Retrieve the root ``RelationType``, “relation”. transaction.concepts.getRootRelationType(); ---- -[#_stdvector__DriverException___TypeDBConceptManagergetSchemaExceptions___] +[#_stdvector_DriverException_TypeDBConceptManagergetSchemaExceptions_] ==== getSchemaExceptions [source,cpp] @@ -302,7 +302,7 @@ Retrieves a list of all schema exceptions for the current transaction. transaction.concepts.getSchemaExceptions(); ---- -[#_ConceptPtrFuture__AttributeType___TypeDBConceptManagerputAttributeType___const_stdstring__label__ValueType_valueType___const] +[#_ConceptPtrFuture_AttributeType_TypeDBConceptManagerputAttributeType_const_stdstring_label_ValueType_valueType_const] ==== putAttributeType [source,cpp] @@ -336,7 +336,7 @@ a| `valueType` a| The value type of the ``AttributeType`` to create a| `ValueTyp transaction.concepts.putAttributeType(label, valueType).get(); ---- -[#_ConceptPtrFuture__EntityType___TypeDBConceptManagerputEntityType___const_stdstring__label___const] +[#_ConceptPtrFuture_EntityType_TypeDBConceptManagerputEntityType_const_stdstring_label_const] ==== putEntityType [source,cpp] @@ -369,7 +369,7 @@ a| `label` a| The label of the ``EntityType`` to create or retrieve a| `const st transaction.concepts.putEntityType(label).get(); ---- -[#_ConceptPtrFuture__RelationType___TypeDBConceptManagerputRelationType___const_stdstring__label___const] +[#_ConceptPtrFuture_RelationType_TypeDBConceptManagerputRelationType_const_stdstring_label_const] ==== putRelationType [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/connection/Credential.adoc b/drivers-src/modules/ROOT/partials/cpp/connection/Credential.adoc index e2fd64942..3d3b836b8 100644 --- a/drivers-src/modules/ROOT/partials/cpp/connection/Credential.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/connection/Credential.adoc @@ -23,7 +23,7 @@ Credential credential(username, password, "path/to/ca-certificate.pem"); ---- // tag::methods[] -[#_TypeDBCredentialCredential___const_stdstring__username__const_stdstring__password__bool_withTLS__const_stdstring__customRootCAPath__""_] +[#_TypeDBCredentialCredential_const_stdstring_username_const_stdstring_password_bool_withTLS_const_stdstring_customRootCAPath_""_] ==== Credential [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/connection/Database.adoc b/drivers-src/modules/ROOT/partials/cpp/connection/Database.adoc index d3f25e90b..f38fcec90 100644 --- a/drivers-src/modules/ROOT/partials/cpp/connection/Database.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/connection/Database.adoc @@ -8,7 +8,7 @@ A TypeDB database. // tag::methods[] -[#_void_TypeDBDatabasedeleteDatabase___] +[#_void_TypeDBDatabasedeleteDatabase_] ==== deleteDatabase [source,cpp] @@ -32,7 +32,7 @@ Deletes this database. database.deleteDatabase() ---- -[#_stdstring_TypeDBDatabasename_____const] +[#_stdstring_TypeDBDatabasename_const] ==== name [source,cpp] @@ -48,7 +48,7 @@ The database name as a string. .Returns `std::string` -[#_stdoptional__ReplicaInfo___TypeDBDatabasepreferredReplica___] +[#_stdoptional_ReplicaInfo_TypeDBDatabasepreferredReplica_] ==== preferredReplica [source,cpp] @@ -72,7 +72,7 @@ Returns the preferred replica for this database. Operations which can be run on database.preferredReplica() ---- -[#_stdoptional__ReplicaInfo___TypeDBDatabaseprimaryReplica___] +[#_stdoptional_ReplicaInfo_TypeDBDatabaseprimaryReplica_] ==== primaryReplica [source,cpp] @@ -96,7 +96,7 @@ Returns the primary replica for this database. _Only works in TypeDB Cloud_ database.primaryReplica() ---- -[#_ReplicaInfoIterable_TypeDBDatabasereplicas___] +[#_ReplicaInfoIterable_TypeDBDatabasereplicas_] ==== replicas [source,cpp] @@ -120,7 +120,7 @@ Set of ``Replica`` instances for this database. Only works in TypeDB Cloud database.replicas() ---- -[#_stdstring_TypeDBDatabaseruleSchema___] +[#_stdstring_TypeDBDatabaseruleSchema_] ==== ruleSchema [source,cpp] @@ -144,7 +144,7 @@ The rules in the schema as a valid TypeQL define query string. database.ruleSchema() ---- -[#_stdstring_TypeDBDatabaseschema___] +[#_stdstring_TypeDBDatabaseschema_] ==== schema [source,cpp] @@ -168,7 +168,7 @@ A full schema text as a valid TypeQL define query string. database.schema() ---- -[#_stdstring_TypeDBDatabasetypeSchema___] +[#_stdstring_TypeDBDatabasetypeSchema_] ==== typeSchema [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/connection/DatabaseManager.adoc b/drivers-src/modules/ROOT/partials/cpp/connection/DatabaseManager.adoc index 6bc7e16c9..8aa28437e 100644 --- a/drivers-src/modules/ROOT/partials/cpp/connection/DatabaseManager.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/connection/DatabaseManager.adoc @@ -8,7 +8,7 @@ Provides access to all database management methods. // tag::methods[] -[#_DatabaseIterable_TypeDBDatabaseManagerall_____const] +[#_DatabaseIterable_TypeDBDatabaseManagerall_const] ==== all [source,cpp] @@ -32,7 +32,7 @@ Retrieves all databases present on the TypeDB server driver.databases.all() ---- -[#_bool_TypeDBDatabaseManagercontains___const_stdstring____const] +[#_bool_TypeDBDatabaseManagercontains_const_stdstring_const] ==== contains [source,cpp] @@ -65,7 +65,7 @@ a| `name` a| The database name to be checked a| driver.databases.contains(name) ---- -[#_void_TypeDBDatabaseManagercreate___const_stdstring____const] +[#_void_TypeDBDatabaseManagercreate_const_stdstring_const] ==== create [source,cpp] @@ -98,7 +98,7 @@ a| `name` a| The name of the database to be created a| driver.databases.create(name) ---- -[#_Database_TypeDBDatabaseManagerget___const_stdstring____const] +[#_Database_TypeDBDatabaseManagerget_const_stdstring_const] ==== get [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/connection/Driver.adoc b/drivers-src/modules/ROOT/partials/cpp/connection/Driver.adoc index c67f56423..6cdf68f9e 100644 --- a/drivers-src/modules/ROOT/partials/cpp/connection/Driver.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/connection/Driver.adoc @@ -20,7 +20,7 @@ a| `users` a| `UserManager TypeDB::Driver` a| The ``UserManager`` instance for t // end::properties[] // tag::methods[] -[#_void_TypeDBDriverclose___] +[#_void_TypeDBDriverclose_] ==== close [source,cpp] @@ -44,7 +44,7 @@ Closes the driver. Before instantiating a new driver, the driver that’s curren driver.close() ---- -[#_static_Driver_TypeDBDrivercloudDriver___const_stdvector__stdstring____addresses__const_Credential__credential_] +[#_static_Driver_TypeDBDrivercloudDriver_const_stdvector_stdstring_addresses_const_Credential_credential_] ==== cloudDriver [source,cpp] @@ -78,7 +78,7 @@ a| `credential` a| The Credential to connect with a| `const Credential&` Driver::cloudDriver(addresses, credential); ---- -[#_static_Driver_TypeDBDrivercoreDriver___const_stdstring__address_] +[#_static_Driver_TypeDBDrivercoreDriver_const_stdstring_address_] ==== coreDriver [source,cpp] @@ -111,7 +111,7 @@ a| `address` a| The address of the TypeDB server a| `const std::string&` Driver::coreDriver(address); ---- -[#_static_void_TypeDBDriverinitLogging___] +[#_static_void_TypeDBDriverinitLogging_] ==== initLogging [source,cpp] @@ -135,7 +135,7 @@ Enables logging in the TypeDB driver. Driver::initLogging(); ---- -[#_bool_TypeDBDriverisOpen___] +[#_bool_TypeDBDriverisOpen_] ==== isOpen [source,cpp] @@ -159,7 +159,7 @@ Checks whether this connection is presently open. driver.isOpen(); ---- -[#_Session_TypeDBDriversession___const_stdstring__database__SessionType_sessionType__const_Options__options__Options___] +[#_Session_TypeDBDriversession_const_stdstring_database_SessionType_sessionType_const_Options_options_Options_] ==== session [source,cpp] @@ -194,7 +194,7 @@ a| `options` a| ``TypeDBOptions`` for the session a| driver.session(database, sessionType, options); ---- -[#_User_TypeDBDriveruser___] +[#_User_TypeDBDriveruser_] ==== user [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/connection/ReplicaInfo.adoc b/drivers-src/modules/ROOT/partials/cpp/connection/ReplicaInfo.adoc index 28294967d..50ea8bb44 100644 --- a/drivers-src/modules/ROOT/partials/cpp/connection/ReplicaInfo.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/connection/ReplicaInfo.adoc @@ -8,7 +8,7 @@ The metadata and state of an individual raft replica of a database. // tag::methods[] -[#_bool_TypeDBReplicaInfoisPreferred___] +[#_bool_TypeDBReplicaInfoisPreferred_] ==== isPreferred [source,cpp] @@ -24,7 +24,7 @@ Checks whether this is the preferred replica of the raft cluster. If true, Opera .Returns `bool` -[#_bool_TypeDBReplicaInfoisPrimary___] +[#_bool_TypeDBReplicaInfoisPrimary_] ==== isPrimary [source,cpp] @@ -40,7 +40,7 @@ Checks whether this is the primary replica of the raft cluster. .Returns `bool` -[#_stdstring_TypeDBReplicaInfoserver___] +[#_stdstring_TypeDBReplicaInfoserver_] ==== server [source,cpp] @@ -56,7 +56,7 @@ The server hosting this replica .Returns `std::string` -[#_int64_t_TypeDBReplicaInfoterm___] +[#_int64_t_TypeDBReplicaInfoterm_] ==== term [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/connection/User.adoc b/drivers-src/modules/ROOT/partials/cpp/connection/User.adoc index d4ce37e4b..d9ec77cfe 100644 --- a/drivers-src/modules/ROOT/partials/cpp/connection/User.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/connection/User.adoc @@ -8,7 +8,7 @@ TypeDB user information. // tag::methods[] -[#_stdoptional__int64_t___TypeDBUserpasswordExpirySeconds___] +[#_stdoptional_int64_t_TypeDBUserpasswordExpirySeconds_] ==== passwordExpirySeconds [source,cpp] @@ -24,7 +24,7 @@ Returns the number of seconds remaining till this user’s current password expi .Returns `std::optional< int64_t >` -[#_void_TypeDBUserpasswordUpdate___const_UserManager__userManager__const_stdstring__passwordOld__const_stdstring__passwordNew_] +[#_void_TypeDBUserpasswordUpdate_const_UserManager_userManager_const_stdstring_passwordOld_const_stdstring_passwordNew_] ==== passwordUpdate [source,cpp] @@ -51,7 +51,7 @@ a| `passwordNew` a| The new password a| `const std::string&` .Returns `void` -[#_stdstring_TypeDBUserusername___] +[#_stdstring_TypeDBUserusername_] ==== username [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/connection/UserManager.adoc b/drivers-src/modules/ROOT/partials/cpp/connection/UserManager.adoc index 45debd286..ff2fd2a32 100644 --- a/drivers-src/modules/ROOT/partials/cpp/connection/UserManager.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/connection/UserManager.adoc @@ -8,7 +8,7 @@ Provides access to all user management methods. // tag::methods[] -[#_UserIterable_TypeDBUserManagerall_____const] +[#_UserIterable_TypeDBUserManagerall_const] ==== all [source,cpp] @@ -32,7 +32,7 @@ Retrieves all users which exist on the TypeDB server. driver.users.all(); ---- -[#_bool_TypeDBUserManagercontains___const_stdstring__username___const] +[#_bool_TypeDBUserManagercontains_const_stdstring_username_const] ==== contains [source,cpp] @@ -65,7 +65,7 @@ a| `username` a| The user name to be checked a| `const std::string&` driver.users.contains(username); ---- -[#_void_TypeDBUserManagercreate___const_stdstring__username__const_stdstring__password___const] +[#_void_TypeDBUserManagercreate_const_stdstring_username_const_stdstring_password_const] ==== create [source,cpp] @@ -99,7 +99,7 @@ a| `password` a| The password of the user to be created a| `const std::string&` driver.users.create(username, password); ---- -[#_void_TypeDBUserManagerdeleteUser___const_stdstring__username___const] +[#_void_TypeDBUserManagerdeleteUser_const_stdstring_username_const] ==== deleteUser [source,cpp] @@ -132,7 +132,7 @@ a| `username` a| The name of the user to be deleted a| `const std::string&` driver.users.deleteUser(username); ---- -[#_stdunique_ptr__User___TypeDBUserManagerget___const_stdstring__username___const] +[#_stdunique_ptr_User_TypeDBUserManagerget_const_stdstring_username_const] ==== get [source,cpp] @@ -165,7 +165,7 @@ a| `username` a| The name of the user to retrieve a| `const std::string&` driver.users.get(username); ---- -[#_void_TypeDBUserManagerpasswordSet___const_stdstring__username__const_stdstring__password___const] +[#_void_TypeDBUserManagerpasswordSet_const_stdstring_username_const_stdstring_password_const] ==== passwordSet [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/data/Attribute.adoc b/drivers-src/modules/ROOT/partials/cpp/data/Attribute.adoc index f4e59008d..93ea0bb92 100644 --- a/drivers-src/modules/ROOT/partials/cpp/data/Attribute.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/data/Attribute.adoc @@ -15,7 +15,7 @@ Attribute is an instance of the attribute type and has a value. This value is fixed and unique for every given instance of the attribute type. Attributes can be uniquely addressed by their type and value. // tag::methods[] -[#_ConceptIterable__Thing___TypeDBAttributegetOwners___Transaction__transaction_] +[#_ConceptIterable_Thing_TypeDBAttributegetOwners_Transaction_transaction_] ==== getOwners [source,cpp] @@ -48,7 +48,7 @@ a| `transaction` a| The current transaction a| `Transaction&` attribute.getOwners(transaction); ---- -[#_ConceptIterable__Thing___TypeDBAttributegetOwners___Transaction__transaction__const_ThingType__ptr__ownerType_] +[#_ConceptIterable_Thing_TypeDBAttributegetOwners_Transaction_transaction_const_ThingType_ptr_ownerType_] ==== getOwners [source,cpp] @@ -82,7 +82,7 @@ a| `ownerType` a| Filter results for only owners of the given type a| `const Thi attribute.getOwners(transaction, ownerType); ---- -[#_stdunique_ptr__AttributeType___TypeDBAttributegetType___] +[#_stdunique_ptr_AttributeType_TypeDBAttributegetType_] ==== getType [source,cpp] @@ -106,7 +106,7 @@ Retrieves the type which this ``Attribute`` belongs to. attribute.getType(); ---- -[#_stdunique_ptr__Value___TypeDBAttributegetValue___] +[#_stdunique_ptr_Value_TypeDBAttributegetValue_] ==== getValue [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/data/Entity.adoc b/drivers-src/modules/ROOT/partials/cpp/data/Entity.adoc index e70b11a7d..c7a8272fb 100644 --- a/drivers-src/modules/ROOT/partials/cpp/data/Entity.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/data/Entity.adoc @@ -15,7 +15,7 @@ Instance of data of an entity type, representing a standalone object that exists Entity does not have a value. It is usually addressed by its ownership over attribute instances and/or roles played in relation instances. // tag::methods[] -[#_stdunique_ptr__EntityType___TypeDBEntitygetType___] +[#_stdunique_ptr_EntityType_TypeDBEntitygetType_] ==== getType [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/data/Relation.adoc b/drivers-src/modules/ROOT/partials/cpp/data/Relation.adoc index 17c5ce423..deb6eb454 100644 --- a/drivers-src/modules/ROOT/partials/cpp/data/Relation.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/data/Relation.adoc @@ -15,7 +15,7 @@ Relation is an instance of a relation type. Relation is an instance of a relation type and can be uniquely addressed by a combination of its type, owned attributes and role players. // tag::methods[] -[#_VoidFuture_TypeDBRelationaddPlayer___Transaction__transaction__RoleType__ptr__roleType__Thing__ptr__player_] +[#_VoidFuture_TypeDBRelationaddPlayer_Transaction_transaction_RoleType_ptr_roleType_Thing_ptr_player_] ==== addPlayer [source,cpp] @@ -50,7 +50,7 @@ a| `player` a| The thing to play the role a| `Thing*` relation.addPlayer(transaction, roleType, player).get(); ---- -[#_stdmap__stdunique_ptr__RoleType____stdunique_ptr__Thing_____TypeDBRelationgetPlayers___Transaction__transaction_] +[#_stdmap_stdunique_ptr_RoleType_stdunique_ptr_Thing_TypeDBRelationgetPlayers_Transaction_transaction_] ==== getPlayers [source,cpp] @@ -83,7 +83,7 @@ a| `transaction` a| The current transaction a| `Transaction&` relation.getPlayers(transaction) ---- -[#_ConceptIterable__Thing___TypeDBRelationgetPlayersByRoleType___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes_] +[#_ConceptIterable_Thing_TypeDBRelationgetPlayersByRoleType_Transaction_transaction_const_stdvector_stdunique_ptr_RoleType_roleTypes_] ==== getPlayersByRoleType [source,cpp] @@ -117,7 +117,7 @@ a| `roleTypes` a| 0 or more role types a| `const std::vector< std::unique_ptr< R relation.getPlayersByRoleType(transaction, roleTypes); ---- -[#_ConceptIterable__Thing___TypeDBRelationgetPlayersByRoleType___Transaction__transaction__const_stdvector__RoleType__ptr_____roleTypes_] +[#_ConceptIterable_Thing_TypeDBRelationgetPlayersByRoleType_Transaction_transaction_const_stdvector_RoleType_ptr_roleTypes_] ==== getPlayersByRoleType [source,cpp] @@ -127,13 +127,13 @@ ConceptIterable< Thing > TypeDB::Relation::getPlayersByRoleType(Transaction& tra -See <<#_ConceptIterable__Thing___TypeDBRelationgetPlayersByRoleType___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes_,getPlayersByRoleType>> +See <<#_ConceptIterable_Thing_TypeDBRelationgetPlayersByRoleType_Transaction_transaction_const_stdvector_stdunique_ptr_RoleType_roleTypes_,getPlayersByRoleType>> [caption=""] .Returns `ConceptIterable< Thing >` -[#_ConceptIterable__RoleType___TypeDBRelationgetRelating___Transaction__transaction_] +[#_ConceptIterable_RoleType_TypeDBRelationgetRelating_Transaction_transaction_] ==== getRelating [source,cpp] @@ -166,7 +166,7 @@ a| `transaction` a| The current transaction a| `Transaction&` relation.getRelating(transaction); ---- -[#_stdunique_ptr__RelationType___TypeDBRelationgetType___] +[#_stdunique_ptr_RelationType_TypeDBRelationgetType_] ==== getType [source,cpp] @@ -190,7 +190,7 @@ Retrieves the type which this ``Relation`` belongs to. relation.getType(); ---- -[#_VoidFuture_TypeDBRelationremovePlayer___Transaction__transaction__RoleType__ptr__roleType__Thing__ptr__player_] +[#_VoidFuture_TypeDBRelationremovePlayer_Transaction_transaction_RoleType_ptr_roleType_Thing_ptr_player_] ==== removePlayer [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/data/Thing.adoc b/drivers-src/modules/ROOT/partials/cpp/data/Thing.adoc index cda304ef9..fb430da8d 100644 --- a/drivers-src/modules/ROOT/partials/cpp/data/Thing.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/data/Thing.adoc @@ -12,7 +12,7 @@ Common super-type of Entity, Relation, and Attribute. // tag::methods[] -[#_VoidFuture_TypeDBThingdeleteThing___Transaction__transaction_] +[#_VoidFuture_TypeDBThingdeleteThing_Transaction_transaction_] ==== deleteThing [source,cpp] @@ -45,7 +45,7 @@ a| `transaction` a| The current transaction a| `Transaction&` thing.deleteThing(transaction).get(); ---- -[#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdinitializer_list__Annotation____annotations___] +[#_ConceptIterable_Attribute_TypeDBThinggetHas_Transaction_transaction_const_stdinitializer_list_Annotation_annotations_] ==== getHas [source,cpp] @@ -80,7 +80,7 @@ thing.getHas(transaction); thing.getHas(transaction, {Annotation.key()})); ---- -[#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_AttributeType__ptr__attribute_] +[#_ConceptIterable_Attribute_TypeDBThinggetHas_Transaction_transaction_const_AttributeType_ptr_attribute_] ==== getHas [source,cpp] @@ -90,13 +90,13 @@ ConceptIterable< Attribute > TypeDB::Thing::getHas(Transaction& transaction, con -See <<#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__stdunique_ptr__AttributeType______attributeTypes_,getHas(Transaction&, const std::vector>&)>> +See <<#_ConceptIterable_Attribute_TypeDBThinggetHas_Transaction_transaction_const_stdvector_stdunique_ptr_AttributeType_attributeTypes_,getHas(Transaction&, const std::vector>&)>> [caption=""] .Returns `ConceptIterable< Attribute >` -[#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__stdunique_ptr__AttributeType______attributeTypes_] +[#_ConceptIterable_Attribute_TypeDBThinggetHas_Transaction_transaction_const_stdvector_stdunique_ptr_AttributeType_attributeTypes_] ==== getHas [source,cpp] @@ -130,7 +130,7 @@ a| `attributeTypes` a| The ``AttributeType``s to filter the attributes by a| `co thing.getHas(transaction, attributeTypes); ---- -[#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__const_AttributeType__ptr_____attributeTypes_] +[#_ConceptIterable_Attribute_TypeDBThinggetHas_Transaction_transaction_const_stdvector_const_AttributeType_ptr_attributeTypes_] ==== getHas [source,cpp] @@ -140,13 +140,13 @@ ConceptIterable< Attribute > TypeDB::Thing::getHas(Transaction& transaction, con -See <<#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__stdunique_ptr__AttributeType______attributeTypes_,getHas(Transaction& transaction, const std::vector>& attributeTypes)>> +See <<#_ConceptIterable_Attribute_TypeDBThinggetHas_Transaction_transaction_const_stdvector_stdunique_ptr_AttributeType_attributeTypes_,getHas(Transaction& transaction, const std::vector>& attributeTypes)>> [caption=""] .Returns `ConceptIterable< Attribute >` -[#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdvector__Annotation____annotations_] +[#_ConceptIterable_Attribute_TypeDBThinggetHas_Transaction_transaction_const_stdvector_Annotation_annotations_] ==== getHas [source,cpp] @@ -156,13 +156,13 @@ ConceptIterable< Attribute > TypeDB::Thing::getHas(Transaction& transaction, con -See <<#_ConceptIterable__Attribute___TypeDBThinggetHas___Transaction__transaction__const_stdinitializer_list__Annotation____annotations___,getHas(Transaction&, const std::initializer_list&)>> +See <<#_ConceptIterable_Attribute_TypeDBThinggetHas_Transaction_transaction_const_stdinitializer_list_Annotation_annotations_,getHas(Transaction&, const std::initializer_list&)>> [caption=""] .Returns `ConceptIterable< Attribute >` -[#_stdstring_TypeDBThinggetIID___] +[#_stdstring_TypeDBThinggetIID_] ==== getIID [source,cpp] @@ -186,7 +186,7 @@ Retrieves the unique id of the ``Thing``. thing.getIID(); ---- -[#_ConceptIterable__RoleType___TypeDBThinggetPlaying___Transaction__transaction_] +[#_ConceptIterable_RoleType_TypeDBThinggetPlaying_Transaction_transaction_] ==== getPlaying [source,cpp] @@ -219,7 +219,7 @@ a| `transaction` a| The current transaction a| `Transaction&` thing.getPlaying(transaction); ---- -[#_ConceptIterable__Relation___TypeDBThinggetRelations___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes___] +[#_ConceptIterable_Relation_TypeDBThinggetRelations_Transaction_transaction_const_stdvector_stdunique_ptr_RoleType_roleTypes_] ==== getRelations [source,cpp] @@ -254,7 +254,7 @@ thing.getRelations(transaction); thing.getRelations(transaction, roleTypes); ---- -[#_ConceptIterable__Relation___TypeDBThinggetRelations___Transaction__transaction__const_stdvector__RoleType__ptr_____roleTypes_] +[#_ConceptIterable_Relation_TypeDBThinggetRelations_Transaction_transaction_const_stdvector_RoleType_ptr_roleTypes_] ==== getRelations [source,cpp] @@ -264,13 +264,13 @@ ConceptIterable< Relation > TypeDB::Thing::getRelations(Transaction& transaction -See <<#_ConceptIterable__Relation___TypeDBThinggetRelations___Transaction__transaction__const_stdvector__stdunique_ptr__RoleType______roleTypes___,getRelations(Transaction& transaction, const std::vector>& roleTypes)>> +See <<#_ConceptIterable_Relation_TypeDBThinggetRelations_Transaction_transaction_const_stdvector_stdunique_ptr_RoleType_roleTypes_,getRelations(Transaction& transaction, const std::vector>& roleTypes)>> [caption=""] .Returns `ConceptIterable< Relation >` -[#_stdunique_ptr__ThingType___TypeDBThinggetType___] +[#_stdunique_ptr_ThingType_TypeDBThinggetType_] ==== getType [source,cpp] @@ -294,7 +294,7 @@ Retrieves the type which this ``Thing`` belongs to. thing.getType(); ---- -[#_BoolFuture_TypeDBThingisDeleted___Transaction__transaction_] +[#_BoolFuture_TypeDBThingisDeleted_Transaction_transaction_] ==== isDeleted [source,cpp] @@ -327,7 +327,7 @@ a| `transaction` a| The current transaction a| `Transaction&` thing.isDeleted(transaction).get(); ---- -[#_bool_TypeDBThingisInferred___] +[#_bool_TypeDBThingisInferred_] ==== isInferred [source,cpp] @@ -351,7 +351,7 @@ Checks if this ``Thing`` is inferred by a [Reasoning Rule]. thing.isInferred(); ---- -[#_VoidFuture_TypeDBThingsetHas___Transaction__transaction__Attribute__ptr__attribute_] +[#_VoidFuture_TypeDBThingsetHas_Transaction_transaction_Attribute_ptr_attribute_] ==== setHas [source,cpp] @@ -385,7 +385,7 @@ a| `attribute` a| The ``Attribute`` to be owned by this ``Thing``. a| `Attribute thing.setHas(transaction, attribute).get(); ---- -[#_VoidFuture_TypeDBThingunsetHas___Transaction__transaction__Attribute__ptr__attribute_] +[#_VoidFuture_TypeDBThingunsetHas_Transaction_transaction_Attribute_ptr_attribute_] ==== unsetHas [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/data/Value.adoc b/drivers-src/modules/ROOT/partials/cpp/data/Value.adoc index 42dd6ff7a..4838a8a63 100644 --- a/drivers-src/modules/ROOT/partials/cpp/data/Value.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/data/Value.adoc @@ -12,7 +12,7 @@ A primitive value. Holds the value of an attribute, or the result of an expression in a query. // tag::methods[] -[#_bool_TypeDBValueasBoolean___] +[#_bool_TypeDBValueasBoolean_] ==== asBoolean [source,cpp] @@ -36,7 +36,7 @@ Returns a ``boolean`` value of this value concept. If the value has another type value.asBoolean(); ---- -[#_DateTime_TypeDBValueasDateTime___] +[#_DateTime_TypeDBValueasDateTime_] ==== asDateTime [source,cpp] @@ -60,7 +60,7 @@ Returns a ``DateTime`` value of this value concept. If the value has another typ value.asDatetime(); ---- -[#_double_TypeDBValueasDouble___] +[#_double_TypeDBValueasDouble_] ==== asDouble [source,cpp] @@ -84,7 +84,7 @@ Returns a ``double`` value of this value concept. If the value has another type, value.asDouble(); ---- -[#_int64_t_TypeDBValueasLong___] +[#_int64_t_TypeDBValueasLong_] ==== asLong [source,cpp] @@ -108,7 +108,7 @@ Returns a ``long`` value of this value concept. If the value has another type, r value.asLong(); ---- -[#_stdstring_TypeDBValueasString___] +[#_stdstring_TypeDBValueasString_] ==== asString [source,cpp] @@ -132,7 +132,7 @@ Returns a ``string`` value of this value concept. If the value has another type, value.asString(); ---- -[#_static_stdstring_TypeDBValueformatDateTime___DateTime_t_] +[#_static_stdstring_TypeDBValueformatDateTime_DateTime_t_] ==== formatDateTime [source,cpp] @@ -156,7 +156,7 @@ Returns a string in the TypeQL DateTime format corresponding to the specified Da Value::formatDateTime(datetime); ---- -[#_bool_TypeDBValueisBoolean___] +[#_bool_TypeDBValueisBoolean_] ==== isBoolean [source,cpp] @@ -180,7 +180,7 @@ Returns ``true`` if the value which this value concept holds is of type ``boolea value.isBoolean() ---- -[#_bool_TypeDBValueisDateTime___] +[#_bool_TypeDBValueisDateTime_] ==== isDateTime [source,cpp] @@ -204,7 +204,7 @@ Returns ``True`` if the value which this value concept holds is of type ``DateTi value.isDatetime(); ---- -[#_bool_TypeDBValueisDouble___] +[#_bool_TypeDBValueisDouble_] ==== isDouble [source,cpp] @@ -228,7 +228,7 @@ Returns ``true`` if the value which this value concept holds is of type ``double value.isDouble(); ---- -[#_bool_TypeDBValueisLong___] +[#_bool_TypeDBValueisLong_] ==== isLong [source,cpp] @@ -252,7 +252,7 @@ Returns ``true`` if the value which this value concept holds is of type ``long`` value.isLong() ---- -[#_bool_TypeDBValueisString___] +[#_bool_TypeDBValueisString_] ==== isString [source,cpp] @@ -276,7 +276,7 @@ Returns ``true`` if the value which this value concept holds is of type ``string value.isString(); ---- -[#_static_stdunique_ptr__Value___TypeDBValueof___bool_value_] +[#_static_stdunique_ptr_Value_TypeDBValueof_bool_value_] ==== of [source,cpp] @@ -300,7 +300,7 @@ Creates a new Value object of the specified boolean value. Value::of(value); ---- -[#_static_stdunique_ptr__Value___TypeDBValueof___int64_t_value_] +[#_static_stdunique_ptr_Value_TypeDBValueof_int64_t_value_] ==== of [source,cpp] @@ -324,7 +324,7 @@ Creates a new Value object of the specified long value. Value::of(value); ---- -[#_static_stdunique_ptr__Value___TypeDBValueof___double_value_] +[#_static_stdunique_ptr_Value_TypeDBValueof_double_value_] ==== of [source,cpp] @@ -348,7 +348,7 @@ Creates a new Value object of the specified double value. Value::of(value); ---- -[#_static_stdunique_ptr__Value___TypeDBValueof___const_stdstring__value_] +[#_static_stdunique_ptr_Value_TypeDBValueof_const_stdstring_value_] ==== of [source,cpp] @@ -372,7 +372,7 @@ Creates a new Value object of the specified string value. Value::of(value); ---- -[#_static_stdunique_ptr__Value___TypeDBValueof___DateTime_value_] +[#_static_stdunique_ptr_Value_TypeDBValueof_DateTime_value_] ==== of [source,cpp] @@ -396,7 +396,7 @@ Creates a new Value object of the specified DateTime value. Value::of(value); ---- -[#_static_DateTime_TypeDBValueparseDateTime___const_stdstring__s_] +[#_static_DateTime_TypeDBValueparseDateTime_const_stdstring_s_] ==== parseDateTime [source,cpp] @@ -420,7 +420,7 @@ Parses a DateTime from a string in the TypeQL DateTime format (yyyy-mm-dd'T'HH:M Value::parseDateTime(str); ---- -[#_ValueType_TypeDBValuevalueType___] +[#_ValueType_TypeDBValuevalueType_] ==== valueType [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/errors/DriverException.adoc b/drivers-src/modules/ROOT/partials/cpp/errors/DriverException.adoc index 211e88967..ab110b154 100644 --- a/drivers-src/modules/ROOT/partials/cpp/errors/DriverException.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/errors/DriverException.adoc @@ -8,7 +8,7 @@ Exceptions raised by the driver. // tag::methods[] -[#_const_stdstring_view_TypeDBDriverExceptioncode___] +[#_const_stdstring_view_TypeDBDriverExceptioncode_] ==== code [source,cpp] @@ -35,7 +35,7 @@ catch (TypeDB::DriverException& e){ } ---- -[#_const_stdstring_view_TypeDBDriverExceptionmessage___] +[#_const_stdstring_view_TypeDBDriverExceptionmessage_] ==== message [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/logic/LogicManager.adoc b/drivers-src/modules/ROOT/partials/cpp/logic/LogicManager.adoc index 9843845f8..ee526a66f 100644 --- a/drivers-src/modules/ROOT/partials/cpp/logic/LogicManager.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/logic/LogicManager.adoc @@ -8,7 +8,7 @@ Provides methods for manipulating ``Rule``s in the database. // tag::methods[] -[#_OptionalRuleFuture_TypeDBLogicManagergetRule___const_stdstring__label___const] +[#_OptionalRuleFuture_TypeDBLogicManagergetRule_const_stdstring_label_const] ==== getRule [source,cpp] @@ -41,7 +41,7 @@ a| `label` a| The label of the Rule to create or retrieve a| `const std::string& transaction.logic.getRule(label).get(); ---- -[#_RuleIterable_TypeDBLogicManagergetRules_____const] +[#_RuleIterable_TypeDBLogicManagergetRules_const] ==== getRules [source,cpp] @@ -65,7 +65,7 @@ Retrieves all rules. transaction.logic.getRules() ---- -[#_RuleFuture_TypeDBLogicManagerputRule___const_stdstring__label__const_stdstring__when__const_stdstring__then___const] +[#_RuleFuture_TypeDBLogicManagerputRule_const_stdstring_label_const_stdstring_when_const_stdstring_then_const] ==== putRule [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/logic/Rule.adoc b/drivers-src/modules/ROOT/partials/cpp/logic/Rule.adoc index fae4a2ef9..f7e9c6d0f 100644 --- a/drivers-src/modules/ROOT/partials/cpp/logic/Rule.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/logic/Rule.adoc @@ -10,7 +10,7 @@ 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. // tag::methods[] -[#_VoidFuture_TypeDBRuledeleteRule___Transaction__transaction_] +[#_VoidFuture_TypeDBRuledeleteRule_Transaction_transaction_] ==== deleteRule [source,cpp] @@ -43,7 +43,7 @@ a| `transaction` a| The current ``Transaction`` a| `Transaction&` rule.deleteRule(transaction).get(); ---- -[#_BoolFuture_TypeDBRuleisDeleted___Transaction__transaction_] +[#_BoolFuture_TypeDBRuleisDeleted_Transaction_transaction_] ==== isDeleted [source,cpp] @@ -76,7 +76,7 @@ a| `transaction` a| The current ``Transaction`` a| `Transaction&` rule.isDeleted(transaction).get(); ---- -[#_stdstring_TypeDBRulelabel___] +[#_stdstring_TypeDBRulelabel_] ==== label [source,cpp] @@ -92,7 +92,7 @@ Retrieves the unique label of the rule. .Returns `std::string` -[#_VoidFuture_TypeDBRulesetLabel___Transaction__transaction__const_stdstring__label_] +[#_VoidFuture_TypeDBRulesetLabel_Transaction_transaction_const_stdstring_label_] ==== setLabel [source,cpp] @@ -126,7 +126,7 @@ a| `label` a| The new label to be given to the rule a| `const std::string&` rule.setLabel(transaction, newLabel).get(); ---- -[#_stdstring_TypeDBRulethen___] +[#_stdstring_TypeDBRulethen_] ==== then [source,cpp] @@ -142,7 +142,7 @@ The single statement that constitutes the ‘then’ of the rule. .Returns `std::string` -[#_stdstring_TypeDBRuletoString___] +[#_stdstring_TypeDBRuletoString_] ==== toString [source,cpp] @@ -158,7 +158,7 @@ A string representation of this Rule. .Returns `std::string` -[#_stdstring_TypeDBRulewhen___] +[#_stdstring_TypeDBRulewhen_] ==== when [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/schema/Annotation.adoc b/drivers-src/modules/ROOT/partials/cpp/schema/Annotation.adoc index 72c12c3a9..a8f5ffd21 100644 --- a/drivers-src/modules/ROOT/partials/cpp/schema/Annotation.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/schema/Annotation.adoc @@ -8,7 +8,7 @@ Annotations are used to specify extra schema constraints. // tag::methods[] -[#_bool_TypeDBAnnotationisKey___] +[#_bool_TypeDBAnnotationisKey_] ==== isKey [source,cpp] @@ -32,7 +32,7 @@ Checks if this ``Annotation`` is a ``@key`` annotation. annotation.isKey(); ---- -[#_bool_TypeDBAnnotationisUnique___] +[#_bool_TypeDBAnnotationisUnique_] ==== isUnique [source,cpp] @@ -56,7 +56,7 @@ Checks if this ``Annotation`` is a ``@unique`` annotation. annotation.isUnique(); ---- -[#_static_Annotation_TypeDBAnnotationkey___] +[#_static_Annotation_TypeDBAnnotationkey_] ==== key [source,cpp] @@ -80,7 +80,7 @@ Produces a ``@key`` annotation. ThingType.Annotation.key(); ---- -[#_stdstring_TypeDBAnnotationtoString___] +[#_stdstring_TypeDBAnnotationtoString_] ==== toString [source,cpp] @@ -96,7 +96,7 @@ A string representation of this Annotation. .Returns `std::string` -[#_static_Annotation_TypeDBAnnotationunique___] +[#_static_Annotation_TypeDBAnnotationunique_] ==== unique [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/schema/AttributeType.adoc b/drivers-src/modules/ROOT/partials/cpp/schema/AttributeType.adoc index a2d269f1d..51e009a6f 100644 --- a/drivers-src/modules/ROOT/partials/cpp/schema/AttributeType.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/schema/AttributeType.adoc @@ -20,7 +20,7 @@ Other types can own an attribute type. That means that instances of these other Multiple types can own the same attribute type, and different instances of the same type or different types can share ownership of the same attribute instance. // tag::methods[] -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__Value__ptr__value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeget_Transaction_transaction_Value_ptr_value_] ==== get [source,cpp] @@ -54,7 +54,7 @@ a| `value` a| ``Attribute``’s value a| `Value*` attributeType.get(transaction, value).get(); ---- -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__const_stdstring__value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeget_Transaction_transaction_const_stdstring_value_] ==== get [source,cpp] @@ -88,7 +88,7 @@ a| `value` a| ``Attribute``’s value a| `const std::string&` attributeType.get(transaction, value).get(); ---- -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__int64_t_value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeget_Transaction_transaction_int64_t_value_] ==== get [source,cpp] @@ -122,7 +122,7 @@ a| `value` a| ``Attribute``’s value a| `int64_t` attributeType.get(transaction, value).get(); ---- -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__double_value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeget_Transaction_transaction_double_value_] ==== get [source,cpp] @@ -156,7 +156,7 @@ a| `value` a| ``Attribute``’s value a| `double` attributeType.get(transaction, value).get(); ---- -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__bool_value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeget_Transaction_transaction_bool_value_] ==== get [source,cpp] @@ -190,7 +190,7 @@ a| `value` a| ``Attribute``’s value a| `bool` attributeType.get(transaction, value).get(); ---- -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeget___Transaction__transaction__DateTime_value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeget_Transaction_transaction_DateTime_value_] ==== get [source,cpp] @@ -224,7 +224,7 @@ a| `value` a| ``Attribute``’s value a| `DateTime` attributeType.get(transaction, value).get(); ---- -[#_ConceptIterable__Attribute___TypeDBAttributeTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_Attribute_TypeDBAttributeTypegetInstances_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getInstances [source,cpp] @@ -263,7 +263,7 @@ attributeType.getInstances(transaction, transitivity); transaction The current transaction ---- -[#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_ThingType_TypeDBAttributeTypegetOwners_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getOwners [source,cpp] @@ -297,7 +297,7 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp attributeType.getOwners(transaction); ---- -[#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Transaction__transaction__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_ThingType_TypeDBAttributeTypegetOwners_Transaction_transaction_const_stdvector_Annotation_annotations_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getOwners [source,cpp] @@ -307,7 +307,7 @@ ConceptIterable< ThingType > TypeDB::AttributeType::getOwners(Transaction& trans -Variant of <<#_ConceptIterable__ThingType___TypeDBAttributeTypegetOwners___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwners>>(Transaction& transaction, const std::vector& annotations, Transitivity transitivity = Transitivity::TRANSITIVE) for convenience +Variant of <<#_ConceptIterable_ThingType_TypeDBAttributeTypegetOwners_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_,getOwners>>(Transaction& transaction, const std::vector& annotations, Transitivity transitivity = Transitivity::TRANSITIVE) for convenience [caption=""] @@ -354,7 +354,7 @@ Parameters transitivity Transitivity::TRANSITIVE for direct and indirect subtypes, Transitivity::EXPLICIT for direct subtypes only ---- -[#_OptionalStringFuture_TypeDBAttributeTypegetRegex___Transaction__transaction_] +[#_OptionalStringFuture_TypeDBAttributeTypegetRegex_Transaction_transaction_] ==== getRegex [source,cpp] @@ -387,7 +387,7 @@ a| `transaction` a| The current transaction a| `Transaction&` attributeType.getRegex(transaction).get(); ---- -[#_ConceptIterable__AttributeType___TypeDBAttributeTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_AttributeType_TypeDBAttributeTypegetSubtypes_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getSubtypes [source,cpp] @@ -422,7 +422,7 @@ attributeType.getSubtypes(transaction); attributeType.getSubtypes(transaction, transitivity); ---- -[#_ConceptIterable__AttributeType___TypeDBAttributeTypegetSubtypes___Transaction__transaction__ValueType_valueType__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_AttributeType_TypeDBAttributeTypegetSubtypes_Transaction_transaction_ValueType_valueType_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getSubtypes [source,cpp] @@ -457,7 +457,7 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp attributeType.getSubtypes(transaction, valueType, transitivity); ---- -[#_ValueType_TypeDBAttributeTypegetValueType___] +[#_ValueType_TypeDBAttributeTypegetValueType_] ==== getValueType [source,cpp] @@ -481,7 +481,7 @@ Retrieves the ``Value.Type`` of this ``AttributeType``. attributeType.getValueType(); ---- -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__Value__ptr__value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeput_Transaction_transaction_Value_ptr_value_] ==== put [source,cpp] @@ -515,7 +515,7 @@ a| `value` a| New ``Attribute``’s value a| `Value*` attributeType.put(transaction, value).get(); ---- -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__const_stdstring__value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeput_Transaction_transaction_const_stdstring_value_] ==== put [source,cpp] @@ -549,7 +549,7 @@ a| `value` a| New ``Attribute``’s value a| `const std::string&` attributeType.put(transaction, value).get(); ---- -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__int64_t_value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeput_Transaction_transaction_int64_t_value_] ==== put [source,cpp] @@ -583,7 +583,7 @@ a| `value` a| New ``Attribute``’s value a| `int64_t` attributeType.put(transaction, value).get(); ---- -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__double_value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeput_Transaction_transaction_double_value_] ==== put [source,cpp] @@ -617,7 +617,7 @@ a| `value` a| New ``Attribute``’s value a| `double` attributeType.put(transaction, value).get(); ---- -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__bool_value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeput_Transaction_transaction_bool_value_] ==== put [source,cpp] @@ -651,7 +651,7 @@ a| `value` a| New ``Attribute``’s value a| `bool` attributeType.put(transaction, value).get(); ---- -[#_ConceptPtrFuture__Attribute___TypeDBAttributeTypeput___Transaction__transaction__DateTime_value_] +[#_ConceptPtrFuture_Attribute_TypeDBAttributeTypeput_Transaction_transaction_DateTime_value_] ==== put [source,cpp] @@ -685,7 +685,7 @@ a| `value` a| New ``Attribute``’s value a| `DateTime` attributeType.put(transaction, value).get(); ---- -[#_VoidFuture_TypeDBAttributeTypesetRegex___Transaction__transaction__const_stdstring__regex_] +[#_VoidFuture_TypeDBAttributeTypesetRegex_Transaction_transaction_const_stdstring_regex_] ==== setRegex [source,cpp] @@ -721,7 +721,7 @@ a| `regex` a| Regular expression a| `const std::string&` attributeType.setRegex(transaction, regex).get(); ---- -[#_VoidFuture_TypeDBAttributeTypesetSupertype___Transaction__transaction__AttributeType__ptr__attributeType_] +[#_VoidFuture_TypeDBAttributeTypesetSupertype_Transaction_transaction_AttributeType_ptr_attributeType_] ==== setSupertype [source,cpp] @@ -755,7 +755,7 @@ a| `attributeType` a| The ``AttributeType`` to set as the supertype of this ``At attributeType.setSupertype(transaction, superType).get(); ---- -[#_VoidFuture_TypeDBAttributeTypeunsetRegex___Transaction__transaction_] +[#_VoidFuture_TypeDBAttributeTypeunsetRegex_Transaction_transaction_] ==== unsetRegex [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/schema/EntityType.adoc b/drivers-src/modules/ROOT/partials/cpp/schema/EntityType.adoc index 138a3fbfd..33e09fe05 100644 --- a/drivers-src/modules/ROOT/partials/cpp/schema/EntityType.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/schema/EntityType.adoc @@ -14,7 +14,7 @@ Entity types represent the classification of independent objects in the data model of the business domain. // tag::methods[] -[#_ConceptPtrFuture__Entity___TypeDBEntityTypecreate___Transaction__transaction_] +[#_ConceptPtrFuture_Entity_TypeDBEntityTypecreate_Transaction_transaction_] ==== create [source,cpp] @@ -47,7 +47,7 @@ a| `transaction` a| The current transaction a| `Transaction&` entityType.create(transaction).get(); ---- -[#_ConceptIterable__Entity___TypeDBEntityTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_Entity_TypeDBEntityTypegetInstances_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getInstances [source,cpp] @@ -81,7 +81,7 @@ a| `transitivity` a| ``Transitivity::EXPLICIT`` for direct instances only, ``Tra entityType.getInstances(transaction, transitivity); ---- -[#_ConceptIterable__EntityType___TypeDBEntityTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_EntityType_TypeDBEntityTypegetSubtypes_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getSubtypes [source,cpp] @@ -115,7 +115,7 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp entityType.getSubtypes(transaction, transitivity); ---- -[#_VoidFuture_TypeDBEntityTypesetSupertype___Transaction__transaction__EntityType__ptr__superEntityType_] +[#_VoidFuture_TypeDBEntityTypesetSupertype_Transaction_transaction_EntityType_ptr_superEntityType_] ==== setSupertype [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/schema/RelationType.adoc b/drivers-src/modules/ROOT/partials/cpp/schema/RelationType.adoc index 24c91f8d2..4415bb0fb 100644 --- a/drivers-src/modules/ROOT/partials/cpp/schema/RelationType.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/schema/RelationType.adoc @@ -16,7 +16,7 @@ Relation types (or subtypes of the relation root type) represent relationships b Relation types have roles. Other types can play roles in relations if it’s mentioned in their definition. A relation type must specify at least one role. // tag::methods[] -[#_ConceptPtrFuture__Relation___TypeDBRelationTypecreate___Transaction__transaction_] +[#_ConceptPtrFuture_Relation_TypeDBRelationTypecreate_Transaction_transaction_] ==== create [source,cpp] @@ -49,7 +49,7 @@ a| `transaction` a| The current transaction a| `Transaction&` relationType.create(transaction).get(); ---- -[#_ConceptIterable__Relation___TypeDBRelationTypegetInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_Relation_TypeDBRelationTypegetInstances_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getInstances [source,cpp] @@ -83,7 +83,7 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect instan relationType.getInstances(transaction, transitivity) ---- -[#_ConceptIterable__RoleType___TypeDBRelationTypegetRelates___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_RoleType_TypeDBRelationTypegetRelates_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getRelates [source,cpp] @@ -117,7 +117,7 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and inherited relat relationType.getRelates(transaction, transitivity); ---- -[#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelates___Transaction__transaction__const_stdstring__roleLabel_] +[#_ConceptPtrFuture_RoleType_TypeDBRelationTypegetRelates_Transaction_transaction_const_stdstring_roleLabel_] ==== getRelates [source,cpp] @@ -151,7 +151,7 @@ a| `roleLabel` a| Label of the role we wish to retrieve a| `const std::string&` relationType.getRelates(transaction, roleLabel).get(); ---- -[#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelatesOverridden___Transaction__transaction__RoleType__ptr__roleType_] +[#_ConceptPtrFuture_RoleType_TypeDBRelationTypegetRelatesOverridden_Transaction_transaction_RoleType_ptr_roleType_] ==== getRelatesOverridden [source,cpp] @@ -185,7 +185,7 @@ a| `roleLabel` a| Label of the role that overrides an inherited role a| relationType.getRelatesOverridden(transaction, roleLabel).get(); ---- -[#_ConceptPtrFuture__RoleType___TypeDBRelationTypegetRelatesOverridden___Transaction__transaction__const_stdstring__roleLabel_] +[#_ConceptPtrFuture_RoleType_TypeDBRelationTypegetRelatesOverridden_Transaction_transaction_const_stdstring_roleLabel_] ==== getRelatesOverridden [source,cpp] @@ -219,7 +219,7 @@ a| `roleLabel` a| Label of the role that overrides an inherited role a| `const s relationType.getRelatesOverridden(transaction, roleLabel).get(); ---- -[#_ConceptIterable__RelationType___TypeDBRelationTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_RelationType_TypeDBRelationTypegetSubtypes_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getSubtypes [source,cpp] @@ -253,7 +253,7 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp relationType.getSubtypes(transaction, transitivity); ---- -[#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel_] +[#_VoidFuture_TypeDBRelationTypesetRelates_Transaction_transaction_const_stdstring_roleLabel_] ==== setRelates [source,cpp] @@ -263,13 +263,13 @@ VoidFuture TypeDB::RelationType::setRelates(Transaction& transaction, const std: -Variant of <<#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel__const_stdstring__overriddenLabel_,setRelates(Transaction& transaction, const std::string& roleLabel, const std::string& overriddenLabel)>> where the RoleType does not override an existing role. +Variant of <<#_VoidFuture_TypeDBRelationTypesetRelates_Transaction_transaction_const_stdstring_roleLabel_const_stdstring_overriddenLabel_,setRelates(Transaction& transaction, const std::string& roleLabel, const std::string& overriddenLabel)>> where the RoleType does not override an existing role. [caption=""] .Returns `VoidFuture` -[#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel__RoleType__ptr__overriddenType_] +[#_VoidFuture_TypeDBRelationTypesetRelates_Transaction_transaction_const_stdstring_roleLabel_RoleType_ptr_overriddenType_] ==== setRelates [source,cpp] @@ -279,13 +279,13 @@ VoidFuture TypeDB::RelationType::setRelates(Transaction& transaction, const std: -Variant of <<#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel__const_stdstring__overriddenLabel_,setRelates(Transaction& transaction, const std::string& roleLabel, const std::string& overriddenLabel)>> where the RoleType is specified directly rather than the label. +Variant of <<#_VoidFuture_TypeDBRelationTypesetRelates_Transaction_transaction_const_stdstring_roleLabel_const_stdstring_overriddenLabel_,setRelates(Transaction& transaction, const std::string& roleLabel, const std::string& overriddenLabel)>> where the RoleType is specified directly rather than the label. [caption=""] .Returns `VoidFuture` -[#_VoidFuture_TypeDBRelationTypesetRelates___Transaction__transaction__const_stdstring__roleLabel__const_stdstring__overriddenLabel_] +[#_VoidFuture_TypeDBRelationTypesetRelates_Transaction_transaction_const_stdstring_roleLabel_const_stdstring_overriddenLabel_] ==== setRelates [source,cpp] @@ -321,7 +321,7 @@ relationType.setRelates(transaction, roleLabel).get(); relationType.setRelates(transaction, roleLabel, overriddenLabel).get(); ---- -[#_VoidFuture_TypeDBRelationTypesetSupertype___Transaction__transaction__RelationType__ptr__superRelationType_] +[#_VoidFuture_TypeDBRelationTypesetSupertype_Transaction_transaction_RelationType_ptr_superRelationType_] ==== setSupertype [source,cpp] @@ -355,7 +355,7 @@ a| `superRelationType` a| The ``RelationType`` to set as the supertype of this ` relationType.setSupertype(transaction, superRelationType).get(); ---- -[#_VoidFuture_TypeDBRelationTypeunsetRelates___Transaction__transaction__RoleType__ptr__roleType_] +[#_VoidFuture_TypeDBRelationTypeunsetRelates_Transaction_transaction_RoleType_ptr_roleType_] ==== unsetRelates [source,cpp] @@ -365,13 +365,13 @@ VoidFuture TypeDB::RelationType::unsetRelates(Transaction& transaction, RoleType -Variant of <<#_VoidFuture_TypeDBRelationTypeunsetRelates___Transaction__transaction__const_stdstring__roleLabel_,unsetRelates(Transaction& transaction, const std::string& roleLabel)>> where the RoleType is specified directly rather than the label. +Variant of <<#_VoidFuture_TypeDBRelationTypeunsetRelates_Transaction_transaction_const_stdstring_roleLabel_,unsetRelates(Transaction& transaction, const std::string& roleLabel)>> where the RoleType is specified directly rather than the label. [caption=""] .Returns `VoidFuture` -[#_VoidFuture_TypeDBRelationTypeunsetRelates___Transaction__transaction__const_stdstring__roleLabel_] +[#_VoidFuture_TypeDBRelationTypeunsetRelates_Transaction_transaction_const_stdstring_roleLabel_] ==== unsetRelates [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/schema/RoleType.adoc b/drivers-src/modules/ROOT/partials/cpp/schema/RoleType.adoc index b7ae22d73..21be95a93 100644 --- a/drivers-src/modules/ROOT/partials/cpp/schema/RoleType.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/schema/RoleType.adoc @@ -15,7 +15,7 @@ Defines a role an instance can play in a Relation. Roles are special internal types used by relations. We can not create an instance of a role in a database. But we can set an instance of another type (role player) to play a role in a particular instance of a relation type. Roles allow a schema to enforce logical constraints on types of role players. // tag::methods[] -[#_virtual_VoidFuture_TypeDBRoleTypedeleteType___Transaction__transaction_] +[#_virtual_VoidFuture_TypeDBRoleTypedeleteType_Transaction_transaction_] ==== deleteType [source,cpp] @@ -52,7 +52,7 @@ a| `transaction` a| The current transaction a| `Transaction&` type.deleteType(transaction).get(); ---- -[#_virtual_stdstring_TypeDBRoleTypegetLabel___] +[#_virtual_stdstring_TypeDBRoleTypegetLabel_] ==== getLabel [source,cpp] @@ -80,7 +80,7 @@ Implements TypeDB::Type. type.getLabel(); ---- -[#_stdstring_TypeDBRoleTypegetName___] +[#_stdstring_TypeDBRoleTypegetName_] ==== getName [source,cpp] @@ -104,7 +104,7 @@ Returns the name of this role type's label. label.getName(); ---- -[#_ConceptIterable__Thing___TypeDBRoleTypegetPlayerInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_Thing_TypeDBRoleTypegetPlayerInstances_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getPlayerInstances [source,cpp] @@ -138,7 +138,7 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect playin roleType.getPlayerInstances(transaction, transitivity); ---- -[#_ConceptIterable__ThingType___TypeDBRoleTypegetPlayerTypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_ThingType_TypeDBRoleTypegetPlayerTypes_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getPlayerTypes [source,cpp] @@ -172,7 +172,7 @@ a| `transitivity` a| ``Transitivity.TRANSITIVE`` for direct and indirect playing roleType.getPlayerTypes(transaction, transitivity) ---- -[#_ConceptIterable__Relation___TypeDBRoleTypegetRelationInstances___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_Relation_TypeDBRoleTypegetRelationInstances_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getRelationInstances [source,cpp] @@ -206,7 +206,7 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect relati roleType.getRelationInstances(transaction, transitivity) ---- -[#_ConceptPtrFuture__RelationType___TypeDBRoleTypegetRelationType___Transaction__transaction_] +[#_ConceptPtrFuture_RelationType_TypeDBRoleTypegetRelationType_Transaction_transaction_] ==== getRelationType [source,cpp] @@ -239,7 +239,7 @@ a| `transaction` a| The current transaction a| `Transaction&` roleType.getRelationType(transaction).get(); ---- -[#_ConceptIterable__RelationType___TypeDBRoleTypegetRelationTypes___Transaction__transaction_] +[#_ConceptIterable_RelationType_TypeDBRoleTypegetRelationTypes_Transaction_transaction_] ==== getRelationTypes [source,cpp] @@ -272,7 +272,7 @@ a| `transaction` a| The current transaction a| `Transaction&` roleType.getRelationTypes(transaction); ---- -[#_stdstring_TypeDBRoleTypegetScope___] +[#_stdstring_TypeDBRoleTypegetScope_] ==== getScope [source,cpp] @@ -296,7 +296,7 @@ Returns the scope part of this role type's label. label.getScope(); ---- -[#_ConceptIterable__RoleType___TypeDBRoleTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_RoleType_TypeDBRoleTypegetSubtypes_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getSubtypes [source,cpp] @@ -330,7 +330,7 @@ a| `transitivity` a| ``Transitivity::TRANSITIVE`` for direct and indirect subtyp roleType.getSubtypes(transaction, transitivity); ---- -[#_ConceptPtrFuture__RoleType___TypeDBRoleTypegetSupertype___Transaction__transaction_] +[#_ConceptPtrFuture_RoleType_TypeDBRoleTypegetSupertype_Transaction_transaction_] ==== getSupertype [source,cpp] @@ -363,7 +363,7 @@ a| `transaction` a| The current transaction a| `Transaction&` roleType.getSupertype(transaction).get(); ---- -[#_ConceptIterable__RoleType___TypeDBRoleTypegetSupertypes___Transaction__transaction_] +[#_ConceptIterable_RoleType_TypeDBRoleTypegetSupertypes_Transaction_transaction_] ==== getSupertypes [source,cpp] @@ -396,7 +396,7 @@ a| `transaction` a| The current transaction a| `Transaction&` roleType.getSupertypes(transaction); ---- -[#_virtual_bool_TypeDBRoleTypeisAbstract___] +[#_virtual_bool_TypeDBRoleTypeisAbstract_] ==== isAbstract [source,cpp] @@ -424,7 +424,7 @@ Implements TypeDB::Type. type.isAbstract(); ---- -[#_virtual_BoolFuture_TypeDBRoleTypeisDeleted___Transaction__transaction_] +[#_virtual_BoolFuture_TypeDBRoleTypeisDeleted_Transaction_transaction_] ==== isDeleted [source,cpp] @@ -461,7 +461,7 @@ a| `transaction` a| The current transaction a| `Transaction&` type.isDeleted(transaction).get(); ---- -[#_bool_TypeDBRoleTypeisRoot___] +[#_bool_TypeDBRoleTypeisRoot_] ==== isRoot [source,cpp] @@ -485,7 +485,7 @@ Checks if the type is a root type. type.isRoot(); ---- -[#_virtual_VoidFuture_TypeDBRoleTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] +[#_virtual_VoidFuture_TypeDBRoleTypesetLabel_Transaction_transaction_const_stdstring_newLabel_] ==== setLabel [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/schema/ThingType.adoc b/drivers-src/modules/ROOT/partials/cpp/schema/ThingType.adoc index bf8842067..076f328d5 100644 --- a/drivers-src/modules/ROOT/partials/cpp/schema/ThingType.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/schema/ThingType.adoc @@ -13,7 +13,7 @@ Common super-type of EntityType, RelationType, and AttributeType. // tag::methods[] -[#_virtual_VoidFuture_TypeDBThingTypedeleteType___Transaction__transaction_] +[#_virtual_VoidFuture_TypeDBThingTypedeleteType_Transaction_transaction_] ==== deleteType [source,cpp] @@ -50,7 +50,7 @@ a| `transaction` a| The current transaction a| `Transaction&` type.deleteType(transaction).get(); ---- -[#_virtual_stdstring_TypeDBThingTypegetLabel___] +[#_virtual_stdstring_TypeDBThingTypegetLabel_] ==== getLabel [source,cpp] @@ -78,7 +78,7 @@ Implements TypeDB::Type. type.getLabel(); ---- -[#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_AttributeType_TypeDBThingTypegetOwns_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getOwns [source,cpp] @@ -88,13 +88,13 @@ ConceptIterable< AttributeType > TypeDB::ThingType::getOwns(Transaction& transac -Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``ValueType`` or ``Annotation``s +Variant of <<#_ConceptIterable_AttributeType_TypeDBThingTypegetOwns_Transaction_transaction_ValueType_valueType_const_stdvector_Annotation_annotations_Transitivity_transitivity_TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``ValueType`` or ``Annotation``s [caption=""] .Returns `ConceptIterable< AttributeType >` -[#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__const_stdinitializer_list__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_AttributeType_TypeDBThingTypegetOwns_Transaction_transaction_const_stdinitializer_list_Annotation_annotations_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getOwns [source,cpp] @@ -106,13 +106,13 @@ ConceptIterable< AttributeType > TypeDB::ThingType::getOwns(Transaction& transac -Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``ValueType`` +Variant of <<#_ConceptIterable_AttributeType_TypeDBThingTypegetOwns_Transaction_transaction_ValueType_valueType_const_stdvector_Annotation_annotations_Transitivity_transitivity_TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``ValueType`` [caption=""] .Returns `ConceptIterable< AttributeType >` -[#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_AttributeType_TypeDBThingTypegetOwns_Transaction_transaction_const_stdvector_Annotation_annotations_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getOwns [source,cpp] @@ -122,13 +122,13 @@ ConceptIterable< AttributeType > TypeDB::ThingType::getOwns(Transaction& transac -Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``ValueType`` +Variant of <<#_ConceptIterable_AttributeType_TypeDBThingTypegetOwns_Transaction_transaction_ValueType_valueType_const_stdvector_Annotation_annotations_Transitivity_transitivity_TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``ValueType`` [caption=""] .Returns `ConceptIterable< AttributeType >` -[#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_AttributeType_TypeDBThingTypegetOwns_Transaction_transaction_ValueType_valueType_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getOwns [source,cpp] @@ -138,13 +138,13 @@ ConceptIterable< AttributeType > TypeDB::ThingType::getOwns(Transaction& transac -Variant of <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``Annotation``s +Variant of <<#_ConceptIterable_AttributeType_TypeDBThingTypegetOwns_Transaction_transaction_ValueType_valueType_const_stdvector_Annotation_annotations_Transitivity_transitivity_TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> without filtering on ``Annotation``s [caption=""] .Returns `ConceptIterable< AttributeType >` -[#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdinitializer_list__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_AttributeType_TypeDBThingTypegetOwns_Transaction_transaction_ValueType_valueType_const_stdinitializer_list_Annotation_annotations_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getOwns [source,cpp] @@ -154,13 +154,13 @@ ConceptIterable< AttributeType > TypeDB::ThingType::getOwns(Transaction& transac -See <<#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> +See <<#_ConceptIterable_AttributeType_TypeDBThingTypegetOwns_Transaction_transaction_ValueType_valueType_const_stdvector_Annotation_annotations_Transitivity_transitivity_TransitivityTRANSITIVE_,getOwns(Transaction&, ValueType, const std::vector&, Transitivity)>> [caption=""] .Returns `ConceptIterable< AttributeType >` -[#_ConceptIterable__AttributeType___TypeDBThingTypegetOwns___Transaction__transaction__ValueType_valueType__const_stdvector__Annotation____annotations__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_AttributeType_TypeDBThingTypegetOwns_Transaction_transaction_ValueType_valueType_const_stdvector_Annotation_annotations_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getOwns [source,cpp] @@ -197,7 +197,7 @@ thingType.getOwns(transaction); thingType.getOwns(transaction, valueType, Transitivity::EXPLICIT, Collections.singleton(Annotation.key())); ---- -[#_ConceptPtrFuture__AttributeType___TypeDBThingTypegetOwnsOverridden___Transaction__transaction__AttributeType__ptr__attributeType_] +[#_ConceptPtrFuture_AttributeType_TypeDBThingTypegetOwnsOverridden_Transaction_transaction_AttributeType_ptr_attributeType_] ==== getOwnsOverridden [source,cpp] @@ -231,7 +231,7 @@ a| `attributeType` a| The ``AttributeType`` that overrides requested ``Attribute thingType.getOwnsOverridden(transaction, attributeType).get(); ---- -[#_ConceptIterable__RoleType___TypeDBThingTypegetPlays___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_RoleType_TypeDBThingTypegetPlays_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getPlays [source,cpp] @@ -266,7 +266,7 @@ thingType.getPlays(transaction).get(); thingType.getPlays(transaction, Transitivity::EXPLICIT).get(); ---- -[#_ConceptPtrFuture__RoleType___TypeDBThingTypegetPlaysOverridden___Transaction__transaction__RoleType__ptr__roleType_] +[#_ConceptPtrFuture_RoleType_TypeDBThingTypegetPlaysOverridden_Transaction_transaction_RoleType_ptr_roleType_] ==== getPlaysOverridden [source,cpp] @@ -300,7 +300,7 @@ a| `roleType` a| The ``RoleType`` that overrides an inherited role a| `RoleType* thingType.getPlaysOverridden(transaction, roleType).get(); ---- -[#_ConceptIterable__ThingType___TypeDBThingTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_ThingType_TypeDBThingTypegetSubtypes_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getSubtypes [source,cpp] @@ -337,7 +337,7 @@ type.getSubtypes(transaction); type.getSubtypes(transaction, Transitivity.EXPLICIT); ---- -[#_ConceptPtrFuture__ThingType___TypeDBThingTypegetSupertype___Transaction__transaction_] +[#_ConceptPtrFuture_ThingType_TypeDBThingTypegetSupertype_Transaction_transaction_] ==== getSupertype [source,cpp] @@ -372,7 +372,7 @@ a| `transaction` a| The current transaction a| `Transaction&` type.getSupertype(transaction).get(); ---- -[#_ConceptIterable__ThingType___TypeDBThingTypegetSupertypes___Transaction__transaction_] +[#_ConceptIterable_ThingType_TypeDBThingTypegetSupertypes_Transaction_transaction_] ==== getSupertypes [source,cpp] @@ -407,7 +407,7 @@ a| `transaction` a| The current transaction a| `Transaction&` type.getSupertypes(transaction); ---- -[#_StringFuture_TypeDBThingTypegetSyntax___Transaction__transaction_] +[#_StringFuture_TypeDBThingTypegetSyntax_Transaction_transaction_] ==== getSyntax [source,cpp] @@ -440,7 +440,7 @@ a| `transaction` a| The current transaction a| `Transaction&` thingType.getSyntax(transaction).get(); ---- -[#_virtual_bool_TypeDBThingTypeisAbstract___] +[#_virtual_bool_TypeDBThingTypeisAbstract_] ==== isAbstract [source,cpp] @@ -468,7 +468,7 @@ Implements TypeDB::Type. type.isAbstract(); ---- -[#_virtual_BoolFuture_TypeDBThingTypeisDeleted___Transaction__transaction_] +[#_virtual_BoolFuture_TypeDBThingTypeisDeleted_Transaction_transaction_] ==== isDeleted [source,cpp] @@ -505,7 +505,7 @@ a| `transaction` a| The current transaction a| `Transaction&` type.isDeleted(transaction).get(); ---- -[#_bool_TypeDBThingTypeisRoot___] +[#_bool_TypeDBThingTypeisRoot_] ==== isRoot [source,cpp] @@ -529,7 +529,7 @@ Checks if the type is a root type. type.isRoot(); ---- -[#_VoidFuture_TypeDBThingTypesetAbstract___Transaction__transaction_] +[#_VoidFuture_TypeDBThingTypesetAbstract_Transaction_transaction_] ==== setAbstract [source,cpp] @@ -562,7 +562,7 @@ a| `transaction` a| The current transaction a| `Transaction&` thingType.setAbstract(transaction).get(); ---- -[#_virtual_VoidFuture_TypeDBThingTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] +[#_virtual_VoidFuture_TypeDBThingTypesetLabel_Transaction_transaction_const_stdstring_newLabel_] ==== setLabel [source,cpp] @@ -600,7 +600,7 @@ a| `label` a| The new ``Label`` to be given to the type. a| type.setLabel(transaction, newLabel).get(); ---- -[#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__const_stdinitializer_list__Annotation____annotations___] +[#_VoidFuture_TypeDBThingTypesetOwns_Transaction_transaction_AttributeType_ptr_attributeType_const_stdinitializer_list_Annotation_annotations_] ==== setOwns [source,cpp] @@ -612,13 +612,13 @@ VoidFuture TypeDB::ThingType::setOwns(Transaction& transaction, AttributeType* a -Variant of <<#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__AttributeType__ptr__overriddenType__const_stdvector__Annotation____annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector&)>> with no overridden attribute type +Variant of <<#_VoidFuture_TypeDBThingTypesetOwns_Transaction_transaction_AttributeType_ptr_attributeType_AttributeType_ptr_overriddenType_const_stdvector_Annotation_annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector&)>> with no overridden attribute type [caption=""] .Returns `VoidFuture` -[#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__const_stdvector__Annotation____annotations_] +[#_VoidFuture_TypeDBThingTypesetOwns_Transaction_transaction_AttributeType_ptr_attributeType_const_stdvector_Annotation_annotations_] ==== setOwns [source,cpp] @@ -628,13 +628,13 @@ VoidFuture TypeDB::ThingType::setOwns(Transaction& transaction, AttributeType* a -Variant of <<#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__AttributeType__ptr__overriddenType__const_stdvector__Annotation____annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector&)>> with no overridden attribute type +Variant of <<#_VoidFuture_TypeDBThingTypesetOwns_Transaction_transaction_AttributeType_ptr_attributeType_AttributeType_ptr_overriddenType_const_stdvector_Annotation_annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector&)>> with no overridden attribute type [caption=""] .Returns `VoidFuture` -[#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__AttributeType__ptr__overriddenType__const_stdinitializer_list__Annotation____annotations___] +[#_VoidFuture_TypeDBThingTypesetOwns_Transaction_transaction_AttributeType_ptr_attributeType_AttributeType_ptr_overriddenType_const_stdinitializer_list_Annotation_annotations_] ==== setOwns [source,cpp] @@ -644,13 +644,13 @@ VoidFuture TypeDB::ThingType::setOwns(Transaction& transaction, AttributeType* a -See <<#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__AttributeType__ptr__overriddenType__const_stdvector__Annotation____annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector&)>> +See <<#_VoidFuture_TypeDBThingTypesetOwns_Transaction_transaction_AttributeType_ptr_attributeType_AttributeType_ptr_overriddenType_const_stdvector_Annotation_annotations_,setOwns(Transaction&, AttributeType*, AttributeType*, const std::vector&)>> [caption=""] .Returns `VoidFuture` -[#_VoidFuture_TypeDBThingTypesetOwns___Transaction__transaction__AttributeType__ptr__attributeType__AttributeType__ptr__overriddenType__const_stdvector__Annotation____annotations_] +[#_VoidFuture_TypeDBThingTypesetOwns_Transaction_transaction_AttributeType_ptr_attributeType_AttributeType_ptr_overriddenType_const_stdvector_Annotation_annotations_] ==== setOwns [source,cpp] @@ -687,7 +687,7 @@ thingType.setOwns(transaction, attributeType).get(); thingType.setOwns(transaction, attributeType, overriddenType, Collections.singleton(Annotation.key())).get(); ---- -[#_VoidFuture_TypeDBThingTypesetPlays___Transaction__transaction__RoleType__ptr__roleType_] +[#_VoidFuture_TypeDBThingTypesetPlays_Transaction_transaction_RoleType_ptr_roleType_] ==== setPlays [source,cpp] @@ -697,13 +697,13 @@ VoidFuture TypeDB::ThingType::setPlays(Transaction& transaction, RoleType* roleT -Variant of <<#_VoidFuture_TypeDBThingTypesetPlays___Transaction__transaction__RoleType__ptr__roleType__RoleType__ptr__overriddenRoleType_,setPlays(Transaction&, RoleType*, RoleType*)>> with no overridden role type. +Variant of <<#_VoidFuture_TypeDBThingTypesetPlays_Transaction_transaction_RoleType_ptr_roleType_RoleType_ptr_overriddenRoleType_,setPlays(Transaction&, RoleType*, RoleType*)>> with no overridden role type. [caption=""] .Returns `VoidFuture` -[#_VoidFuture_TypeDBThingTypesetPlays___Transaction__transaction__RoleType__ptr__roleType__RoleType__ptr__overriddenRoleType_] +[#_VoidFuture_TypeDBThingTypesetPlays_Transaction_transaction_RoleType_ptr_roleType_RoleType_ptr_overriddenRoleType_] ==== setPlays [source,cpp] @@ -739,7 +739,7 @@ thingType.setPlays(transaction, roleType).get(); thingType.setPlays(transaction, roleType, overriddenType).get(); ---- -[#_VoidFuture_TypeDBThingTypeunsetAbstract___Transaction__transaction_] +[#_VoidFuture_TypeDBThingTypeunsetAbstract_Transaction_transaction_] ==== unsetAbstract [source,cpp] @@ -772,7 +772,7 @@ a| `transaction` a| The current transaction a| `Transaction&` thingType.unsetAbstract(transaction).get(); ---- -[#_VoidFuture_TypeDBThingTypeunsetOwns___Transaction__transaction__AttributeType__ptr__attributeType_] +[#_VoidFuture_TypeDBThingTypeunsetOwns_Transaction_transaction_AttributeType_ptr_attributeType_] ==== unsetOwns [source,cpp] @@ -806,7 +806,7 @@ a| `attributeType` a| The ``AttributeType`` to not be owned by the type. a| `Att thingType.unsetOwns(transaction, attributeType).get(); ---- -[#_VoidFuture_TypeDBThingTypeunsetPlays___Transaction__transaction__RoleType__ptr__roleType_] +[#_VoidFuture_TypeDBThingTypeunsetPlays_Transaction_transaction_RoleType_ptr_roleType_] ==== unsetPlays [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/schema/Type.adoc b/drivers-src/modules/ROOT/partials/cpp/schema/Type.adoc index da1913616..00ef5317c 100644 --- a/drivers-src/modules/ROOT/partials/cpp/schema/Type.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/schema/Type.adoc @@ -12,7 +12,7 @@ Common super-type of RoleType & ThingType. // tag::methods[] -[#_virtual_VoidFuture_TypeDBTypedeleteType___Transaction__transaction_] +[#_virtual_VoidFuture_TypeDBTypedeleteType_Transaction_transaction_] ==== deleteType [source,cpp] @@ -47,7 +47,7 @@ a| `transaction` a| The current transaction a| `Transaction&` type.deleteType(transaction).get(); ---- -[#_virtual_stdstring_TypeDBTypegetLabel___] +[#_virtual_stdstring_TypeDBTypegetLabel_] ==== getLabel [source,cpp] @@ -73,7 +73,7 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. type.getLabel(); ---- -[#_ConceptIterable__Type___TypeDBTypegetSubtypes___Transaction__transaction__Transitivity_transitivity__TransitivityTRANSITIVE_] +[#_ConceptIterable_Type_TypeDBTypegetSubtypes_Transaction_transaction_Transitivity_transitivity_TransitivityTRANSITIVE_] ==== getSubtypes [source,cpp] @@ -108,7 +108,7 @@ type.getSubtypes(transaction); type.getSubtypes(transaction, Transitivity.EXPLICIT); ---- -[#_ConceptPtrFuture__Type___TypeDBTypegetSupertype___Transaction__transaction_] +[#_ConceptPtrFuture_Type_TypeDBTypegetSupertype_Transaction_transaction_] ==== getSupertype [source,cpp] @@ -141,7 +141,7 @@ a| `transaction` a| The current transaction a| `Transaction&` type.getSupertype(transaction).get(); ---- -[#_ConceptIterable__Type___TypeDBTypegetSupertypes___Transaction__transaction_] +[#_ConceptIterable_Type_TypeDBTypegetSupertypes_Transaction_transaction_] ==== getSupertypes [source,cpp] @@ -174,7 +174,7 @@ a| `transaction` a| The current transaction a| `Transaction&` type.getSupertypes(transaction); ---- -[#_virtual_bool_TypeDBTypeisAbstract___] +[#_virtual_bool_TypeDBTypeisAbstract_] ==== isAbstract [source,cpp] @@ -200,7 +200,7 @@ Implemented in TypeDB::RoleType, and TypeDB::ThingType. type.isAbstract(); ---- -[#_virtual_BoolFuture_TypeDBTypeisDeleted___Transaction__transaction_] +[#_virtual_BoolFuture_TypeDBTypeisDeleted_Transaction_transaction_] ==== isDeleted [source,cpp] @@ -235,7 +235,7 @@ a| `transaction` a| The current transaction a| `Transaction&` type.isDeleted(transaction).get(); ---- -[#_virtual_VoidFuture_TypeDBTypesetLabel___Transaction__transaction__const_stdstring__newLabel_] +[#_virtual_VoidFuture_TypeDBTypesetLabel_Transaction_transaction_const_stdstring_newLabel_] ==== setLabel [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/session/Options.adoc b/drivers-src/modules/ROOT/partials/cpp/session/Options.adoc index 2718199cf..0109dd102 100644 --- a/drivers-src/modules/ROOT/partials/cpp/session/Options.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/session/Options.adoc @@ -10,7 +10,7 @@ TypeDB Session and Transaction options. ``Options`` can be used to override the default server behaviour. // tag::methods[] -[#_TypeDBOptionsOptions___] +[#_TypeDBOptionsOptions_] ==== Options [source,cpp] @@ -34,7 +34,7 @@ Produces a new ``Options`` object. TypeDBOptions options = TypeDBOptions(); ---- -[#_stdoptional__bool___TypeDBOptionsexplain___] +[#_stdoptional_bool_TypeDBOptionsexplain_] ==== explain [source,cpp] @@ -58,7 +58,7 @@ Returns the value set for the explanation in this ``TypeDBOptions`` object. If s options.explain(); ---- -[#_Options__TypeDBOptionsexplain___bool_explain_] +[#_Options_TypeDBOptionsexplain_bool_explain_] ==== explain [source,cpp] @@ -91,7 +91,7 @@ a| `explain` a| Explicitly enable or disable explanations a| `bool` options.explain(explain); ---- -[#_stdoptional__bool___TypeDBOptionsinfer___] +[#_stdoptional_bool_TypeDBOptionsinfer_] ==== infer [source,cpp] @@ -115,7 +115,7 @@ Returns the value set for the inference in this ``TypeDBOptions`` object. options.infer(); ---- -[#_Options__TypeDBOptionsinfer___bool_infer_] +[#_Options_TypeDBOptionsinfer_bool_infer_] ==== infer [source,cpp] @@ -148,7 +148,7 @@ a| `infer` a| Explicitly enable or disable inference a| `bool` options.infer(infer); ---- -[#_stdoptional__bool___TypeDBOptionsparallel___] +[#_stdoptional_bool_TypeDBOptionsparallel_] ==== parallel [source,cpp] @@ -172,7 +172,7 @@ Returns the value set for the parallel execution in this ``TypeDBOptions`` objec options.parallel(); ---- -[#_Options__TypeDBOptionsparallel___bool_parallel_] +[#_Options_TypeDBOptionsparallel_bool_parallel_] ==== parallel [source,cpp] @@ -205,7 +205,7 @@ a| `parallel` a| Explicitly enable or disable parallel execution a| `bool` options.parallel(parallel); ---- -[#_stdoptional__bool___TypeDBOptionsprefetch___] +[#_stdoptional_bool_TypeDBOptionsprefetch_] ==== prefetch [source,cpp] @@ -229,7 +229,7 @@ Returns the value set for the prefetching in this ``TypeDBOptions`` object. If s options.prefetch(); ---- -[#_Options__TypeDBOptionsprefetch___bool_prefetch_] +[#_Options_TypeDBOptionsprefetch_bool_prefetch_] ==== prefetch [source,cpp] @@ -262,7 +262,7 @@ a| `prefetch` a| Explicitly enable or disable prefetching a| `bool` options.prefetch(prefetch); ---- -[#_stdoptional__int32_t___TypeDBOptionsprefetchSize___] +[#_stdoptional_int32_t_TypeDBOptionsprefetchSize_] ==== prefetchSize [source,cpp] @@ -286,7 +286,7 @@ Returns the value set for the prefetch size in this ``TypeDBOptions`` object. If options.prefetchSize(); ---- -[#_Options__TypeDBOptionsprefetchSize___int32_t_prefetchSize_] +[#_Options_TypeDBOptionsprefetchSize_int32_t_prefetchSize_] ==== prefetchSize [source,cpp] @@ -319,7 +319,7 @@ a| `prefetchSize` a| Number of answers that the server should send before the dr options.prefetchSize(prefetchSize); ---- -[#_stdoptional__bool___TypeDBOptionsreadAnyReplica___] +[#_stdoptional_bool_TypeDBOptionsreadAnyReplica_] ==== readAnyReplica [source,cpp] @@ -343,7 +343,7 @@ Returns the value set for reading data from any replica in this ``TypeDBOptions` options.readAnyReplica(); ---- -[#_Options__TypeDBOptionsreadAnyReplica___bool_readAnyReplica_] +[#_Options_TypeDBOptionsreadAnyReplica_bool_readAnyReplica_] ==== readAnyReplica [source,cpp] @@ -376,7 +376,7 @@ a| `readAnyReplica` a| Explicitly enable or disable reading data from any replic options.readAnyReplica(readAnyReplica); ---- -[#_stdoptional__int64_t___TypeDBOptionsschemaLockAcquireTimeoutMillis___] +[#_stdoptional_int64_t_TypeDBOptionsschemaLockAcquireTimeoutMillis_] ==== schemaLockAcquireTimeoutMillis [source,cpp] @@ -400,7 +400,7 @@ Returns the value set for the schema lock acquire timeout in this ``TypeDBOption options.schemaLockAcquireTimeoutMillis(); ---- -[#_Options__TypeDBOptionsschemaLockAcquireTimeoutMillis___int64_t_timeoutMillis_] +[#_Options_TypeDBOptionsschemaLockAcquireTimeoutMillis_int64_t_timeoutMillis_] ==== schemaLockAcquireTimeoutMillis [source,cpp] @@ -433,7 +433,7 @@ a| `schemaLockAcquireTimeoutMillis` a| How long the driver should wait if openin options.schemaLockAcquireTimeoutMillis(schemaLockAcquireTimeoutMillis); ---- -[#_stdoptional__int64_t___TypeDBOptionssessionIdleTimeoutMillis___] +[#_stdoptional_int64_t_TypeDBOptionssessionIdleTimeoutMillis_] ==== sessionIdleTimeoutMillis [source,cpp] @@ -457,7 +457,7 @@ Returns the value set for the session idle timeout in this ``TypeDBOptions`` obj options.sessionIdleTimeoutMillis(); ---- -[#_Options__TypeDBOptionssessionIdleTimeoutMillis___int64_t_timeoutMillis_] +[#_Options_TypeDBOptionssessionIdleTimeoutMillis_int64_t_timeoutMillis_] ==== sessionIdleTimeoutMillis [source,cpp] @@ -490,7 +490,7 @@ a| `sessionIdleTimeoutMillis` a| timeout that allows the server to close session options.sessionIdleTimeoutMillis(sessionIdleTimeoutMillis); ---- -[#_stdoptional__bool___TypeDBOptionstraceInference___] +[#_stdoptional_bool_TypeDBOptionstraceInference_] ==== traceInference [source,cpp] @@ -514,7 +514,7 @@ Returns the value set for reasoning tracing in this ``TypeDBOptions`` object. If options.traceInference(); ---- -[#_Options__TypeDBOptionstraceInference___bool_traceInference_] +[#_Options_TypeDBOptionstraceInference_bool_traceInference_] ==== traceInference [source,cpp] @@ -547,7 +547,7 @@ a| `traceInference` a| Explicitly enable or disable reasoning tracing a| `bool` options.traceInference(traceInference); ---- -[#_stdoptional__int64_t___TypeDBOptionstransactionTimeoutMillis___] +[#_stdoptional_int64_t_TypeDBOptionstransactionTimeoutMillis_] ==== transactionTimeoutMillis [source,cpp] @@ -571,7 +571,7 @@ Returns the value set for the transaction timeout in this ``TypeDBOptions`` obje options.transactionTimeoutMillis(); ---- -[#_Options__TypeDBOptionstransactionTimeoutMillis___int64_t_timeoutMillis_] +[#_Options_TypeDBOptionstransactionTimeoutMillis_int64_t_timeoutMillis_] ==== transactionTimeoutMillis [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/session/Session.adoc b/drivers-src/modules/ROOT/partials/cpp/session/Session.adoc index 4ac3f2908..b2f291aa2 100644 --- a/drivers-src/modules/ROOT/partials/cpp/session/Session.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/session/Session.adoc @@ -8,7 +8,7 @@ A session with a TypeDB database. // tag::methods[] -[#_void_TypeDBSessionclose___] +[#_void_TypeDBSessionclose_] ==== close [source,cpp] @@ -32,7 +32,7 @@ Closes the session. Before opening a new session, the session currently open sho session.close(); ---- -[#_stdstring_TypeDBSessiondatabaseName_____const] +[#_stdstring_TypeDBSessiondatabaseName_const] ==== databaseName [source,cpp] @@ -56,7 +56,7 @@ Returns the name of the database of the session. session.databaseName(); ---- -[#_bool_TypeDBSessionisOpen_____const] +[#_bool_TypeDBSessionisOpen_const] ==== isOpen [source,cpp] @@ -80,7 +80,7 @@ Checks whether this session is open. session.isOpen(); ---- -[#_void_TypeDBSessiononClose___stdfunction__void____callback_] +[#_void_TypeDBSessiononClose_stdfunction_void_callback_] ==== onClose [source,cpp] @@ -113,7 +113,7 @@ a| `function` a| The callback function. a| session.onClose(function) ---- -[#_void_TypeDBSessiononReopen___stdfunction__void____callback_] +[#_void_TypeDBSessiononReopen_stdfunction_void_callback_] ==== onReopen [source,cpp] @@ -146,7 +146,7 @@ a| `function` a| The callback function. a| session.onReopen(function) ---- -[#_Transaction_TypeDBSessiontransaction___TransactionType_type__const_Options__options__Options_____const] +[#_Transaction_TypeDBSessiontransaction_TransactionType_type_const_Options_options_Options_const] ==== transaction [source,cpp] @@ -180,7 +180,7 @@ a| `options` a| Options for the session a| session.transaction(transactionType, options); ---- -[#_SessionType_TypeDBSessiontype_____const] +[#_SessionType_TypeDBSessiontype_const] ==== type [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/transaction/QueryManager.adoc b/drivers-src/modules/ROOT/partials/cpp/transaction/QueryManager.adoc index 084e17664..ce3573c50 100644 --- a/drivers-src/modules/ROOT/partials/cpp/transaction/QueryManager.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/transaction/QueryManager.adoc @@ -8,7 +8,7 @@ Provides methods for executing TypeQL queries in the transaction. // tag::methods[] -[#_VoidFuture_TypeDBQueryManagerdefine___const_stdstring__query__const_Options__options__Options_____const] +[#_VoidFuture_TypeDBQueryManagerdefine_const_stdstring_query_const_Options_options_Options_const] ==== define [source,cpp] @@ -42,7 +42,7 @@ a| `options` a| Specify query options a| transaction.query.define(query, options).get() ---- -[#_ExplanationIterable_TypeDBQueryManagerexplain___const_Explainable__explainable__const_Options___Options_____const] +[#_ExplanationIterable_TypeDBQueryManagerexplain_const_Explainable_explainable_const_Options_Options_const] ==== explain [source,cpp] @@ -76,7 +76,7 @@ a| `options` a| Specify query options a| transaction.query.explain(explainable, options) ---- -[#_JSONIterable_TypeDBQueryManagerfetch___const_stdstring__query__const_Options__options__Options_____const] +[#_JSONIterable_TypeDBQueryManagerfetch_const_stdstring_query_const_Options_options_Options_const] ==== fetch [source,cpp] @@ -110,7 +110,7 @@ a| `options` a| Specify query options a| transaction.query.fetch(query, options) ---- -[#_ConceptMapIterable_TypeDBQueryManagerget___const_stdstring__query__const_Options__options__Options_____const] +[#_ConceptMapIterable_TypeDBQueryManagerget_const_stdstring_query_const_Options_options_Options_const] ==== get [source,cpp] @@ -144,7 +144,7 @@ a| `options` a| Specify query options a| transaction.query.get(query, options) ---- -[#_AggregateFuture_TypeDBQueryManagergetAggregate___const_stdstring__query__const_Options___Options_____const] +[#_AggregateFuture_TypeDBQueryManagergetAggregate_const_stdstring_query_const_Options_Options_const] ==== getAggregate [source,cpp] @@ -178,7 +178,7 @@ a| `options` a| Specify query options a| transaction.query.getAggregate(query, options).get() ---- -[#_ConceptMapGroupIterable_TypeDBQueryManagergetGroup___const_stdstring__query__const_Options___Options_____const] +[#_ConceptMapGroupIterable_TypeDBQueryManagergetGroup_const_stdstring_query_const_Options_Options_const] ==== getGroup [source,cpp] @@ -212,7 +212,7 @@ a| `options` a| Specify query options a| transaction.query.getGroup(query, options) ---- -[#_ValueGroupIterable_TypeDBQueryManagergetGroupAggregate___const_stdstring__query__const_Options___Options_____const] +[#_ValueGroupIterable_TypeDBQueryManagergetGroupAggregate_const_stdstring_query_const_Options_Options_const] ==== getGroupAggregate [source,cpp] @@ -246,7 +246,7 @@ a| `options` a| Specify query options a| transaction.query.getGroupAggregate(query, options) ---- -[#_ConceptMapIterable_TypeDBQueryManagerinsert___const_stdstring__query__const_Options__options__Options_____const] +[#_ConceptMapIterable_TypeDBQueryManagerinsert_const_stdstring_query_const_Options_options_Options_const] ==== insert [source,cpp] @@ -280,7 +280,7 @@ a| `options` a| Specify query options a| transaction.query.insert(query, options) ---- -[#_VoidFuture_TypeDBQueryManagermatchDelete___const_stdstring__query__const_Options__options__Options_____const] +[#_VoidFuture_TypeDBQueryManagermatchDelete_const_stdstring_query_const_Options_options_Options_const] ==== matchDelete [source,cpp] @@ -314,7 +314,7 @@ a| `options` a| Specify query options a| transaction.query.matchDelete(query, options).get() ---- -[#_VoidFuture_TypeDBQueryManagerundefine___const_stdstring__query__const_Options__options__Options_____const] +[#_VoidFuture_TypeDBQueryManagerundefine_const_stdstring_query_const_Options_options_Options_const] ==== undefine [source,cpp] @@ -348,7 +348,7 @@ a| `options` a| Specify query options a| transaction.query.undefine(query, options).get() ---- -[#_ConceptMapIterable_TypeDBQueryManagerupdate___const_stdstring__query__const_Options___Options_____const] +[#_ConceptMapIterable_TypeDBQueryManagerupdate_const_stdstring_query_const_Options_Options_const] ==== update [source,cpp] diff --git a/drivers-src/modules/ROOT/partials/cpp/transaction/Transaction.adoc b/drivers-src/modules/ROOT/partials/cpp/transaction/Transaction.adoc index 312e99b29..589c0a170 100644 --- a/drivers-src/modules/ROOT/partials/cpp/transaction/Transaction.adoc +++ b/drivers-src/modules/ROOT/partials/cpp/transaction/Transaction.adoc @@ -21,7 +21,7 @@ a| `query` a| `const QueryManager TypeDB::Transaction` a| The````QueryManager``` // end::properties[] // tag::methods[] -[#_void_TypeDBTransactionclose___] +[#_void_TypeDBTransactionclose_] ==== close [source,cpp] @@ -45,7 +45,7 @@ Closes the transaction. transaction.close() ---- -[#_void_TypeDBTransactioncommit___] +[#_void_TypeDBTransactioncommit_] ==== commit [source,cpp] @@ -69,7 +69,7 @@ Commits the changes made via this transaction to the TypeDB database. Whether or transaction.commit() ---- -[#_void_TypeDBTransactionforceClose___] +[#_void_TypeDBTransactionforceClose_] ==== forceClose [source,cpp] @@ -93,7 +93,7 @@ Closes the transaction. transaction.close() ---- -[#_bool_TypeDBTransactionisOpen_____const] +[#_bool_TypeDBTransactionisOpen_const] ==== isOpen [source,cpp] @@ -117,7 +117,7 @@ Checks whether this transaction is open. transaction.isOpen(); ---- -[#_void_TypeDBTransactiononClose___stdfunction__void_const_stdoptional__DriverException______callback_] +[#_void_TypeDBTransactiononClose_stdfunction_void_const_stdoptional_DriverException_callback_] ==== onClose [source,cpp] @@ -150,7 +150,7 @@ a| `function` a| The callback function. a| transaction.onClose(function); ---- -[#_void_TypeDBTransactionrollback___] +[#_void_TypeDBTransactionrollback_] ==== rollback [source,cpp] @@ -174,7 +174,7 @@ Rolls back the uncommitted changes made via this transaction. transaction.rollback() ---- -[#_TypeDBTransactionType_TypeDBTransactiontype_____const] +[#_TypeDBTransactionType_TypeDBTransactiontype_const] ==== type [source,cpp]