You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<divclass="type-signature"><spanclass="modifiers">public class </span><spanclass="element-name type-name-label">DataAPIClients</span>
95
95
<spanclass="extends-implements">extends <ahref="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
96
-
<divclass="block">Initialization of the client in a Static way.</div>
96
+
<divclass="block">Help to initialize the Data API client in multiple configuration and environments by settings the proper options</div>
<divclass="col-first even-row-color"><code>static final <ahref="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<divclass="block">Default Http endpoint for local deployment (http://localhost:8181).</div>
113
113
</div>
114
114
</div>
115
115
</section>
@@ -168,15 +168,15 @@ <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from cl
168
168
<h2>Field Details</h2>
169
169
<ulclass="member-list">
170
170
<li>
171
-
<sectionclass="detail" id="DEFAULT_ENDPOINT">
172
-
<h3>DEFAULT_ENDPOINT</h3>
173
-
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <spanclass="element-name">DEFAULT_ENDPOINT</span></div>
<divclass="member-signature"><spanclass="modifiers">public static final</span> <spanclass="return-type"><ahref="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <spanclass="element-name">DEFAULT_ENDPOINT_LOCAL</span></div>
174
+
<divclass="block">Default Http endpoint for local deployment (http://localhost:8181).</div>
175
175
<dlclass="notes">
176
176
<dt>See Also:</dt>
177
177
<dd>
178
178
<ulclass="tag-list">
179
-
<li><ahref="../../../../constant-values.html#com.datastax.astra.client.DataAPIClients.DEFAULT_ENDPOINT">Constant Field Values</a></li>
179
+
<li><ahref="../../../../constant-values.html#com.datastax.astra.client.DataAPIClients.DEFAULT_ENDPOINT_LOCAL">Constant Field Values</a></li>
<divclass="type-signature"><spanclass="modifiers">public class </span><spanclass="element-name type-name-label">Database</span>
101
101
<spanclass="extends-implements">extends <ahref="../internal/AbstractCommandRunner.html" title="class in com.datastax.astra.internal">AbstractCommandRunner</a></span></div>
102
-
<divclass="block">Class to interact with a Namespace.</div>
102
+
<divclass="block">A Data API database. This is the entry-point object for doing database-level
103
+
DML, such as creating/deleting collections, and for obtaining Collection
104
+
objects themselves. This class has a synchronous interface.
105
+
<p>
106
+
A Database comes with an "API Endpoint", which implies a Database object
107
+
instance reaches a specific region (relevant point in case of multi-region
<divclass="block">Gets the names of all the collections in this database.</div>
249
256
</div>
250
-
<divclass="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a><wbr><<ahref="model/CollectionDefinition.html" title="class in com.datastax.astra.client.model">CollectionDefinition</a>></code></div>
257
+
<divclass="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a><wbr><<ahref="model/CollectionInfo.html" title="class in com.datastax.astra.client.model">CollectionInfo</a>></code></div>
<divclass="block">Finds all the collections in this database.</div>
@@ -343,7 +350,7 @@ <h3>getDatabaseAdmin</h3>
343
350
<divclass="block">Gets the name of the database.</div>
344
351
<dlclass="notes">
345
352
<dt>Parameters:</dt>
346
-
<dd><code>superUserToken</code> - provide a token with super user role</dd>
353
+
<dd><code>superUserToken</code> - provide a token with a super-user role</dd>
347
354
<dt>Returns:</dt>
348
355
<dd>the database name</dd>
349
356
</dl>
@@ -363,7 +370,7 @@ <h3>listCollectionNames</h3>
363
370
<li>
364
371
<sectionclass="detail" id="listCollections()">
365
372
<h3>listCollections</h3>
366
-
<divclass="member-signature"><spanclass="modifiers">public</span> <spanclass="return-type"><ahref="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a><<ahref="model/CollectionDefinition.html" title="class in com.datastax.astra.client.model">CollectionDefinition</a>></span> <spanclass="element-name">listCollections</span>()</div>
373
+
<divclass="member-signature"><spanclass="modifiers">public</span> <spanclass="return-type"><ahref="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/stream/Stream.html" title="class or interface in java.util.stream" class="external-link">Stream</a><<ahref="model/CollectionInfo.html" title="class in com.datastax.astra.client.model">CollectionInfo</a>></span> <spanclass="element-name">listCollections</span>()</div>
367
374
<divclass="block">Finds all the collections in this database.</div>
<divclass="member-signature"><spanclass="modifiers">public</span> <spanclass="return-type"><ahref="../model/DatabaseInfo.html" title="class in com.datastax.astra.client.model">DatabaseInfo</a></span> <spanclass="element-name">getDatabaseInfo</span><wbr><spanclass="parameters">(@NonNull
464
464
@NonNull <ahref="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> id)</span></div>
465
465
<divclass="block">Find database information from its id.</div>
0 commit comments