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="block">Retrieves a database client configured to interact with the Data API.</div>
196
196
</div>
197
197
<divclass="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="databases/Database.html" title="class in com.datastax.astra.client.databases">Database</a></code></div>
198
-
<divclass="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="#getDatabase(java.util.UUID)" class="member-name-link">getDatabase</a><wbr>(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> databaseId)</code></div>
198
+
<divclass="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="#getDatabase(java.lang.String,java.lang.String)" class="member-name-link">getDatabase</a><wbr>(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> apiEndpoint,
199
+
<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> keyspace)</code></div>
<divclass="block">Retrieves a database client configured to connect to the Data API using a database identifier,
207
213
with custom <ahref="databases/DatabaseOptions.html" title="class in com.datastax.astra.client.databases"><code>DatabaseOptions</code></a>.</div>
208
214
</div>
209
-
<divclass="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="databases/Database.html" title="class in com.datastax.astra.client.databases">Database</a></code></div>
210
-
<divclass="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="#getDatabase(java.util.UUID,java.lang.String,com.datastax.astra.client.databases.DatabaseOptions)" class="member-name-link">getDatabase</a><wbr>(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> databaseId,
215
+
<divclass="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="databases/Database.html" title="class in com.datastax.astra.client.databases">Database</a></code></div>
216
+
<divclass="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="#getDatabase(java.util.UUID,java.lang.String,com.datastax.astra.client.databases.DatabaseOptions)" class="member-name-link">getDatabase</a><wbr>(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/UUID.html" title="class or interface in java.util" class="external-link">UUID</a> databaseId,
211
217
<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> region,
212
218
<ahref="databases/DatabaseOptions.html" title="class in com.datastax.astra.client.databases">DatabaseOptions</a> dbOptions)</code></div>
<divclass="block">Retrieves a database client configured to connect to the Data API using a database identifier,
215
221
a specified region, and custom <ahref="databases/DatabaseOptions.html" title="class in com.datastax.astra.client.databases"><code>DatabaseOptions</code></a>.</div>
216
222
</div>
217
-
<divclass="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><ahref="core/options/DataAPIClientOptions.html" title="class in com.datastax.astra.client.core.options">DataAPIClientOptions</a></code></div>
<dd><code>adminOptions</code> - The options to configure the administration client, including the authentication token.</dd>
393
401
<dt>Returns:</dt>
394
402
<dd>An instance of <ahref="admin/AstraDBAdmin.html" title="class in com.datastax.astra.client.admin"><code>AstraDBAdmin</code></a> configured with the appropriate authentication token and options,
395
-
ready for administrative operations.</dd>
403
+
ready for administrative operations.</dd>
396
404
</dl>
397
405
</section>
398
406
</li>
@@ -476,6 +484,9 @@ <h3>getDatabase</h3>
476
484
</code>
477
485
</pre></div>
478
486
<dlclass="notes">
487
+
<dt>Parameters:</dt>
488
+
<dd><code>apiEndpoint</code> - The URL of the Data API endpoint to connect to.</dd>
489
+
<dd><code>dbOptions</code> - The options to configure the database client.</dd>
479
490
<dt>Returns:</dt>
480
491
<dd>A <ahref="databases/Database.html" title="class in com.datastax.astra.client.databases"><code>Database</code></a> client tailored for interaction with the Data API, configured according to the
<divclass="member-signature"><spanclass="modifiers">public</span> <spanclass="return-type"><ahref="databases/Database.html" title="class in com.datastax.astra.client.databases">Database</a></span> <spanclass="element-name">getDatabase</span><wbr><spanclass="parameters">(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> apiEndpoint,
502
+
<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> keyspace)</span></div>
503
+
<divclass="block">Retrieves a database client configured to connect to the Data API using the specified API endpoint and keyspace.
504
+
<p>
505
+
Uses default <ahref="databases/DatabaseOptions.html" title="class in com.datastax.astra.client.databases"><code>DatabaseOptions</code></a> for configuration.
506
+
</p></div>
507
+
<dlclass="notes">
508
+
<dt>Parameters:</dt>
509
+
<dd><code>apiEndpoint</code> - The URL of the Data API endpoint to connect to.</dd>
510
+
<dd><code>keyspace</code> - The name of the keyspace to use for database operations.</dd>
511
+
<dt>Returns:</dt>
512
+
<dd>A <ahref="databases/Database.html" title="class in com.datastax.astra.client.databases"><code>Database</code></a> client configured with default options for the specified endpoint and keyspace.</dd>
<divclass="member-signature"><spanclass="modifiers">public</span> <spanclass="return-type"><ahref="databases/Database.html" title="class in com.datastax.astra.client.databases">Database</a></span> <spanclass="element-name">getDatabase</span><wbr><spanclass="parameters">(<ahref="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> apiEndpoint)</span></div>
0 commit comments