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

### get\_records\_from\_collection

<ul>
  <li>
    get\_records\_from\_collection(\
    &#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\<[GetRecordsFromCollectionResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/GetRecordsFromCollectionResponse.md)>

    Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as `delete_records`.This operation supports paging through the data via the `offset` and `limit` parameters.Note that when using the Java API, it is not possible to retrieve records from join views using this operation.(DEPRECATED)

    #### Parameters

    <ul>
      <li>
        table\_name: string

        Name of the collection or table from which records are to be retrieved, in \[schema\_name.]table\_name format, using standard name resolution rules. Must be an existing collection or table.
      </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 `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\<[GetRecordsFromCollectionResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/GetRecordsFromCollectionResponse.md)>

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

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

### get\_records\_from\_collection\_request

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

    Retrieves records from a collection. The operation can optionally return the record IDs which can be used in certain queries such as `delete_records`.This operation supports paging through the data via the `offset` and `limit` parameters.Note that when using the Java API, it is not possible to retrieve records from join views using this operation.(DEPRECATED)

    #### Parameters

    <ul>
      <li>
        request: [GetRecordsFromCollectionRequest](https://docs.kinetica.com/content/api/nodejs/interfaces/GetRecordsFromCollectionRequest.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\<[GetRecordsFromCollectionResponse](https://docs.kinetica.com/content/api/nodejs/interfaces/GetRecordsFromCollectionResponse.md)>

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

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


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