> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# com.gpudb (package)

> com.gpudb (package) — Kinetica Java API

<div className="kinetica-javadoc">
  <div className="header">
    <h1 title="Package com.gpudb" className="title">Package com.gpudb</h1>
  </div>

  <hr />

  <div className="package-signature">package <span className="element-name">com.gpudb</span></div>

  <div className="section summary">
    <ul className="summary-list">
      <li>
        <div id="related-package-summary">
          <div className="caption"><span>Related Packages</span></div>

          <div className="summary-table two-column-summary">
            <div className="table-header col-first">Package</div>
            <div className="table-header col-last">Description</div>
            <div className="col-first even-row-color"><a href="/content/api/java/com/gpudb/filesystem/package-summary">com.gpudb.filesystem</a></div>
            <div className="col-last even-row-color"> </div>
            <div className="col-first odd-row-color"><a href="/content/api/java/com/gpudb/protocol/package-summary">com.gpudb.protocol</a></div>
            <div className="col-last odd-row-color"> </div>
          </div>
        </div>
      </li>

      <li>
        <div id="class-summary">
          <div className="table-tabs" role="tablist" aria-orientation="horizontal"><button id="class-summary-tab0" role="tab" aria-selected="true" aria-controls="class-summary.tabpanel" tabIndex="0" className="active-table-tab">All Classes and Interfaces</button><button id="class-summary-tab1" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabIndex="-1" className="table-tab">Interfaces</button><button id="class-summary-tab2" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabIndex="-1" className="table-tab">Classes</button><button id="class-summary-tab3" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabIndex="-1" className="table-tab">Enums</button><button id="class-summary-tab5" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabIndex="-1" className="table-tab">Exception Classes</button><button id="class-summary-tab6" role="tab" aria-selected="false" aria-controls="class-summary.tabpanel" tabIndex="-1" className="table-tab">Annotation Types</button></div>

          <div id="class-summary.tabpanel" role="tabpanel" aria-labelledby="class-summary-tab0">
            <div className="summary-table two-column-summary">
              <div className="table-header col-first">Class</div>
              <div className="table-header col-last">Description</div>
              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/Avro" title="class in com.gpudb">Avro</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                <div className="block">Utility class containing static methods for encoding and decoding Avro binary objects.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/BulkInserter" title="class in com.gpudb">BulkInserter</a>\<T></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">Object that manages the insertion into GPUdb of large numbers of records in bulk, with automatic batch management and support for multi-head ingest.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/BulkInserter.FlushOptions" title="class in com.gpudb">BulkInserter.FlushOptions</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                <div className="block">This class facilitates customizing the behavior of automatic flush in <a href="/content/api/java/com/gpudb/BulkInserter" title="class in com.gpudb"><code>BulkInserter</code></a> The default value of the 'flushInterval' is set to a negative value to indicate that the automatic flush feature is not needed.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab5"><a href="/content/api/java/com/gpudb/BulkInserter.InsertException" title="class in com.gpudb">BulkInserter.InsertException</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab5">
                <div className="block">An exception that occurred during the insertion of records into GPUdb.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/BulkInserter.WorkerList" title="class in com.gpudb">BulkInserter.WorkerList</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                Deprecated, for removal: This API element is subject to removal in a future version.
                <div className="deprecation-comment">This class has been superseded by <a href="/content/api/java/com/gpudb/WorkerList" title="class in com.gpudb"><code>com.gpudb.WorkerList</code></a>.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/ColumnProperty" title="class in com.gpudb">ColumnProperty</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">Column properties used for GPUdb types.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GenericRecord" title="class in com.gpudb">GenericRecord</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                <div className="block">An object that contains <a href="/content/api/java/com/gpudb/Record" title="interface in com.gpudb"><code>Record</code></a> data based on a GPUdb <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb"><code>Type</code></a> specified at runtime.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">Object that provides access to a specific GPUdb server.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GPUdbBase" title="class in com.gpudb">GPUdbBase</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                <div className="block">Base class for the GPUdb API that provides general functionality not specific to any particular GPUdb request.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GPUdbBase.ClusterAddressInfo" title="class in com.gpudb">GPUdbBase.ClusterAddressInfo</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">Helper class which contains all possible address related information for a given Kinetica cluster.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GPUdbBase.FailbackOptions" title="class in com.gpudb">GPUdbBase.FailbackOptions</a></div>
              <div className="col-last even-row-color class-summary class-summary-tab2"> </div>
              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GPUdbBase.GetRecordsJsonResponse" title="class in com.gpudb">GPUdbBase.GetRecordsJsonResponse</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">This class models the response returned by the method <a href="/content/api/java/com/gpudb/GPUdbBase#getRecordsJson(java.lang.String,java.util.List,long,long)"><code>GPUdbBase.getRecordsJson(java.lang.String, java.util.List\<java.lang.String>, long, long)</code></a> The default constructor is used to create instance whenever there is an error encountered by the method <a href="/content/api/java/com/gpudb/GPUdbBase#getRecordsJson(java.lang.String,java.util.List,long,long)"><code>GPUdbBase.getRecordsJson(java.lang.String, java.util.List\<java.lang.String>, long, long)</code></a>.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab5"><a href="/content/api/java/com/gpudb/GPUdbBase.GPUdbExitException" title="class in com.gpudb">GPUdbBase.GPUdbExitException</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab5">
                <div className="block">A special exception indicating the server is shutting down</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab5"><a href="/content/api/java/com/gpudb/GPUdbBase.GPUdbFailoverDisabledException" title="class in com.gpudb">GPUdbBase.GPUdbFailoverDisabledException</a></div>
              <div className="col-last odd-row-color class-summary class-summary-tab5"> </div>
              <div className="col-first even-row-color class-summary class-summary-tab5"><a href="/content/api/java/com/gpudb/GPUdbBase.GPUdbHAUnavailableException" title="class in com.gpudb">GPUdbBase.GPUdbHAUnavailableException</a></div>
              <div className="col-last even-row-color class-summary class-summary-tab5"> </div>
              <div className="col-first odd-row-color class-summary class-summary-tab5"><a href="/content/api/java/com/gpudb/GPUdbBase.GPUdbHostnameRegexFailureException" title="class in com.gpudb">GPUdbBase.GPUdbHostnameRegexFailureException</a></div>
              <div className="col-last odd-row-color class-summary class-summary-tab5"> </div>
              <div className="col-first even-row-color class-summary class-summary-tab5"><a href="/content/api/java/com/gpudb/GPUdbBase.GPUdbUnauthorizedAccessException" title="class in com.gpudb">GPUdbBase.GPUdbUnauthorizedAccessException</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab5">
                <div className="block">Indicates that there is an authorization-related problem occurred.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GPUdbBase.GPUdbVersion" title="class in com.gpudb">GPUdbBase.GPUdbVersion</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">Contains the version of the client API or the GPUdb server.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab3"><a href="/content/api/java/com/gpudb/GPUdbBase.HAFailoverOrder" title="enum in com.gpudb">GPUdbBase.HAFailoverOrder</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab3">
                <div className="block">A enumeration of high-availability (inter-cluster) failover order.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab3"><a href="/content/api/java/com/gpudb/GPUdbBase.HASynchronicityMode" title="enum in com.gpudb">GPUdbBase.HASynchronicityMode</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab3">
                <div className="block">A enumeration of high-availability synchronicity override modes.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GPUdbBase.InsertRecordsJsonRequest" title="class in com.gpudb">GPUdbBase.InsertRecordsJsonRequest</a></div>
              <div className="col-last even-row-color class-summary class-summary-tab2"> </div>
              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GPUdbBase.JsonOptions" title="class in com.gpudb">GPUdbBase.JsonOptions</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">This class provides options to control JSON ingest using <a href="/content/api/java/com/gpudb/BulkInserter" title="class in com.gpudb"><code>BulkInserter</code></a>.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GPUdbBase.Options" title="class in com.gpudb">GPUdbBase.Options</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                <div className="block">A set of configurable options for the GPUdb API.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab5"><a href="/content/api/java/com/gpudb/GPUdbBase.SubmitException" title="class in com.gpudb">GPUdbBase.SubmitException</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab5">
                <div className="block">An exception that occurred during the submission of a request to GPUdb.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab5"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab5">
                <div className="block">An exception that occurred during a GPUdb-related operation.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GPUdbLogger" title="class in com.gpudb">GPUdbLogger</a></div>
              <div className="col-last odd-row-color class-summary class-summary-tab2"> </div>
              <div className="col-first even-row-color class-summary class-summary-tab5"><a href="/content/api/java/com/gpudb/GPUdbRuntimeException" title="class in com.gpudb">GPUdbRuntimeException</a></div>
              <div className="col-last even-row-color class-summary class-summary-tab5"> </div>
              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/GPUdbSqlIterator" title="class in com.gpudb">GPUdbSqlIterator</a>\<T extends <a href="/content/api/java/com/gpudb/Record" title="interface in com.gpudb">Record</a>></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">Kinetica API class for iterating over records returned by executing an SQL query.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab6"><a href="/content/api/java/com/gpudb/InternalAPI" title="annotation in com.gpudb">InternalAPI</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab6">
                <div className="block">This annotation marks classes and methods which may be public for any reason (to support better testing or reduce code duplication) but are not intended as public API and may change between releases without the change being considered a breaking API change (a major release).</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab1"><a href="/content/api/java/com/gpudb/Record" title="interface in com.gpudb">Record</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab1">
                <div className="block">Interface for objects that contain record data.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/RecordBase" title="class in com.gpudb">RecordBase</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                <div className="block">Abstract class that provides default implementations of most methods of <a href="/content/api/java/com/gpudb/Record" title="interface in com.gpudb"><code>Record</code></a>.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/RecordObject" title="class in com.gpudb">RecordObject</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">Abstract base class for objects that contain <a href="/content/api/java/com/gpudb/Record" title="interface in com.gpudb"><code>Record</code></a> data with a schema defined at compile time.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab6"><a href="/content/api/java/com/gpudb/RecordObject.Column" title="annotation in com.gpudb">RecordObject.Column</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab6">
                <div className="block">Indicates that a public field is a GPUdb type column.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab6"><a href="/content/api/java/com/gpudb/RecordObject.Type" title="annotation in com.gpudb">RecordObject.Type</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab6">
                <div className="block">Provides additional information about a GPUdb type.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb">RecordRetriever</a>\<T></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                <div className="block">Object that permits efficient retrieval of records from GPUdb, with support for multi-head access.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb">Type</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">Immutable collection of metadata about a GPUdb type.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/Type.Column" title="class in com.gpudb">Type.Column</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                <div className="block">Immutable collection of metadata about a column that is part of a GPUdb type.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab3"><a href="/content/api/java/com/gpudb/Type.Column.ColumnBaseType" title="enum in com.gpudb">Type.Column.ColumnBaseType</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab3">
                <div className="block">An enumeration of base types for column (excluding any property-related subtypes).</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab3"><a href="/content/api/java/com/gpudb/Type.Column.ColumnType" title="enum in com.gpudb">Type.Column.ColumnType</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab3">
                <div className="block">An enumeration of all the Kinetica column types (including sub-types that are determined by the properties used).</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb">TypeObjectMap</a>\<T></div>
              <div className="col-last odd-row-color class-summary class-summary-tab2"> </div>
              <div className="col-first even-row-color class-summary class-summary-tab1"><a href="/content/api/java/com/gpudb/TypeObjectMap.Accessor" title="interface in com.gpudb">TypeObjectMap.Accessor</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab1">
                <div className="block">An accessor that returns a value from an object.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/TypeObjectMap.ClassFactory" title="class in com.gpudb">TypeObjectMap.ClassFactory</a>\<T></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">A factory that uses reflection to create new instances of the specified class.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/TypeObjectMap.ConvertingFieldHandler" title="class in com.gpudb">TypeObjectMap.ConvertingFieldHandler</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                <div className="block">A combined <a href="/content/api/java/com/gpudb/TypeObjectMap.Accessor" title="interface in com.gpudb"><code>TypeObjectMap.Accessor</code></a> and <a href="/content/api/java/com/gpudb/TypeObjectMap.Mutator" title="interface in com.gpudb"><code>TypeObjectMap.Mutator</code></a> that provides access to a specified field using reflection, converting the value to and from the data type of a specified GPUdb <a href="/content/api/java/com/gpudb/Type.Column" title="class in com.gpudb"><code>column</code></a>.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/TypeObjectMap.ConvertingMethodHandler" title="class in com.gpudb">TypeObjectMap.ConvertingMethodHandler</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">A combined <a href="/content/api/java/com/gpudb/TypeObjectMap.Accessor" title="interface in com.gpudb"><code>TypeObjectMap.Accessor</code></a> and <a href="/content/api/java/com/gpudb/TypeObjectMap.Mutator" title="interface in com.gpudb"><code>TypeObjectMap.Mutator</code></a> that provides access to a field via specified get and set methods using reflection, converting the value to and from the data type of a specified GPUdb <a href="/content/api/java/com/gpudb/Type.Column" title="class in com.gpudb"><code>column</code></a>.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab1"><a href="/content/api/java/com/gpudb/TypeObjectMap.Factory" title="interface in com.gpudb">TypeObjectMap.Factory</a>\<T></div>

              <div className="col-last even-row-color class-summary class-summary-tab1">
                <div className="block">A factory that creates new instances of the specified class.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/TypeObjectMap.FieldHandler" title="class in com.gpudb">TypeObjectMap.FieldHandler</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab2">
                <div className="block">A combined <a href="/content/api/java/com/gpudb/TypeObjectMap.Accessor" title="interface in com.gpudb"><code>TypeObjectMap.Accessor</code></a> and <a href="/content/api/java/com/gpudb/TypeObjectMap.Mutator" title="interface in com.gpudb"><code>TypeObjectMap.Mutator</code></a> that provides access to a specified field using reflection.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/TypeObjectMap.MethodHandler" title="class in com.gpudb">TypeObjectMap.MethodHandler</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                <div className="block">A combined <a href="/content/api/java/com/gpudb/TypeObjectMap.Accessor" title="interface in com.gpudb"><code>TypeObjectMap.Accessor</code></a> and <a href="/content/api/java/com/gpudb/TypeObjectMap.Mutator" title="interface in com.gpudb"><code>TypeObjectMap.Mutator</code></a> that provides access to a field via specified get and set methods using reflection.</div>
              </div>

              <div className="col-first odd-row-color class-summary class-summary-tab1"><a href="/content/api/java/com/gpudb/TypeObjectMap.Mutator" title="interface in com.gpudb">TypeObjectMap.Mutator</a></div>

              <div className="col-last odd-row-color class-summary class-summary-tab1">
                <div className="block">A mutator that sets a value in an object.</div>
              </div>

              <div className="col-first even-row-color class-summary class-summary-tab2"><a href="/content/api/java/com/gpudb/WorkerList" title="class in com.gpudb">WorkerList</a></div>

              <div className="col-last even-row-color class-summary class-summary-tab2">
                <div className="block">A list of worker URLs to use for multi-head operations.</div>
              </div>
            </div>
          </div>
        </div>
      </li>
    </ul>
  </div>
</div>