Skip to content

Commit 0273b6c

Browse files
Regenerate docs
1 parent 7925f5f commit 0273b6c

File tree

6 files changed

+21
-0
lines changed

6 files changed

+21
-0
lines changed

docs/modules/ROOT/partials/java/connection/Database.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
[source,java]
1111
----
1212
void delete()
13+
throws TypeDBDriverException
1314
----
1415

1516
Deletes this database.
@@ -48,6 +49,7 @@ The database name as a string.
4849
----
4950
@CheckReturnValue
5051
java.lang.String schema()
52+
throws TypeDBDriverException
5153
----
5254

5355
A full schema text as a valid TypeQL define query string.
@@ -71,6 +73,7 @@ database.schema()
7173
----
7274
@CheckReturnValue
7375
java.lang.String typeSchema()
76+
throws TypeDBDriverException
7477
----
7578

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

docs/modules/ROOT/partials/java/connection/DatabaseManager.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Provides access to all database management methods.
1313
----
1414
@CheckReturnValue
1515
java.util.List<Database> all()
16+
throws TypeDBDriverException
1617
----
1718

1819
Retrieves all databases present on the TypeDB server
@@ -36,6 +37,7 @@ driver.databases().all()
3637
----
3738
@CheckReturnValue
3839
boolean contains​(java.lang.String name)
40+
throws TypeDBDriverException
3941
----
4042
4143
Checks if a database with the given name exists
@@ -67,6 +69,7 @@ driver.databases().contains(name)
6769
[source,java]
6870
----
6971
void create​(java.lang.String name)
72+
throws TypeDBDriverException
7073
----
7174
7275
Create a database with the given name
@@ -99,6 +102,7 @@ driver.databases().create(name)
99102
----
100103
@CheckReturnValue
101104
Database get​(java.lang.String name)
105+
throws TypeDBDriverException
102106
----
103107
104108
Retrieve the database with the given name.

docs/modules/ROOT/partials/java/connection/Driver.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ driver.isOpen();
8787
@CheckReturnValue
8888
Transaction transaction​(java.lang.String database,
8989
Transaction.Type type)
90+
throws TypeDBDriverException
9091
----
9192
9293
Opens a communication tunnel (transaction) to the given database on the running TypeDB server.

docs/modules/ROOT/partials/java/connection/TypeDB.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ public TypeDB()
3737
public static Driver cloudDriver​(java.lang.String address,
3838
Credentials credentials,
3939
DriverOptions driverOptions)
40+
throws TypeDBDriverException
4041
----
4142
4243
Open a TypeDB Driver to a TypeDB Cloud server available at the provided address, using the provided credential.
@@ -72,6 +73,7 @@ TypeDB.cloudDriver(address, credential);
7273
public static Driver cloudDriver​(java.util.Set<java.lang.String> addresses,
7374
Credentials credentials,
7475
DriverOptions driverOptions)
76+
throws TypeDBDriverException
7577
----
7678
7779
Open a TypeDB Driver to TypeDB Cloud server(s) available at the provided addresses, using the provided credential.
@@ -107,6 +109,7 @@ TypeDB.cloudDriver(addresses, credential);
107109
public static Driver cloudDriver​(java.util.Map<java.lang.String,​java.lang.String> addressTranslation,
108110
Credentials credentials,
109111
DriverOptions driverOptions)
112+
throws TypeDBDriverException
110113
----
111114

112115
Open a TypeDB Driver to TypeDB Cloud server(s), using provided address translation, with the provided credential.
@@ -142,6 +145,7 @@ TypeDB.cloudDriver(addressTranslation, credential);
142145
public static Driver coreDriver​(java.lang.String address,
143146
Credentials credentials,
144147
DriverOptions driverOptions)
148+
throws TypeDBDriverException
145149
----
146150
147151
Open a TypeDB Driver to a TypeDB Core server available at the provided address.

docs/modules/ROOT/partials/java/connection/UserManager.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Provides access to all user management methods.
1212
[source,java]
1313
----
1414
java.util.Set<User> all()
15+
throws TypeDBDriverException
1516
----
1617

1718
Retrieves all users which exist on the TypeDB server.
@@ -35,6 +36,7 @@ driver.users().all();
3536
----
3637
@CheckReturnValue
3738
boolean contains​(java.lang.String username)
39+
throws TypeDBDriverException
3840
----
3941
4042
Checks if a user with the given name exists.
@@ -67,6 +69,7 @@ driver.users().contains(username);
6769
----
6870
void create​(java.lang.String username,
6971
java.lang.String password)
72+
throws TypeDBDriverException
7073
----
7174
7275
Creates a user with the given name &amp; password.
@@ -100,6 +103,7 @@ driver.users().create(username, password);
100103
----
101104
@CheckReturnValue
102105
User get​(java.lang.String username)
106+
throws TypeDBDriverException
103107
----
104108
105109
Retrieves a user with the given name.
@@ -132,6 +136,7 @@ driver.users().get(username);
132136
----
133137
@CheckReturnValue
134138
User getCurrentUser()
139+
throws TypeDBDriverException
135140
----
136141

137142
Retrieves the name of the user who opened the current connection.

docs/modules/ROOT/partials/java/transaction/Transaction.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
[source,java]
1515
----
1616
void close()
17+
throws TypeDBDriverException
1718
----
1819

1920
Closes the transaction.
@@ -36,6 +37,7 @@ transaction.close()
3637
[source,java]
3738
----
3839
void commit()
40+
throws TypeDBDriverException
3941
----
4042

4143
Commits the changes made via this transaction to the TypeDB database. Whether or not the transaction is commited successfully, it gets closed after the commit call.
@@ -136,6 +138,7 @@ transaction.onClose(function);
136138
----
137139
@CheckReturnValue
138140
Promise<? extends QueryAnswer> query​(java.lang.String query)
141+
throws TypeDBDriverException
139142
----
140143
141144
Execute a TypeQL query in this transaction.
@@ -168,6 +171,7 @@ a| `query` a| The query to execute. a| `java.lang.String`
168171
[source,java]
169172
----
170173
void rollback()
174+
throws TypeDBDriverException
171175
----
172176

173177
Rolls back the uncommitted changes made via this transaction.

0 commit comments

Comments
 (0)