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

# getRecords

<div className="kinetica-doxygen">
  <div id="a5d0dbc4f9613cd25b21e3f9a6cc1790b" />

  <h2 className="memtitle"><span className="permalink"><a href="#a5d0dbc4f9613cd25b21e3f9a6cc1790b">◆ </a></span>getRecords\< T >() <span className="overload">\[1/2]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname">GetRecordsResponse\< T > kinetica.Kinetica.getRecords\< T > </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1GetRecordsRequest">GetRecordsRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></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>Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. </p>
      <p>This operation can be performed on tables and views. <a className="el" href="/content/api/cs/namespacekinetica_1_1Records">Records</a> can be returned encoded as binary, json, or geojson.</p>
      <p>This operation supports paging through the data via the <a className="el" href="/content/api/cs/classkinetica_1_1GetRecordsRequest#a5be7630ef5c368063a255cb1602f3b5e">offset</a> and <a className="el" href="/content/api/cs/classkinetica_1_1GetRecordsRequest#a464f7532dd974366cd2e3fa9c72c9357">limit</a> parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.</p>

      <div className="dl tparams">
        <div className="dt">Template Parameters</div>

        <div className="dd">
          <table className="tparams">
            <tr>
              <td className="paramname">T</td>
              <td>The type of object being retrieved.</td>
            </tr>
          </table>
        </div>
      </div>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <div className="typeconstraint">
        <div className="dl">
          <div className="dt"><span className="b">Type Constraints</span></div>

          <div className="dd">
            <table border="0" cellSpacing="2" cellPadding="0">
              <tr>
                <td valign="top"><span className="em">T</span></td>
                <td> :</td>
                <td valign="top"><span className="em">new()</span></td>
                <td> </td>
              </tr>
            </table>
          </div>
        </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L40629">40629</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a7da4cb8950e5aca59df0ad68172c8cd6" />

  <h2 className="memtitle"><span className="permalink"><a href="#a7da4cb8950e5aca59df0ad68172c8cd6">◆ </a></span>getRecords\< T >() <span className="overload">\[2/2]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname">GetRecordsResponse\< T > kinetica.Kinetica.getRecords\< T > </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">table\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">long</td>
                <td className="paramname"><span className="paramname"><span className="em">offset</span></span><span className="paramdefsep"> = </span><span className="paramdefval">0</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">long</td>
                <td className="paramname"><span className="paramname"><span className="em">limit</span></span><span className="paramdefsep"> = </span><span className="paramdefval">-9999</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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>Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. </p>
      <p>This operation can be performed on tables and views. <a className="el" href="/content/api/cs/namespacekinetica_1_1Records">Records</a> can be returned encoded as binary, json, or geojson.</p>
      <p>This operation supports paging through the data via the <span className="em">offset</span> and <span className="em">limit</span> parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.</p>

      <div className="dl tparams">
        <div className="dt">Template Parameters</div>

        <div className="dd">
          <table className="tparams">
            <tr>
              <td className="paramname">T</td>
              <td>The type of object being retrieved.</td>
            </tr>
          </table>
        </div>
      </div>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">table\_name</td>
              <td>Name of the table or view from which the records will be fetched, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>.</td>
            </tr>

            <tr>
              <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="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/cs/classkinetica_1_1RawGetRecordsResponse#afcc6b44e1f18965757e8aa7d7f0c428c">has\_more\_records</a> to see if more records exist in the result to be fetched, and <span className="em">offset</span> and <span className="em">limit</span> to request subsequent pages of results. The default value is -9999.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a94b65a3dfe98281f0e1229588b2a1756">EXPRESSION</a>: Filter expression to apply to the table. </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a4c2bc06d5c1248fd64c876bec775eb9d">FAST\_INDEX\_LOOKUP</a>: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from \[0 to END\_OF\_SET]. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a509446a4d6cf928f879273b815e28f29">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#afaabb852b5ec2fda5fd8c66eb7a0ae2c">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a509446a4d6cf928f879273b815e28f29">TRUE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a9099227461efce6c583551240e6e70e9">SORT\_BY</a>: Column that the data should be sorted by. Empty by default (i.e. no sorting is applied). </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#abc1b5b65499a79fde0a3eaaef4f76b0b">SORT\_ORDER</a>: String indicating how the returned values should be sorted - ascending or descending. If sort\_order is provided, sort\_by has to be provided. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a402903a2a6b1033fda983433504cf9bf">ASCENDING</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a4bd4f019dc18212bfcb33ccf2a486f65">DESCENDING</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a402903a2a6b1033fda983433504cf9bf">ASCENDING</a>.
                  </li>
                </ul>

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

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <div className="typeconstraint">
        <div className="dl">
          <div className="dt"><span className="b">Type Constraints</span></div>

          <div className="dd">
            <table border="0" cellSpacing="2" cellPadding="0">
              <tr>
                <td valign="top"><span className="em">T</span></td>
                <td> :</td>
                <td valign="top"><span className="em">new()</span></td>
                <td> </td>
              </tr>
            </table>
          </div>
        </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L40780">40780</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="ab6e7cdd4f513463bbd1ca7ff61103df7" />

  <h2 className="memtitle"><span className="permalink"><a href="#ab6e7cdd4f513463bbd1ca7ff61103df7">◆ </a></span>GetRecordsAsync\< T >() <span className="overload">\[1/2]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname">async System.Threading.Tasks.Task\< GetRecordsResponse\< T > > kinetica.Kinetica.GetRecordsAsync\< T > </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1GetRecordsRequest">GetRecordsRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. </p>
      <p>(async) </p>
      <p>This operation can be performed on tables and views. <a className="el" href="/content/api/cs/namespacekinetica_1_1Records">Records</a> can be returned encoded as binary, json, or geojson.</p>
      <p>This operation supports paging through the data via the <a className="el" href="/content/api/cs/classkinetica_1_1GetRecordsRequest#a5be7630ef5c368063a255cb1602f3b5e">offset</a> and <a className="el" href="/content/api/cs/classkinetica_1_1GetRecordsRequest#a464f7532dd974366cd2e3fa9c72c9357">limit</a> parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.</p>

      <div className="dl tparams">
        <div className="dt">Template Parameters</div>

        <div className="dd">
          <table className="tparams">
            <tr>
              <td className="paramname">T</td>
              <td>The type of object being retrieved.</td>
            </tr>
          </table>
        </div>
      </div>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <div className="typeconstraint">
        <div className="dl">
          <div className="dt"><span className="b">Type Constraints</span></div>

          <div className="dd">
            <table border="0" cellSpacing="2" cellPadding="0">
              <tr>
                <td valign="top"><span className="em">T</span></td>
                <td> :</td>
                <td valign="top"><span className="em">new()</span></td>
                <td> </td>
              </tr>
            </table>
          </div>
        </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L40665">40665</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a2a27441709ad43c5ab33cd9316008b4b" />

  <h2 className="memtitle"><span className="permalink"><a href="#a2a27441709ad43c5ab33cd9316008b4b">◆ </a></span>GetRecordsAsync\< T >() <span className="overload">\[2/2]</span></h2>

  <div className="memitem">
    <div className="memproto">
      <table className="mlabels">
        <tr>
          <td className="mlabels-left">
            <table className="memname">
              <tr>
                <td className="memname">async System.Threading.Tasks.Task\< GetRecordsResponse\< T > > kinetica.Kinetica.GetRecordsAsync\< T > </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">table\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">long</td>
                <td className="paramname"><span className="paramname"><span className="em">offset</span></span><span className="paramdefsep"> = </span><span className="paramdefval">0</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">long</td>
                <td className="paramname"><span className="paramname"><span className="em">limit</span></span><span className="paramdefsep"> = </span><span className="paramdefval">-9999</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. </p>
      <p>(async) </p>
      <p>This operation can be performed on tables and views. <a className="el" href="/content/api/cs/namespacekinetica_1_1Records">Records</a> can be returned encoded as binary, json, or geojson.</p>
      <p>This operation supports paging through the data via the <span className="em">offset</span> and <span className="em">limit</span> parameters. Note that when paging through a table, if the table (or the underlying table in case of a view) is updated (records are inserted, deleted or modified) the records retrieved may differ between calls based on the updates applied.</p>

      <div className="dl tparams">
        <div className="dt">Template Parameters</div>

        <div className="dd">
          <table className="tparams">
            <tr>
              <td className="paramname">T</td>
              <td>The type of object being retrieved.</td>
            </tr>
          </table>
        </div>
      </div>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">table\_name</td>
              <td>Name of the table or view from which the records will be fetched, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>.</td>
            </tr>

            <tr>
              <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="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/cs/classkinetica_1_1RawGetRecordsResponse#afcc6b44e1f18965757e8aa7d7f0c428c">has\_more\_records</a> to see if more records exist in the result to be fetched, and <span className="em">offset</span> and <span className="em">limit</span> to request subsequent pages of results. The default value is -9999.</td>
            </tr>

            <tr>
              <td className="paramname">options</td>

              <td>
                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a94b65a3dfe98281f0e1229588b2a1756">EXPRESSION</a>: Filter expression to apply to the table. </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a4c2bc06d5c1248fd64c876bec775eb9d">FAST\_INDEX\_LOOKUP</a>: Indicates if indexes should be used to perform the lookup for a given expression if possible. Only applicable if there is no sorting, the expression contains only equivalence comparisons based on existing tables indexes and the range of requested values is from \[0 to END\_OF\_SET]. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a509446a4d6cf928f879273b815e28f29">TRUE</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#afaabb852b5ec2fda5fd8c66eb7a0ae2c">FALSE</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a509446a4d6cf928f879273b815e28f29">TRUE</a>.
                  </li>

                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a9099227461efce6c583551240e6e70e9">SORT\_BY</a>: Column that the data should be sorted by. Empty by default (i.e. no sorting is applied). </li>

                  <li>
                    <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#abc1b5b65499a79fde0a3eaaef4f76b0b">SORT\_ORDER</a>: String indicating how the returned values should be sorted - ascending or descending. If sort\_order is provided, sort\_by has to be provided. Supported values:

                    <ul>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a402903a2a6b1033fda983433504cf9bf">ASCENDING</a> </li>
                      <li> <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a4bd4f019dc18212bfcb33ccf2a486f65">DESCENDING</a> </li>
                    </ul>

                    The default value is <a className="el" href="/content/api/cs/structkinetica_1_1GetRecordsRequest_1_1Options#a402903a2a6b1033fda983433504cf9bf">ASCENDING</a>.
                  </li>
                </ul>

                The default value is an empty Dictionary.
              </td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <div className="typeconstraint">
        <div className="dl">
          <div className="dt"><span className="b">Type Constraints</span></div>

          <div className="dd">
            <table border="0" cellSpacing="2" cellPadding="0">
              <tr>
                <td valign="top"><span className="em">T</span></td>
                <td> :</td>
                <td valign="top"><span className="em">new()</span></td>
                <td> </td>
              </tr>
            </table>
          </div>
        </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L40888">40888</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>
</div>