> ## 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.

# RecordRetriever

> RecordRetriever — Kinetica Java API

<div className="kinetica-javadoc">
  <div className="header">
    <div className="sub-title"><span className="package-label-in-type">Package</span> <a href="/content/api/java/com/gpudb/package-summary">com.gpudb</a></div>
    <h1 title="Class RecordRetriever" className="title">Class RecordRetriever\<T></h1>
  </div>

  <div className="inheritance" title="Inheritance Tree">
    <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">java.lang.Object</a>
    <div className="inheritance">com.gpudb.RecordRetriever\<T></div>
  </div>

  <div className="section class-description" id="class-description">
    <div className="dl notes">
      <div className="dt">Type Parameters:</div>
      <div className="dd"><code>T</code> - the type of object being retrieved</div>
    </div>

    <hr />

    <div className="type-signature"><span className="modifiers">public class </span><span className="element-name type-name-label">RecordRetriever\<T></span> <span className="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></span></div>
    <div className="block">Object that permits efficient retrieval of records from GPUdb, with support for multi-head access. <code>RecordRetriever</code> instances are thread safe and may be used from any number of threads simultaneously.</div>
  </div>

  <div className="section summary">
    <ul className="summary-list">
      <li>
        <div className="section constructor-summary" id="constructor-summary">
          <h2>Constructor Summary</h2>
          <div className="caption"><span>Constructors</span></div>

          <div className="summary-table two-column-summary">
            <div className="table-header col-first">Constructor</div>
            <div className="table-header col-last">Description</div>
            <div className="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(com.gpudb.GPUdb,java.lang.String,com.gpudb.Type)" className="member-name-link">RecordRetriever</a><wbr />(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb">Type</a> type)</code></div>

            <div className="col-last even-row-color">
              <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>
            </div>

            <div className="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(com.gpudb.GPUdb,java.lang.String,com.gpudb.TypeObjectMap)" className="member-name-link">RecordRetriever</a><wbr />(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb">TypeObjectMap</a>\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>> typeObjectMap)</code></div>

            <div className="col-last odd-row-color">
              <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>
            </div>

            <div className="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(com.gpudb.GPUdb,java.lang.String,com.gpudb.TypeObjectMap,com.gpudb.WorkerList)" className="member-name-link">RecordRetriever</a><wbr />(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb">TypeObjectMap</a>\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>> typeObjectMap, <a href="/content/api/java/com/gpudb/WorkerList" title="class in com.gpudb">WorkerList</a> workers)</code></div>

            <div className="col-last even-row-color">
              <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>
            </div>

            <div className="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(com.gpudb.GPUdb,java.lang.String,com.gpudb.TypeObjectMap,com.gpudb.WorkerList,java.util.Map)" className="member-name-link">RecordRetriever</a><wbr />(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb">TypeObjectMap</a>\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>> typeObjectMap, <a href="/content/api/java/com/gpudb/WorkerList" title="class in com.gpudb">WorkerList</a> workers, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</code></div>

            <div className="col-last odd-row-color">
              <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>
            </div>

            <div className="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(com.gpudb.GPUdb,java.lang.String,com.gpudb.TypeObjectMap,java.util.Map)" className="member-name-link">RecordRetriever</a><wbr />(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb">TypeObjectMap</a>\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>> typeObjectMap, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</code></div>

            <div className="col-last even-row-color">
              <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>
            </div>

            <div className="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(com.gpudb.GPUdb,java.lang.String,com.gpudb.Type,com.gpudb.WorkerList)" className="member-name-link">RecordRetriever</a><wbr />(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb">Type</a> type, <a href="/content/api/java/com/gpudb/WorkerList" title="class in com.gpudb">WorkerList</a> workers)</code></div>

            <div className="col-last odd-row-color">
              <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>
            </div>

            <div className="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(com.gpudb.GPUdb,java.lang.String,com.gpudb.Type,com.gpudb.WorkerList,java.util.Map)" className="member-name-link">RecordRetriever</a><wbr />(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb">Type</a> type, <a href="/content/api/java/com/gpudb/WorkerList" title="class in com.gpudb">WorkerList</a> workers, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</code></div>

            <div className="col-last even-row-color">
              <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>
            </div>

            <div className="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(com.gpudb.GPUdb,java.lang.String,com.gpudb.Type,java.util.Map)" className="member-name-link">RecordRetriever</a><wbr />(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb">Type</a> type, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</code></div>

            <div className="col-last odd-row-color">
              <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>
            </div>
          </div>
        </div>
      </li>

      <li>
        <div className="section method-summary" id="method-summary">
          <h2>Method Summary</h2>

          <div id="method-summary-table">
            <div className="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabIndex="0" className="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabIndex="-1" className="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabIndex="-1" className="table-tab">Concrete Methods</button></div>

            <div id="method-summary-table.tabpanel" role="tabpanel" aria-labelledby="method-summary-table-tab0">
              <div className="summary-table three-column-summary">
                <div className="table-header col-first">Modifier and Type</div>
                <div className="table-header col-second">Method</div>
                <div className="table-header col-last">Description</div>
                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/protocol/GetRecordsResponse" title="class in com.gpudb.protocol">GetRecordsResponse</a><wbr />\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getByKey(java.util.List,java.lang.String)" className="member-name-link">getByKey</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a>> keyValues, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> expression)</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Retrieves records with the given key values and filter expression from the database using a direct-to-rank fast key lookup, if possible, and falling back to a standard lookup via the head node, if not.</div>
                </div>

                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/protocol/GetRecordsResponse" title="class in com.gpudb.protocol">GetRecordsResponse</a><wbr />\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getByKey(java.util.List,java.lang.String,long)" className="member-name-link">getByKey</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a>> keyValues, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> expression, long offset)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Retrieves records with the given key values and filter expression from the database using a direct-to-rank fast key lookup, if possible, and falling back to a standard lookup via the head node, if not.</div>
                </div>

                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnResponse" title="class in com.gpudb.protocol">GetRecordsByColumnResponse</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getColumnsByKey(java.util.List,java.util.List,java.lang.String)" className="member-name-link">getColumnsByKey</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> columns, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a>> keyValues, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> expression)</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Retrieves records with the given key values and filter expression from the database using a direct-to-rank fast key lookup, if possible, and falling back to a standard lookup via the head node, if not.</div>
                </div>

                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnResponse" title="class in com.gpudb.protocol">GetRecordsByColumnResponse</a></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getColumnsByKey(java.util.List,java.util.List,java.lang.String,long)" className="member-name-link">getColumnsByKey</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> columns, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a>> keyValues, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> expression, long offset)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Retrieves records with the given key values and filter expression from the database using a direct-to-rank fast key lookup, if possible, and falling back to a standard lookup via the head node, if not.</div>
                </div>

                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getGPUdb()" className="member-name-link">getGPUdb</a>()</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Gets the GPUdb instance from which records will be retrieved.</div>
                </div>

                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a><wbr />\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getOptions()" className="member-name-link">getOptions</a>()</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Gets the options currently used for the retriever methods.</div>
                </div>

                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTableName()" className="member-name-link">getTableName</a>()</code></div>

                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Gets the name of the table from which records will be retrieved.</div>
                </div>

                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isDoingWorkerLookup()" className="member-name-link">isDoingWorkerLookup</a>()</code></div>
                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
                <div className="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div>
                <div className="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isUsingHeadRank()" className="member-name-link">isUsingHeadRank</a>()</code></div>
                <div className="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div>
                <div className="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb">RecordRetriever</a><wbr />\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>></code></div>
                <div className="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOptions(java.util.Map)" className="member-name-link">setOptions</a><wbr />(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</code></div>

                <div className="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
                  <div className="block">Sets the options to be used for the retriever methods.</div>
                </div>
              </div>
            </div>
          </div>

          <div className="inherited-list">
            <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a></h3>
            <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" className="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" className="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" className="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" className="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" className="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" className="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" className="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" className="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" className="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" className="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" className="external-link">wait</a></code>
          </div>
        </div>
      </li>
    </ul>
  </div>

  <div className="section details">
    <ul className="details-list">
      <li>
        <div className="section constructor-details" id="constructor-detail">
          <h2>Constructor Details</h2>

          <ul className="member-list">
            <li>
              <div className="section detail" id="<init>(com.gpudb.GPUdb,java.lang.String,com.gpudb.Type)">
                <h3>RecordRetriever</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">RecordRetriever</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb">Type</a> type)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
                <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters. <br /> It will use default settings for the <a href="/content/api/java/com/gpudb/GPUdb#getRecords(java.lang.String,long,long,java.util.Map)"><code>GPUdb.getRecords(String, long, long, Map)</code></a> call supporting <a href="#getByKey(java.util.List,java.lang.String)"><code>getByKey(List, String)</code></a> and the <a href="/content/api/java/com/gpudb/GPUdb#getRecordsByColumn(java.lang.String,java.util.List,long,long,java.util.Map)"><code>GPUdb.getRecordsByColumn(String, List, long, long, Map)</code></a> call supporting <a href="#getColumnsByKey(java.util.List,java.util.List,java.lang.String)"><code>getColumnsByKey(List, List, String)</code></a>. <br /> Details can be found at <a href="/content/api/java/com/gpudb/protocol/GetRecordsRequest.Options" title="class in com.gpudb.protocol"><code>GetRecordsRequest.Options</code></a> and <a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnRequest.Options" title="class in com.gpudb.protocol"><code>GetRecordsByColumnRequest.Options</code></a>, respectively.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>gpudb</code> - the <a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb"><code>GPUdb</code></a> instance to retrieve records from</div>
                  <div className="dd"><code>tableName</code> - the table to retrieve records from</div>
                  <div className="dd"><code>type</code> - the <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb"><code>Type</code></a> of records being retrieved</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if a configuration error occurs</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" className="external-link">IllegalArgumentException</a></code> - if an invalid parameter is specified</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(com.gpudb.GPUdb,java.lang.String,com.gpudb.Type,java.util.Map)">
                <h3>RecordRetriever</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">RecordRetriever</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb">Type</a> type, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
                <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>gpudb</code> - the <a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb"><code>GPUdb</code></a> instance to retrieve records from</div>
                  <div className="dd"><code>tableName</code> - the table to retrieve records from</div>
                  <div className="dd"><code>type</code> - the <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb"><code>Type</code></a> of records being retrieved</div>
                  <div className="dd"><code>options</code> - optional parameters to pass to GPUdb while retrieving (<code>null</code> for no parameters) <br /> This is the same set of options as accepted by the <a href="/content/api/java/com/gpudb/GPUdb#getRecords(java.lang.String,long,long,java.util.Map)"><code>GPUdb.getRecords(String, long, long, Map)</code></a> and <a href="/content/api/java/com/gpudb/GPUdb#getRecordsByColumn(java.lang.String,java.util.List,long,long,java.util.Map)"><code>GPUdb.getRecordsByColumn(String, List, long, long, Map)</code></a> calls. <br /> The details can be found at <a href="/content/api/java/com/gpudb/protocol/GetRecordsRequest.Options" title="class in com.gpudb.protocol"><code>GetRecordsRequest.Options</code></a> and <a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnRequest.Options" title="class in com.gpudb.protocol"><code>GetRecordsByColumnRequest.Options</code></a>.</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if a configuration error occurs</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" className="external-link">IllegalArgumentException</a></code> - if an invalid parameter is specified</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(com.gpudb.GPUdb,java.lang.String,com.gpudb.Type,com.gpudb.WorkerList)">
                <h3>RecordRetriever</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">RecordRetriever</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb">Type</a> type, <a href="/content/api/java/com/gpudb/WorkerList" title="class in com.gpudb">WorkerList</a> workers)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
                <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>gpudb</code> - the <a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb"><code>GPUdb</code></a> instance to retrieve records from</div>
                  <div className="dd"><code>tableName</code> - the table to retrieve records from</div>
                  <div className="dd"><code>type</code> - the <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb"><code>Type</code></a> of records being retrieved</div>
                  <div className="dd"><code>workers</code> - worker list for multi-head retrieval (<code>null</code> to disable multi-head retrieval)</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if a configuration error occurs</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" className="external-link">IllegalArgumentException</a></code> - if an invalid parameter is specified</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(com.gpudb.GPUdb,java.lang.String,com.gpudb.Type,com.gpudb.WorkerList,java.util.Map)">
                <h3>RecordRetriever</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">RecordRetriever</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb">Type</a> type, <a href="/content/api/java/com/gpudb/WorkerList" title="class in com.gpudb">WorkerList</a> workers, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
                <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>gpudb</code> - the <a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb"><code>GPUdb</code></a> instance to retrieve records from</div>
                  <div className="dd"><code>tableName</code> - the table to retrieve records from</div>
                  <div className="dd"><code>type</code> - the <a href="/content/api/java/com/gpudb/Type" title="class in com.gpudb"><code>Type</code></a> of records being retrieved</div>
                  <div className="dd"><code>workers</code> - worker list for multi-head retrieval (<code>null</code> to disable multi-head retrieval)</div>
                  <div className="dd"><code>options</code> - optional parameters to pass to GPUdb while retrieving (<code>null</code> for no parameters) <br /> This is the same set of options as accepted by the <a href="/content/api/java/com/gpudb/GPUdb#getRecords(java.lang.String,long,long,java.util.Map)"><code>GPUdb.getRecords(String, long, long, Map)</code></a> and <a href="/content/api/java/com/gpudb/GPUdb#getRecordsByColumn(java.lang.String,java.util.List,long,long,java.util.Map)"><code>GPUdb.getRecordsByColumn(String, List, long, long, Map)</code></a> calls. <br /> The details can be found at <a href="/content/api/java/com/gpudb/protocol/GetRecordsRequest.Options" title="class in com.gpudb.protocol"><code>GetRecordsRequest.Options</code></a> and <a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnRequest.Options" title="class in com.gpudb.protocol"><code>GetRecordsByColumnRequest.Options</code></a>.</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if a configuration error occurs</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" className="external-link">IllegalArgumentException</a></code> - if an invalid parameter is specified</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(com.gpudb.GPUdb,java.lang.String,com.gpudb.TypeObjectMap)">
                <h3>RecordRetriever</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">RecordRetriever</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb">TypeObjectMap</a>\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>> typeObjectMap)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
                <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>gpudb</code> - the <a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb"><code>GPUdb</code></a> instance to retrieve records from</div>
                  <div className="dd"><code>tableName</code> - the table to retrieve records from</div>
                  <div className="dd"><code>typeObjectMap</code> - the <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb"><code>TypeObjectMap</code></a> for the type of records being retrieved</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if a configuration error occurs</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" className="external-link">IllegalArgumentException</a></code> - if an invalid parameter is specified</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(com.gpudb.GPUdb,java.lang.String,com.gpudb.TypeObjectMap,java.util.Map)">
                <h3>RecordRetriever</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">RecordRetriever</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb">TypeObjectMap</a>\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>> typeObjectMap, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
                <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>gpudb</code> - the <a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb"><code>GPUdb</code></a> instance to retrieve records from</div>
                  <div className="dd"><code>tableName</code> - the table to retrieve records from</div>
                  <div className="dd"><code>typeObjectMap</code> - the <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb"><code>TypeObjectMap</code></a> for the type of records being retrieved</div>
                  <div className="dd"><code>options</code> - optional parameters to pass to GPUdb while retrieving (<code>null</code> for no parameters) <br /> This is the same set of options as accepted by the <a href="/content/api/java/com/gpudb/GPUdb#getRecords(java.lang.String,long,long,java.util.Map)"><code>GPUdb.getRecords(String, long, long, Map)</code></a> and <a href="/content/api/java/com/gpudb/GPUdb#getRecordsByColumn(java.lang.String,java.util.List,long,long,java.util.Map)"><code>GPUdb.getRecordsByColumn(String, List, long, long, Map)</code></a> calls. <br /> The details can be found at <a href="/content/api/java/com/gpudb/protocol/GetRecordsRequest.Options" title="class in com.gpudb.protocol"><code>GetRecordsRequest.Options</code></a> and <a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnRequest.Options" title="class in com.gpudb.protocol"><code>GetRecordsByColumnRequest.Options</code></a>.</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if a configuration error occurs</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" className="external-link">IllegalArgumentException</a></code> - if an invalid parameter is specified</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(com.gpudb.GPUdb,java.lang.String,com.gpudb.TypeObjectMap,com.gpudb.WorkerList)">
                <h3>RecordRetriever</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">RecordRetriever</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb">TypeObjectMap</a>\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>> typeObjectMap, <a href="/content/api/java/com/gpudb/WorkerList" title="class in com.gpudb">WorkerList</a> workers)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
                <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>gpudb</code> - the <a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb"><code>GPUdb</code></a> instance to retrieve records from</div>
                  <div className="dd"><code>tableName</code> - the table to retrieve records from</div>
                  <div className="dd"><code>typeObjectMap</code> - the <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb"><code>TypeObjectMap</code></a> for the type of records being retrieved</div>
                  <div className="dd"><code>workers</code> - worker list for multi-head retrieval (<code>null</code> to disable multi-head retrieval)</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if a configuration error occurs</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" className="external-link">IllegalArgumentException</a></code> - if an invalid parameter is specified</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="<init>(com.gpudb.GPUdb,java.lang.String,com.gpudb.TypeObjectMap,com.gpudb.WorkerList,java.util.Map)">
                <h3>RecordRetriever</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="element-name">RecordRetriever</span><wbr /><span className="parameters">(<a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a> gpudb, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> tableName, <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb">TypeObjectMap</a>\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>> typeObjectMap, <a href="/content/api/java/com/gpudb/WorkerList" title="class in com.gpudb">WorkerList</a> workers, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>
                <div className="block">Creates a <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> with the specified parameters.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>gpudb</code> - the <a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb"><code>GPUdb</code></a> instance to retrieve records from</div>
                  <div className="dd"><code>tableName</code> - the table to retrieve records from</div>
                  <div className="dd"><code>typeObjectMap</code> - the <a href="/content/api/java/com/gpudb/TypeObjectMap" title="class in com.gpudb"><code>TypeObjectMap</code></a> for the type of records being retrieved</div>
                  <div className="dd"><code>workers</code> - worker list for multi-head retrieval (<code>null</code> to disable multi-head retrieval)</div>
                  <div className="dd"><code>options</code> - optional parameters to pass to GPUdb while retrieving (<code>null</code> for no parameters) <br /> This is the same set of options as accepted by the <a href="/content/api/java/com/gpudb/GPUdb#getRecords(java.lang.String,long,long,java.util.Map)"><code>GPUdb.getRecords(String, long, long, Map)</code></a> and <a href="/content/api/java/com/gpudb/GPUdb#getRecordsByColumn(java.lang.String,java.util.List,long,long,java.util.Map)"><code>GPUdb.getRecordsByColumn(String, List, long, long, Map)</code></a> calls. <br /> The details can be found at <a href="/content/api/java/com/gpudb/protocol/GetRecordsRequest.Options" title="class in com.gpudb.protocol"><code>GetRecordsRequest.Options</code></a> and <a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnRequest.Options" title="class in com.gpudb.protocol"><code>GetRecordsByColumnRequest.Options</code></a>.</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code> - if a configuration error occurs</div>
                  <div className="dd"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" className="external-link">IllegalArgumentException</a></code> - if an invalid parameter is specified</div>
                </div>
              </div>
            </li>
          </ul>
        </div>
      </li>

      <li>
        <div className="section method-details" id="method-detail">
          <h2>Method Details</h2>

          <ul className="member-list">
            <li>
              <div className="section detail" id="getGPUdb()">
                <h3>getGPUdb</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/GPUdb" title="class in com.gpudb">GPUdb</a></span> <span className="element-name">getGPUdb</span>()</div>
                <div className="block">Gets the GPUdb instance from which records will be retrieved.</div>

                <div className="dl notes">
                  <div className="dt">Returns:</div>
                  <div className="dd">the GPUdb instance from which records will be retrieved</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="getTableName()">
                <h3>getTableName</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a></span> <span className="element-name">getTableName</span>()</div>
                <div className="block">Gets the name of the table from which records will be retrieved.</div>

                <div className="dl notes">
                  <div className="dt">Returns:</div>
                  <div className="dd">the name of the table from which records will be retrieved</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="isUsingHeadRank()">
                <h3>isUsingHeadRank</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type">boolean</span> <span className="element-name">isUsingHeadRank</span>()</div>

                <div className="dl notes">
                  <div className="dt">Returns:</div>
                  <div className="dd">whether this <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> object is using the head-rank to do a simple record fetching (not utilizing the server's key lookup feature) (true value), or using multi-head (the worker ranks) for key lookup (false value).</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="isDoingWorkerLookup()">
                <h3>isDoingWorkerLookup</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type">boolean</span> <span className="element-name">isDoingWorkerLookup</span>()</div>

                <div className="dl notes">
                  <div className="dt">Returns:</div>
                  <div className="dd">whether this <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> object is using the worker ranks to do key lookups (true value), or doing simple record fetching (not the server's key lookup feature) (false value). Note that this will not reflect the non-worker lookup scenario where only an expression is supplied and the table is sharded.</div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="getOptions()">
                <h3>getOptions</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>></span> <span className="element-name">getOptions</span>()</div>
                <div className="block">Gets the options currently used for the retriever methods. Note that any <a href="/content/api/java/com/gpudb/protocol/GetRecordsRequest.Options#EXPRESSION"><code>GetRecordsRequest.Options.EXPRESSION</code></a> options will get overridden at the next <a href="#getByKey(java.util.List,java.lang.String)"><code>getByKey(java.util.List\<java.lang.Object>, java.lang.String)</code></a> call with the appropriate expression.</div>

                <div className="dl notes">
                  <div className="dt">Returns:</div>
                  <div className="dd">the options used during record retrieval</div>
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list-long">
                      <li><a href="#setOptions(java.util.Map)"><code>setOptions(java.util.Map\<java.lang.String, java.lang.String>)</code></a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="setOptions(java.util.Map)">
                <h3>setOptions</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb">RecordRetriever</a>\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>></span> <span className="element-name">setOptions</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" className="external-link">Map</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>,<wbr /><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> options)</span></div>
                <div className="block">Sets the options to be used for the retriever methods.</div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>options</code> - the options to be used during record retrieval</div>
                  <div className="dt">Returns:</div>
                  <div className="dd">the current <a href="/content/api/java/com/gpudb/RecordRetriever" title="class in com.gpudb"><code>RecordRetriever</code></a> instance</div>
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list-long">
                      <li><a href="/content/api/java/com/gpudb/protocol/GetRecordsRequest.Options#EXPRESSION"><code>GetRecordsRequest.Options.EXPRESSION</code></a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="getByKey(java.util.List,java.lang.String)">
                <h3>getByKey</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/GetRecordsResponse" title="class in com.gpudb.protocol">GetRecordsResponse</a>\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>></span> <span className="element-name">getByKey</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a>> keyValues, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> expression)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

                <div className="block">
                  Retrieves records with the given key values and filter expression from the database using a direct-to-rank fast key lookup, if possible, and falling back to a standard lookup via the head node, if not. <br /> This method operates in four modes, depending on the parameters passed:

                  <ul>
                    <li> keyValues only - attempts a direct-to-rank lookup for records matching the given key values </li>
                    <li> keyValues and expression - attempts a direct-to-rank lookup for records matching the given key values, filtering them by the given expression </li>
                    <li> expression only - requests, via the head rank, all records in the table matching the given filter expression </li>
                    <li> neither - retrieves all records from the table via the head rank </li>
                  </ul>
                </div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>keyValues</code> - the key values to use for the lookup; these must correspond to either the explicit or implicit shard key for sharded tables or the primary key of replicated tables</div>
                  <div className="dd"><code>expression</code> - a filter expression that will be applied to the data requested by the key values; if no key values are specified this filter will be applied to all of the data in the target table</div>
                  <div className="dt">Returns:</div>
                  <div className="dd">a <a href="/content/api/java/com/gpudb/protocol/GetRecordsResponse" title="class in com.gpudb.protocol"><code>GetRecordsResponse</code></a> with the requested records</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code></div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="getByKey(java.util.List,java.lang.String,long)">
                <h3>getByKey</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/GetRecordsResponse" title="class in com.gpudb.protocol">GetRecordsResponse</a>\<<a href="/content/api/java/com/gpudb/RecordRetriever" title="type parameter in RecordRetriever">T</a>></span> <span className="element-name">getByKey</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a>> keyValues, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> expression, long offset)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

                <div className="block">
                  Retrieves records with the given key values and filter expression from the database using a direct-to-rank fast key lookup, if possible, and falling back to a standard lookup via the head node, if not. Returns records in the overall result set starting from the given <code>offset</code>. <br /> This method operates in four modes, depending on the parameters passed:

                  <ul>
                    <li> keyValues only - attempts a direct-to-rank lookup for records matching the given key values </li>
                    <li> keyValues and expression - attempts a direct-to-rank lookup for records matching the given key values, filtering them by the given expression </li>
                    <li> expression only - requests, via the head rank, all records in the table matching the given filter expression </li>
                    <li> neither - retrieves all records from the table via the head rank </li>
                  </ul>
                </div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>keyValues</code> - the key values to use for the lookup; these must correspond to either the explicit or implicit shard key for sharded tables or the primary key of replicated tables</div>
                  <div className="dd"><code>expression</code> - a filter expression that will be applied to the data requested by the key values; if no key values are specified this filter will be applied to all of the data in the target table</div>
                  <div className="dd"><code>offset</code> - offset of the record(s) within the result set to return</div>
                  <div className="dt">Returns:</div>
                  <div className="dd">a <a href="/content/api/java/com/gpudb/protocol/GetRecordsResponse" title="class in com.gpudb.protocol"><code>GetRecordsResponse</code></a> with the requested records</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code></div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="getColumnsByKey(java.util.List,java.util.List,java.lang.String)">
                <h3>getColumnsByKey</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnResponse" title="class in com.gpudb.protocol">GetRecordsByColumnResponse</a></span> <span className="element-name">getColumnsByKey</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> columns, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a>> keyValues, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> expression)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

                <div className="block">
                  Retrieves records with the given key values and filter expression from the database using a direct-to-rank fast key lookup, if possible, and falling back to a standard lookup via the head node, if not. <br /> This method operates in four modes, depending on the parameters passed:

                  <ul>
                    <li> keyValues only - attempts a direct-to-rank lookup for records matching the given key values </li>
                    <li> keyValues and expression - attempts a direct-to-rank lookup for records matching the given key values, filtering them by the given expression </li>
                    <li> expression only - requests, via the head rank, all records in the table matching the given filter expression </li>
                    <li> neither - retrieves all records from the table via the head rank </li>
                  </ul>
                </div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>columns</code> - The requested columns (which can include expressions) being requested. May use "\*" for all columns.</div>
                  <div className="dd"><code>keyValues</code> - the key values to use for the lookup; these must correspond to either the explicit or implicit shard key for sharded tables or the primary key of replicated tables</div>
                  <div className="dd"><code>expression</code> - a filter expression that will be applied to the data requested by the key values; if no key values are specified this filter will be applied to all of the data in the target table</div>
                  <div className="dt">Returns:</div>
                  <div className="dd">a <a href="/content/api/java/com/gpudb/protocol/GetRecordsResponse" title="class in com.gpudb.protocol"><code>GetRecordsResponse</code></a> with the requested records</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code></div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="getColumnsByKey(java.util.List,java.util.List,java.lang.String,long)">
                <h3>getColumnsByKey</h3>
                <div className="member-signature"><span className="modifiers">public</span> <span className="return-type"><a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnResponse" title="class in com.gpudb.protocol">GetRecordsByColumnResponse</a></span> <span className="element-name">getColumnsByKey</span><wbr /><span className="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a>> columns, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" className="external-link">List</a>\<<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" className="external-link">Object</a>> keyValues, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" className="external-link">String</a> expression, long offset)</span> throws <span className="exceptions"><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></span></div>

                <div className="block">
                  Retrieves records with the given key values and filter expression from the database using a direct-to-rank fast key lookup, if possible, and falling back to a standard lookup via the head node, if not. Returns records in the overall result set starting from the given <code>offset</code>. <br /> This method operates in four modes, depending on the parameters passed:

                  <ul>
                    <li> keyValues only - attempts a direct-to-rank lookup for records matching the given key values </li>
                    <li> keyValues and expression - attempts a direct-to-rank lookup for records matching the given key values, filtering them by the given expression </li>
                    <li> expression only - requests, via the head rank, all records in the table matching the given filter expression </li>
                    <li> neither - retrieves all records from the table via the head rank </li>
                  </ul>
                </div>

                <div className="dl notes">
                  <div className="dt">Parameters:</div>
                  <div className="dd"><code>columns</code> - The requested columns (which can include expressions) being requested. May use "\*" for all columns.</div>
                  <div className="dd"><code>keyValues</code> - the key values to use for the lookup; these must correspond to either the explicit or implicit shard key for sharded tables or the primary key of replicated tables</div>
                  <div className="dd"><code>expression</code> - a filter expression that will be applied to the data requested by the key values; if no key values are specified this filter will be applied to all of the data in the target table</div>
                  <div className="dd"><code>offset</code> - offset of the record(s) within the result set to return</div>
                  <div className="dt">Returns:</div>
                  <div className="dd">a <a href="/content/api/java/com/gpudb/protocol/GetRecordsResponse" title="class in com.gpudb.protocol"><code>GetRecordsResponse</code></a> with the requested records</div>
                  <div className="dt">Throws:</div>
                  <div className="dd"><code><a href="/content/api/java/com/gpudb/GPUdbException" title="class in com.gpudb">GPUdbException</a></code></div>
                </div>
              </div>
            </li>
          </ul>
        </div>
      </li>
    </ul>
  </div>
</div>
