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

# GetRecordsByColumnRequest.Options

> GetRecordsByColumnRequest.Options — 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/protocol/package-summary">com.gpudb.protocol</a></div>
    <h1 title="Class GetRecordsByColumnRequest.Options" className="title">Class GetRecordsByColumnRequest.Options</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.protocol.GetRecordsByColumnRequest.Options</div>
  </div>

  <div className="section class-description" id="class-description">
    <div className="dl notes">
      <div className="dt">Enclosing class:</div>
      <div className="dd"><code><a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnRequest" title="class in com.gpudb.protocol">GetRecordsByColumnRequest</a></code></div>
    </div>

    <hr />

    <div className="type-signature"><span className="modifiers">public static final class </span><span className="element-name type-name-label">GetRecordsByColumnRequest.Options</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">A set of string constants for the <a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnRequest" title="class in com.gpudb.protocol"><code>GetRecordsByColumnRequest</code></a> parameter <a href="/content/api/java/com/gpudb/protocol/GetRecordsByColumnRequest#getOptions()"><code>options</code></a>.</div>
  </div>

  <div className="section summary">
    <ul className="summary-list">
      <li>
        <div className="section field-summary" id="field-summary">
          <h2>Field Summary</h2>
          <div className="caption"><span>Fields</span></div>

          <div className="summary-table three-column-summary">
            <div className="table-header col-first">Modifier and Type</div>
            <div className="table-header col-second">Field</div>
            <div className="table-header col-last">Description</div>
            <div className="col-first even-row-color"><code>static final <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"><code><a href="#ASCENDING" className="member-name-link">ASCENDING</a></code></div>
            <div className="col-last even-row-color"> </div>
            <div className="col-first odd-row-color"><code>static final <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"><code><a href="#CONVERT_WKTS_TO_WKBS" className="member-name-link">CONVERT\_WKTS\_TO\_WKBS</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">If <a href="#TRUE"><code>TRUE</code></a>, then WKT string columns will be returned as WKB bytes.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <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"><code><a href="#DESCENDING" className="member-name-link">DESCENDING</a></code></div>
            <div className="col-last even-row-color"> </div>
            <div className="col-first odd-row-color"><code>static final <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"><code><a href="#EXPRESSION" className="member-name-link">EXPRESSION</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Filter expression to apply to the table.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <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"><code><a href="#FALSE" className="member-name-link">FALSE</a></code></div>
            <div className="col-last even-row-color"> </div>
            <div className="col-first odd-row-color"><code>static final <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"><code><a href="#ORDER_BY" className="member-name-link">ORDER\_BY</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <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"><code><a href="#ROUTE_TO_TOM" className="member-name-link">ROUTE\_TO\_TOM</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <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"><code><a href="#SORT_BY" className="member-name-link">SORT\_BY</a></code></div>

            <div className="col-last odd-row-color">
              <div className="block">Column that the data should be sorted by.</div>
            </div>

            <div className="col-first even-row-color"><code>static final <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"><code><a href="#SORT_ORDER" className="member-name-link">SORT\_ORDER</a></code></div>

            <div className="col-last even-row-color">
              <div className="block">String indicating how the returned values should be sorted - <a href="#ASCENDING"><code>ASCENDING</code></a> or <a href="#DESCENDING"><code>DESCENDING</code></a>.</div>
            </div>

            <div className="col-first odd-row-color"><code>static final <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"><code><a href="#TRUE" className="member-name-link">TRUE</a></code></div>
            <div className="col-last odd-row-color"> </div>
          </div>
        </div>
      </li>

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

          <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 field-details" id="field-detail">
          <h2>Field Details</h2>

          <ul className="member-list">
            <li>
              <div className="section detail" id="EXPRESSION">
                <h3>EXPRESSION</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">EXPRESSION</span></div>
                <div className="block">Filter expression to apply to the table.</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetRecordsByColumnRequest.Options.EXPRESSION">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="SORT_BY">
                <h3>SORT\_BY</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">SORT\_BY</span></div>
                <div className="block">Column that the data should be sorted by. Used in conjunction with <a href="#SORT_ORDER"><code>SORT\_ORDER</code></a>. The <a href="#ORDER_BY"><code>ORDER\_BY</code></a> option can be used in lieu of <a href="#SORT_BY"><code>SORT\_BY</code></a> / <a href="#SORT_ORDER"><code>SORT\_ORDER</code></a>. The default value is ''.</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetRecordsByColumnRequest.Options.SORT_BY">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="SORT_ORDER">
                <h3>SORT\_ORDER</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">SORT\_ORDER</span></div>

                <div className="block">
                  String indicating how the returned values should be sorted - <a href="#ASCENDING"><code>ASCENDING</code></a> or <a href="#DESCENDING"><code>DESCENDING</code></a>. If <a href="#SORT_ORDER"><code>SORT\_ORDER</code></a> is provided, <a href="#SORT_BY"><code>SORT\_BY</code></a> has to be provided. Supported values:

                  <ul>
                    <li><a href="#ASCENDING"><code>ASCENDING</code></a> </li>
                    <li><a href="#DESCENDING"><code>DESCENDING</code></a> </li>
                  </ul>

                  The default value is <a href="#ASCENDING"><code>ASCENDING</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetRecordsByColumnRequest.Options.SORT_ORDER">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="ASCENDING">
                <h3>ASCENDING</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">ASCENDING</span></div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetRecordsByColumnRequest.Options.ASCENDING">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="DESCENDING">
                <h3>DESCENDING</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">DESCENDING</span></div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetRecordsByColumnRequest.Options.DESCENDING">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="ORDER_BY">
                <h3>ORDER\_BY</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">ORDER\_BY</span></div>
                <div className="block">Comma-separated list of the columns to be sorted by as well as the sort direction, e.g., 'timestamp asc, x desc'. The default value is ''.</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetRecordsByColumnRequest.Options.ORDER_BY">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="CONVERT_WKTS_TO_WKBS">
                <h3>CONVERT\_WKTS\_TO\_WKBS</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">CONVERT\_WKTS\_TO\_WKBS</span></div>

                <div className="block">
                  If <a href="#TRUE"><code>TRUE</code></a>, then WKT string columns will be returned as WKB bytes. Supported values:

                  <ul>
                    <li><a href="#TRUE"><code>TRUE</code></a> </li>
                    <li><a href="#FALSE"><code>FALSE</code></a> </li>
                  </ul>

                  The default value is <a href="#FALSE"><code>FALSE</code></a>.
                </div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetRecordsByColumnRequest.Options.CONVERT_WKTS_TO_WKBS">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="TRUE">
                <h3>TRUE</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">TRUE</span></div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetRecordsByColumnRequest.Options.TRUE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="FALSE">
                <h3>FALSE</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">FALSE</span></div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetRecordsByColumnRequest.Options.FALSE">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>

            <li>
              <div className="section detail" id="ROUTE_TO_TOM">
                <h3>ROUTE\_TO\_TOM</h3>
                <div className="member-signature"><span className="modifiers">public static final</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">ROUTE\_TO\_TOM</span></div>
                <div className="block">For multihead record retrieval without shard key expression - specifies from which tom to retrieve data.</div>

                <div className="dl notes">
                  <div className="dt">See Also:</div>

                  <div className="dd">
                    <ul className="tag-list">
                      <li><a href="/content/api/java/constant-values#com.gpudb.protocol.GetRecordsByColumnRequest.Options.ROUTE_TO_TOM">Constant Field Values</a></li>
                    </ul>
                  </div>
                </div>
              </div>
            </li>
          </ul>
        </div>
      </li>
    </ul>
  </div>
</div>