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

# gpudb::GetRecordsByColumnRequest

> gpudb::GetRecordsByColumnRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aaf391f0f2e29974de30e9aa91dbed1ef">GPUdb::getRecordsByColumn</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/get__records__by__column_8h_source">gpudb/protocol/get\_records\_by\_column.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a275a0737dd5f42846bd07f4c0ff33069" id="r_a275a0737dd5f42846bd07f4c0ff33069">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a275a0737dd5f42846bd07f4c0ff33069">GetRecordsByColumnRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a275a0737dd5f42846bd07f4c0ff33069">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsByColumnRequest" title="A set of parameters for GPUdb::getRecordsByColumn.">GetRecordsByColumnRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a275a0737dd5f42846bd07f4c0ff33069">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:abbcedd43b588b62e8620598acb0c076b" id="r_abbcedd43b588b62e8620598acb0c076b">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#abbcedd43b588b62e8620598acb0c076b">GetRecordsByColumnRequest</a> (const std::string \&tableName\_, const std::vector\< std::string > \&columnNames\_, const int64\_t offset\_, const int64\_t limit\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:abbcedd43b588b62e8620598acb0c076b">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsByColumnRequest" title="A set of parameters for GPUdb::getRecordsByColumn.">GetRecordsByColumnRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:abbcedd43b588b62e8620598acb0c076b">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a4f179773fa2ba5bf5e6c0a78a5bc6549" id="r_a4f179773fa2ba5bf5e6c0a78a5bc6549">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4f179773fa2ba5bf5e6c0a78a5bc6549">GetRecordsByColumnRequest</a> (const std::string \&tableName\_, const std::vector\< std::string > \&columnNames\_, const int64\_t offset\_, const int64\_t limit\_, const std::string \&encoding\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:a4f179773fa2ba5bf5e6c0a78a5bc6549">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsByColumnRequest" title="A set of parameters for GPUdb::getRecordsByColumn.">GetRecordsByColumnRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:a4f179773fa2ba5bf5e6c0a78a5bc6549">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a263821675907f32ae8da306a46c885f5" id="r_a263821675907f32ae8da306a46c885f5">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a263821675907f32ae8da306a46c885f5">tableName</a></td>
      </tr>

      <tr className="memdesc:a263821675907f32ae8da306a46c885f5">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the table or view on which this operation will be performed, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. <br /></td>
      </tr>

      <tr className="separator:a263821675907f32ae8da306a46c885f5">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:acd6beecd58a909544b530bd68974ed0e" id="r_acd6beecd58a909544b530bd68974ed0e">
        <td className="memItemLeft" align="right" valign="top">std::vector\< std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#acd6beecd58a909544b530bd68974ed0e">columnNames</a></td>
      </tr>

      <tr className="memdesc:acd6beecd58a909544b530bd68974ed0e">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The list of column values to retrieve. <br /></td>
      </tr>

      <tr className="separator:acd6beecd58a909544b530bd68974ed0e">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a18191415826f865ec4f6a0d6dc6855ed" id="r_a18191415826f865ec4f6a0d6dc6855ed">
        <td className="memItemLeft" align="right" valign="top">int64\_t </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a18191415826f865ec4f6a0d6dc6855ed">offset</a></td>
      </tr>

      <tr className="memdesc:a18191415826f865ec4f6a0d6dc6855ed">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). <br /></td>
      </tr>

      <tr className="separator:a18191415826f865ec4f6a0d6dc6855ed">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a036170d92eb383fc6d7870158671089d" id="r_a036170d92eb383fc6d7870158671089d">
        <td className="memItemLeft" align="right" valign="top">int64\_t </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a036170d92eb383fc6d7870158671089d">limit</a></td>
      </tr>

      <tr className="memdesc:a036170d92eb383fc6d7870158671089d">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">A positive integer indicating the maximum number of results to be returned, or END\_OF\_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. <br /></td>
      </tr>

      <tr className="separator:a036170d92eb383fc6d7870158671089d">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a69896d8262afb2531bdf4dd1d2132d05" id="r_a69896d8262afb2531bdf4dd1d2132d05">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a69896d8262afb2531bdf4dd1d2132d05">encoding</a></td>
      </tr>

      <tr className="memdesc:a69896d8262afb2531bdf4dd1d2132d05">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Specifies the encoding for returned records; either <a className="el" href="/content/api/cpp/namespacegpudb#a00f46bff9ce56198eebb749449ad7dc8">binary</a> or <a className="el" href="/content/api/cpp/namespacegpudb#aa47ea5d8889f2cad76e71230791548ef">json</a>. <br /></td>
      </tr>

      <tr className="separator:a69896d8262afb2531bdf4dd1d2132d05">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:a4e6952cc02b65128e4ad34679db2d299" id="r_a4e6952cc02b65128e4ad34679db2d299">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a4e6952cc02b65128e4ad34679db2d299">options</a></td>
      </tr>

      <tr className="separator:a4e6952cc02b65128e4ad34679db2d299">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aaf391f0f2e29974de30e9aa91dbed1ef">GPUdb::getRecordsByColumn</a>. </p>
      <p>For a given table, retrieves the values from the requested column(s). Maps of column name to the array of values as well as the column data type are returned. This endpoint supports pagination with the <a className="el" href="#a18191415826f865ec4f6a0d6dc6855ed">offset</a> and <a className="el" href="#a036170d92eb383fc6d7870158671089d">limit</a> parameters.</p>
      <p><a href="/content/concepts/window/" target="_top">Window functions</a>, which can perform operations like moving averages, are available through this endpoint as well as <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aab22a8ee1b42ec6fa1acfc3b2f70cf4c">GPUdb::createProjection</a>.</p>
      <p>When using pagination, if the table (or the underlying table in the case of a view) is modified (records are inserted, updated, or deleted) during a call to the endpoint, the records or values retrieved may differ between calls based on the type of the update, e.g., the contiguity across pages cannot be relied upon.</p>
      <p>If <a className="el" href="#a263821675907f32ae8da306a46c885f5">tableName</a> is empty, selection is performed against a single-row virtual table. This can be useful in executing temporal (<a href="/content/concepts/expressions/#date-time-functions" target="_top">NOW()</a>), identity (<a href="/content/concepts/expressions/#user-security-functions" target="_top">USER()</a>), or constant-based functions (<a href="/content/concepts/expressions/#scalar-functions" target="_top">GEODIST(-77.11, 38.88, -71.06, 42.36)</a>).</p>
      <p>The response is returned as a dynamic schema. For details see: <a href="/content/api/concepts/#dynamic-schemas" target="_top">dynamic schemas documentation</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__by__column_8h_source#l00048">48</a> of file <a className="el" href="/content/api/cpp/get__records__by__column_8h_source">get\_records\_by\_column.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a275a0737dd5f42846bd07f4c0ff33069">◆ </a></span>GetRecordsByColumnRequest() <span className="overload">\[1/3]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::GetRecordsByColumnRequest::GetRecordsByColumnRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsByColumnRequest" title="A set of parameters for GPUdb::getRecordsByColumn.">GetRecordsByColumnRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__by__column_8h_source#l00054">54</a> of file <a className="el" href="/content/api/cpp/get__records__by__column_8h_source">get\_records\_by\_column.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#abbcedd43b588b62e8620598acb0c076b">◆ </a></span>GetRecordsByColumnRequest() <span className="overload">\[2/3]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::GetRecordsByColumnRequest::GetRecordsByColumnRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">tableName\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::vector\< std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">columnNames\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const int64\_t</td>
                  <td className="paramname"><span className="paramname"><span className="em">offset\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const int64\_t</td>
                  <td className="paramname"><span className="paramname"><span className="em">limit\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">options\_</span></span> )</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsByColumnRequest" title="A set of parameters for GPUdb::getRecordsByColumn.">GetRecordsByColumnRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">tableName\_</td>
                <td>Name of the table or view on which this operation will be performed, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">columnNames\_</td>
                <td>The list of column values to retrieve. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">offset\_</td>
                <td>A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX\_INT. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">limit\_</td>
                <td>A positive integer indicating the maximum number of results to be returned, or END\_OF\_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the <a href="/content/config/#config-main-general" target="_top">max\_get\_records\_size</a> parameter in the server configuration. Use <a className="el" href="/content/api/cpp/structgpudb_1_1RawGetRecordsByColumnResponse#aacb0ce76f7cd842a1a9cce15365b34cf">hasMoreRecords</a> to see if more records exist in the result to be fetched, and <span className="em arg">offset\_</span> and <span className="em arg">limit\_</span> to request subsequent pages of results. The default value is -9999. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>

                <td>
                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a40c38c510dc7a5c6e33feeee54b47ce0">get\_records\_by\_column\_expression</a>: Filter expression to apply to the table. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab655054cebcfd9067f7f35c9e2ec43b3">get\_records\_by\_column\_sort\_by</a>: Column that the data should be sorted by. Used in conjunction with <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">sort\_order</a>. The <a className="el" href="/content/api/cpp/namespacegpudb#af02eca012e8de80e8e38c2d4b70d4383">order\_by</a> option can be used in lieu of <a className="el" href="/content/api/cpp/namespacegpudb#ab655054cebcfd9067f7f35c9e2ec43b3">sort\_by</a> / <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">sort\_order</a>. The default value is ''. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">get\_records\_by\_column\_sort\_order</a>: String indicating how the returned values should be sorted - <a className="el" href="/content/api/cpp/namespacegpudb#afc9919fed190f2c386350b030eb40566">ascending</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a73b3c1a06c6708264e0585c3e1b0c89a">descending</a>. If <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">sort\_order</a> is provided, <a className="el" href="/content/api/cpp/namespacegpudb#ab655054cebcfd9067f7f35c9e2ec43b3">sort\_by</a> has to be provided. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#afc9919fed190f2c386350b030eb40566">get\_records\_by\_column\_ascending</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a73b3c1a06c6708264e0585c3e1b0c89a">get\_records\_by\_column\_descending</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#afc9919fed190f2c386350b030eb40566">get\_records\_by\_column\_ascending</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#af02eca012e8de80e8e38c2d4b70d4383">get\_records\_by\_column\_order\_by</a>: 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 ''. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a314c60906c01b5d513374b32e935ca66">get\_records\_by\_column\_convert\_wkts\_to\_wkbs</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a10b5be6900c28fc88d28ecc89ed5a67c">true</a>, then WKT string columns will be returned as WKB bytes. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a10b5be6900c28fc88d28ecc89ed5a67c">get\_records\_by\_column\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a18a75ed4471dedf3f337fafccd529e68">get\_records\_by\_column\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a18a75ed4471dedf3f337fafccd529e68">get\_records\_by\_column\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a57f1bbd4459c912dbc0ad2b23ae58fb9">get\_records\_by\_column\_route\_to\_tom</a>: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data. </li>
                  </ul>

                  The default value is an empty map.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__by__column_8h_source#l00178">178</a> of file <a className="el" href="/content/api/cpp/get__records__by__column_8h_source">get\_records\_by\_column.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4f179773fa2ba5bf5e6c0a78a5bc6549">◆ </a></span>GetRecordsByColumnRequest() <span className="overload">\[3/3]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::GetRecordsByColumnRequest::GetRecordsByColumnRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">tableName\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::vector\< std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">columnNames\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const int64\_t</td>
                  <td className="paramname"><span className="paramname"><span className="em">offset\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const int64\_t</td>
                  <td className="paramname"><span className="paramname"><span className="em">limit\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">encoding\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">options\_</span></span> )</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs a <a className="el" href="/content/api/cpp/structgpudb_1_1GetRecordsByColumnRequest" title="A set of parameters for GPUdb::getRecordsByColumn.">GetRecordsByColumnRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">tableName\_</td>
                <td>Name of the table or view on which this operation will be performed, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">columnNames\_</td>
                <td>The list of column values to retrieve. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">offset\_</td>
                <td>A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX\_INT. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">limit\_</td>
                <td>A positive integer indicating the maximum number of results to be returned, or END\_OF\_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. The number of records returned will never exceed the server's own limit, defined by the <a href="/content/config/#config-main-general" target="_top">max\_get\_records\_size</a> parameter in the server configuration. Use <a className="el" href="/content/api/cpp/structgpudb_1_1RawGetRecordsByColumnResponse#aacb0ce76f7cd842a1a9cce15365b34cf">hasMoreRecords</a> to see if more records exist in the result to be fetched, and <span className="em arg">offset\_</span> and <span className="em arg">limit\_</span> to request subsequent pages of results. The default value is -9999. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">encoding\_</td>

                <td>
                  Specifies the encoding for returned records; either <a className="el" href="/content/api/cpp/namespacegpudb#a00f46bff9ce56198eebb749449ad7dc8">binary</a> or <a className="el" href="/content/api/cpp/namespacegpudb#aa47ea5d8889f2cad76e71230791548ef">json</a>. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a00f46bff9ce56198eebb749449ad7dc8">get\_records\_by\_column\_binary</a> </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa47ea5d8889f2cad76e71230791548ef">get\_records\_by\_column\_json</a> </li>
                  </ul>

                  The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a00f46bff9ce56198eebb749449ad7dc8">get\_records\_by\_column\_binary</a>.
                </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>

                <td>
                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a40c38c510dc7a5c6e33feeee54b47ce0">get\_records\_by\_column\_expression</a>: Filter expression to apply to the table. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab655054cebcfd9067f7f35c9e2ec43b3">get\_records\_by\_column\_sort\_by</a>: Column that the data should be sorted by. Used in conjunction with <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">sort\_order</a>. The <a className="el" href="/content/api/cpp/namespacegpudb#af02eca012e8de80e8e38c2d4b70d4383">order\_by</a> option can be used in lieu of <a className="el" href="/content/api/cpp/namespacegpudb#ab655054cebcfd9067f7f35c9e2ec43b3">sort\_by</a> / <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">sort\_order</a>. The default value is ''. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">get\_records\_by\_column\_sort\_order</a>: String indicating how the returned values should be sorted - <a className="el" href="/content/api/cpp/namespacegpudb#afc9919fed190f2c386350b030eb40566">ascending</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a73b3c1a06c6708264e0585c3e1b0c89a">descending</a>. If <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">sort\_order</a> is provided, <a className="el" href="/content/api/cpp/namespacegpudb#ab655054cebcfd9067f7f35c9e2ec43b3">sort\_by</a> has to be provided. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#afc9919fed190f2c386350b030eb40566">get\_records\_by\_column\_ascending</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a73b3c1a06c6708264e0585c3e1b0c89a">get\_records\_by\_column\_descending</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#afc9919fed190f2c386350b030eb40566">get\_records\_by\_column\_ascending</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#af02eca012e8de80e8e38c2d4b70d4383">get\_records\_by\_column\_order\_by</a>: 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 ''. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a314c60906c01b5d513374b32e935ca66">get\_records\_by\_column\_convert\_wkts\_to\_wkbs</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a10b5be6900c28fc88d28ecc89ed5a67c">true</a>, then WKT string columns will be returned as WKB bytes. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a10b5be6900c28fc88d28ecc89ed5a67c">get\_records\_by\_column\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a18a75ed4471dedf3f337fafccd529e68">get\_records\_by\_column\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a18a75ed4471dedf3f337fafccd529e68">get\_records\_by\_column\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a57f1bbd4459c912dbc0ad2b23ae58fb9">get\_records\_by\_column\_route\_to\_tom</a>: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data. </li>
                  </ul>

                  The default value is an empty map.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__by__column_8h_source#l00318">318</a> of file <a className="el" href="/content/api/cpp/get__records__by__column_8h_source">get\_records\_by\_column.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#acd6beecd58a909544b530bd68974ed0e">◆ </a></span>columnNames</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::vector\<std::string> gpudb::GetRecordsByColumnRequest::columnNames</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>The list of column values to retrieve. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__by__column_8h_source#l00341">341</a> of file <a className="el" href="/content/api/cpp/get__records__by__column_8h_source">get\_records\_by\_column.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a69896d8262afb2531bdf4dd1d2132d05">◆ </a></span>encoding</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::GetRecordsByColumnRequest::encoding</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Specifies the encoding for returned records; either <a className="el" href="/content/api/cpp/namespacegpudb#a00f46bff9ce56198eebb749449ad7dc8">binary</a> or <a className="el" href="/content/api/cpp/namespacegpudb#aa47ea5d8889f2cad76e71230791548ef">json</a>. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a00f46bff9ce56198eebb749449ad7dc8">get\_records\_by\_column\_binary</a> </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa47ea5d8889f2cad76e71230791548ef">get\_records\_by\_column\_json</a> </li>
        </ul>

        <p>The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a00f46bff9ce56198eebb749449ad7dc8">get\_records\_by\_column\_binary</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__by__column_8h_source#l00380">380</a> of file <a className="el" href="/content/api/cpp/get__records__by__column_8h_source">get\_records\_by\_column.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a036170d92eb383fc6d7870158671089d">◆ </a></span>limit</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int64\_t gpudb::GetRecordsByColumnRequest::limit</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A positive integer indicating the maximum number of results to be returned, or END\_OF\_SET (-9999) to indicate that the maximum number of results allowed by the server should be returned. </p>
        <p>The number of records returned will never exceed the server's own limit, defined by the <a href="/content/config/#config-main-general" target="_top">max\_get\_records\_size</a> parameter in the server configuration. Use <a className="el" href="/content/api/cpp/structgpudb_1_1RawGetRecordsByColumnResponse#aacb0ce76f7cd842a1a9cce15365b34cf">hasMoreRecords</a> to see if more records exist in the result to be fetched, and <a className="el" href="#a18191415826f865ec4f6a0d6dc6855ed">offset</a> and <a className="el" href="#a036170d92eb383fc6d7870158671089d">limit</a> to request subsequent pages of results. The default value is -9999. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__by__column_8h_source#l00364">364</a> of file <a className="el" href="/content/api/cpp/get__records__by__column_8h_source">get\_records\_by\_column.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a18191415826f865ec4f6a0d6dc6855ed">◆ </a></span>offset</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">int64\_t gpudb::GetRecordsByColumnRequest::offset</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>A positive integer indicating the number of initial results to skip (this can be useful for paging through the results). </p>
        <p>The default value is 0. The minimum allowed value is 0. The maximum allowed value is MAX\_INT. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__by__column_8h_source#l00349">349</a> of file <a className="el" href="/content/api/cpp/get__records__by__column_8h_source">get\_records\_by\_column.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a4e6952cc02b65128e4ad34679db2d299">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::GetRecordsByColumnRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a40c38c510dc7a5c6e33feeee54b47ce0">get\_records\_by\_column\_expression</a>: Filter expression to apply to the table. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab655054cebcfd9067f7f35c9e2ec43b3">get\_records\_by\_column\_sort\_by</a>: Column that the data should be sorted by. Used in conjunction with <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">sort\_order</a>. The <a className="el" href="/content/api/cpp/namespacegpudb#af02eca012e8de80e8e38c2d4b70d4383">order\_by</a> option can be used in lieu of <a className="el" href="/content/api/cpp/namespacegpudb#ab655054cebcfd9067f7f35c9e2ec43b3">sort\_by</a> / <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">sort\_order</a>. The default value is ''. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">get\_records\_by\_column\_sort\_order</a>: String indicating how the returned values should be sorted - <a className="el" href="/content/api/cpp/namespacegpudb#afc9919fed190f2c386350b030eb40566">ascending</a> or <a className="el" href="/content/api/cpp/namespacegpudb#a73b3c1a06c6708264e0585c3e1b0c89a">descending</a>. If <a className="el" href="/content/api/cpp/namespacegpudb#a3197c54c5d213d3aff66a728e54bff56">sort\_order</a> is provided, <a className="el" href="/content/api/cpp/namespacegpudb#ab655054cebcfd9067f7f35c9e2ec43b3">sort\_by</a> has to be provided. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#afc9919fed190f2c386350b030eb40566">get\_records\_by\_column\_ascending</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a73b3c1a06c6708264e0585c3e1b0c89a">get\_records\_by\_column\_descending</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#afc9919fed190f2c386350b030eb40566">get\_records\_by\_column\_ascending</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#af02eca012e8de80e8e38c2d4b70d4383">get\_records\_by\_column\_order\_by</a>: 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 ''. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a314c60906c01b5d513374b32e935ca66">get\_records\_by\_column\_convert\_wkts\_to\_wkbs</a>: If <a className="el" href="/content/api/cpp/namespacegpudb#a10b5be6900c28fc88d28ecc89ed5a67c">true</a>, then WKT string columns will be returned as WKB bytes. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a10b5be6900c28fc88d28ecc89ed5a67c">get\_records\_by\_column\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a18a75ed4471dedf3f337fafccd529e68">get\_records\_by\_column\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a18a75ed4471dedf3f337fafccd529e68">get\_records\_by\_column\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a57f1bbd4459c912dbc0ad2b23ae58fb9">get\_records\_by\_column\_route\_to\_tom</a>: For multihead record retrieval without shard key expression - specifies from which tom to retrieve data. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__by__column_8h_source#l00438">438</a> of file <a className="el" href="/content/api/cpp/get__records__by__column_8h_source">get\_records\_by\_column.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a263821675907f32ae8da306a46c885f5">◆ </a></span>tableName</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::GetRecordsByColumnRequest::tableName</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of the table or view on which this operation will be performed, in \[ schema\_name. ]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. </p>
        <p>An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/get__records__by__column_8h_source#l00336">336</a> of file <a className="el" href="/content/api/cpp/get__records__by__column_8h_source">get\_records\_by\_column.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/get__records__by__column_8h_source">get\_records\_by\_column.h</a></li>
    </ul>
  </div>
</div>