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

> GetRecordsByColumnRequest — Kinetica TypeScript API

interface GetRecordsByColumnRequest \{\
&#x20;[column\_names](#column_names): string\[];\
&#x20;[encoding](#encoding)?: string;\
&#x20;[limit](#limit)?: number;\
&#x20;[offset](#offset)?: number;\
&#x20;[options](#options)?: Record\<string, string>;\
&#x20;[table\_name](#table_name): string;\
}

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

##### Index

### Properties

[column\_names](#column_names) [encoding?](#encoding) [limit?](#limit) [offset?](#offset) [options?](#options) [table\_name](#table_name)&#x20;

## Properties

### column\_names

column\_names: string\[]

The list of column values to retrieve.

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

### `Optional`encoding

encoding?: string

Specifies the encoding for returned records; one of binary, json or arrow.

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

### `Optional`limit

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.

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

### `Optional`offset

offset?: number

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

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

### `Optional`options

options?: Record\<string, string>

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

### table\_name

table\_name: string

Name of the table or view on which this operation will be performed, in \[schema\_name.]table\_name format, using standard name resolution rules. An empty table name retrieves one record from a single-row virtual table, where columns specified should be constants or constant expressions.

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


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