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

# get_records

### get\_records

<ul>
  <li>
    get\_records(\
    &#x20;table\_name: string,\
    &#x20;offset?: number,\
    &#x20;limit?: number,\
    &#x20;options?: Record\<string, string>,\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md),\
    ): Promise\<[GetRecordsResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/GetRecordsResponse.md)>

    Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables and views. Records can be returned encoded as binary, json, or geojson.This operation supports paging through the data via the `offset` and `limit` 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.

    #### Parameters

    <ul>
      <li>
        table\_name: string

        Name of the table or view from which the records will be fetched, in \[schema\_name.]table\_name format, using standard name resolution rules.
      </li>

      <li>
        `Optional`offset: number

        A positive integer indicating the number of initial results to skip (this can be useful for paging through the results).
      </li>

      <li>
        `Optional`limit: number

        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 max\_get\_records\_size parameter in the server configuration. Use `has_more_records` to see if more records exist in the result to be fetched, and `offset` and `limit` to request subsequent pages of results.
      </li>

      <li>`Optional`options: Record\<string, string></li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[GetRecordsResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/GetRecordsResponse.md)>

    Promise\<Types.GetRecordsResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:10356](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L10356)</li>
    </ul>
  </li>
</ul>

### get\_records\_request

<ul>
  <li>
    get\_records\_request(\
    &#x20;request: [GetRecordsRequest](https://docs.kinetica.com/content/api/nodejs/interfaces/GetRecordsRequest.md),\
    &#x20;callback?: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md),\
    ): Promise\<[GetRecordsResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/GetRecordsResponse.md)>

    Retrieves records from a given table, optionally filtered by an expression and/or sorted by a column. This operation can be performed on tables and views. Records can be returned encoded as binary, json, or geojson.This operation supports paging through the data via the `offset` and `limit` 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.

    #### Parameters

    <ul>
      <li>
        request: [GetRecordsRequest](https://docs.kinetica.com/content/api/nodejs/interfaces/GetRecordsRequest.md)

        Request object containing the parameters for the operation
      </li>

      <li>
        `Optional`callback: [GPUdbCallback](https://docs.kinetica.com/content/api/nodejs/types/GPUdbCallback.md)

        Optional callback function
      </li>
    </ul>

    #### Returns Promise\<[GetRecordsResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/GetRecordsResponse.md)>

    Promise\<Types.GetRecordsResponse> - Promise resolving to the response

    <ul>
      <li>Defined in [src/GPUdb.ts:10308](https://github.com/kineticadb/kinetica-api-typescript/blob/master/src/GPUdb.ts#L10308)</li>
    </ul>
  </li>
</ul>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.