blob: 68816c9c5ed28e7f859ead267202c1b274a1da8b [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_382) on Tue Sep 09 01:15:19 PDT 2025 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Overview (Apache Cassandra Java Driver 4.18.1 API)</title>
<meta name="date" content="2025-09-09">
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
<script type="text/javascript" src="script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Overview (Apache Cassandra Java Driver 4.18.1 API)";
}
}
catch(err) {
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 class="title">Apache Cassandra Java Driver 4.18.1 API</h1>
</div>
<div class="contentContainer">
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Packages table, listing packages, and an explanation">
<caption><span>Packages</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Package</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/package-summary.html">com.datastax.dse.driver.api.core</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/auth/package-summary.html">com.datastax.dse.driver.api.core.auth</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/config/package-summary.html">com.datastax.dse.driver.api.core.config</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/cql/continuous/package-summary.html">com.datastax.dse.driver.api.core.cql.continuous</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/cql/continuous/reactive/package-summary.html">com.datastax.dse.driver.api.core.cql.continuous.reactive</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/cql/reactive/package-summary.html">com.datastax.dse.driver.api.core.cql.reactive</a></td>
<td class="colLast">
<div class="block">Types related to CQL execution using reactive-style programming.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/data/geometry/package-summary.html">com.datastax.dse.driver.api.core.data.geometry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/data/time/package-summary.html">com.datastax.dse.driver.api.core.data.time</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/graph/package-summary.html">com.datastax.dse.driver.api.core.graph</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/graph/predicates/package-summary.html">com.datastax.dse.driver.api.core.graph.predicates</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/graph/reactive/package-summary.html">com.datastax.dse.driver.api.core.graph.reactive</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/metadata/package-summary.html">com.datastax.dse.driver.api.core.metadata</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/metadata/schema/package-summary.html">com.datastax.dse.driver.api.core.metadata.schema</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/metrics/package-summary.html">com.datastax.dse.driver.api.core.metrics</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/servererrors/package-summary.html">com.datastax.dse.driver.api.core.servererrors</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/type/package-summary.html">com.datastax.dse.driver.api.core.type</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/core/type/codec/package-summary.html">com.datastax.dse.driver.api.core.type.codec</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/mapper/reactive/package-summary.html">com.datastax.dse.driver.api.mapper.reactive</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/querybuilder/package-summary.html">com.datastax.dse.driver.api.querybuilder</a></td>
<td class="colLast">
<div class="block">This package effectively mirrors the Cassandra OSS Query Builder package to allow DSE extended
schema and query building for the DSE driver.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/dse/driver/api/querybuilder/schema/package-summary.html">com.datastax.dse.driver.api.querybuilder.schema</a></td>
<td class="colLast">
<div class="block">This package effectively mirrors the Cassandra OSS Schema interfaces to allow extended schema and
query building for the DSE driver.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/package-summary.html">com.datastax.oss.driver.api</a></td>
<td class="colLast">
<div class="block">The driver's public API.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/package-summary.html">com.datastax.oss.driver.api.core</a></td>
<td class="colLast">
<div class="block">The core API of the driver, that deals with query execution and cluster metadata.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/addresstranslation/package-summary.html">com.datastax.oss.driver.api.core.addresstranslation</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/auth/package-summary.html">com.datastax.oss.driver.api.core.auth</a></td>
<td class="colLast">
<div class="block">Support for authentication between the driver and Cassandra nodes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/config/package-summary.html">com.datastax.oss.driver.api.core.config</a></td>
<td class="colLast">
<div class="block">The configuration of the driver.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/connection/package-summary.html">com.datastax.oss.driver.api.core.connection</a></td>
<td class="colLast">
<div class="block">Types related to a connection to a Cassandra node.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/context/package-summary.html">com.datastax.oss.driver.api.core.context</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/cql/package-summary.html">com.datastax.oss.driver.api.core.cql</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/data/package-summary.html">com.datastax.oss.driver.api.core.data</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/detach/package-summary.html">com.datastax.oss.driver.api.core.detach</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/loadbalancing/package-summary.html">com.datastax.oss.driver.api.core.loadbalancing</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/metadata/package-summary.html">com.datastax.oss.driver.api.core.metadata</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/metadata/schema/package-summary.html">com.datastax.oss.driver.api.core.metadata.schema</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/metadata/token/package-summary.html">com.datastax.oss.driver.api.core.metadata.token</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/metrics/package-summary.html">com.datastax.oss.driver.api.core.metrics</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/paging/package-summary.html">com.datastax.oss.driver.api.core.paging</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/retry/package-summary.html">com.datastax.oss.driver.api.core.retry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/servererrors/package-summary.html">com.datastax.oss.driver.api.core.servererrors</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/session/package-summary.html">com.datastax.oss.driver.api.core.session</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/session/throttling/package-summary.html">com.datastax.oss.driver.api.core.session.throttling</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/specex/package-summary.html">com.datastax.oss.driver.api.core.specex</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/ssl/package-summary.html">com.datastax.oss.driver.api.core.ssl</a></td>
<td class="colLast">
<div class="block">Support for secured communication between the driver and Cassandra nodes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/time/package-summary.html">com.datastax.oss.driver.api.core.time</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/tracker/package-summary.html">com.datastax.oss.driver.api.core.tracker</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/type/package-summary.html">com.datastax.oss.driver.api.core.type</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/type/codec/package-summary.html">com.datastax.oss.driver.api.core.type.codec</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/type/codec/registry/package-summary.html">com.datastax.oss.driver.api.core.type.codec.registry</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/type/reflect/package-summary.html">com.datastax.oss.driver.api.core.type.reflect</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/core/uuid/package-summary.html">com.datastax.oss.driver.api.core.uuid</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/mapper/package-summary.html">com.datastax.oss.driver.api.mapper</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/mapper/annotations/package-summary.html">com.datastax.oss.driver.api.mapper.annotations</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/mapper/entity/package-summary.html">com.datastax.oss.driver.api.mapper.entity</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/mapper/entity/naming/package-summary.html">com.datastax.oss.driver.api.mapper.entity.naming</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/mapper/entity/saving/package-summary.html">com.datastax.oss.driver.api.mapper.entity.saving</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/mapper/result/package-summary.html">com.datastax.oss.driver.api.mapper.result</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/querybuilder/package-summary.html">com.datastax.oss.driver.api.querybuilder</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/querybuilder/condition/package-summary.html">com.datastax.oss.driver.api.querybuilder.condition</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/querybuilder/delete/package-summary.html">com.datastax.oss.driver.api.querybuilder.delete</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/querybuilder/insert/package-summary.html">com.datastax.oss.driver.api.querybuilder.insert</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/querybuilder/relation/package-summary.html">com.datastax.oss.driver.api.querybuilder.relation</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/querybuilder/schema/package-summary.html">com.datastax.oss.driver.api.querybuilder.schema</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/querybuilder/schema/compaction/package-summary.html">com.datastax.oss.driver.api.querybuilder.schema.compaction</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/querybuilder/select/package-summary.html">com.datastax.oss.driver.api.querybuilder.select</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/querybuilder/term/package-summary.html">com.datastax.oss.driver.api.querybuilder.term</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/querybuilder/truncate/package-summary.html">com.datastax.oss.driver.api.querybuilder.truncate</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/querybuilder/update/package-summary.html">com.datastax.oss.driver.api.querybuilder.update</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/testinfra/package-summary.html">com.datastax.oss.driver.api.testinfra</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/testinfra/ccm/package-summary.html">com.datastax.oss.driver.api.testinfra.ccm</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/testinfra/loadbalancing/package-summary.html">com.datastax.oss.driver.api.testinfra.loadbalancing</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/testinfra/requirement/package-summary.html">com.datastax.oss.driver.api.testinfra.requirement</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/testinfra/session/package-summary.html">com.datastax.oss.driver.api.testinfra.session</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/testinfra/simulacron/package-summary.html">com.datastax.oss.driver.api.testinfra.simulacron</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/api/testinfra/utils/package-summary.html">com.datastax.oss.driver.api.testinfra.utils</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/assertions/package-summary.html">com.datastax.oss.driver.assertions</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="com/datastax/oss/driver/categories/package-summary.html">com.datastax.oss.driver.categories</a></td>
<td class="colLast">&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="com/datastax/oss/driver/internal/package-summary.html">com.datastax.oss.driver.internal</a></td>
<td class="colLast">
<div class="block">Internal implementation details of the driver.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li class="navBarCell1Rev">Overview</li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="overview-tree.html">Tree</a></li>
<li><a href="deprecated-list.html">Deprecated</a></li>
<li><a href="index-all.html">Index</a></li>
<li><a href="help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev</li>
<li>Next</li>
</ul>
<ul class="navList">
<li><a href="index.html?overview-summary.html" target="_top">Frames</a></li>
<li><a href="overview-summary.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2017&#x2013;2025 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>