# Interface: SyncTableDef\<K, L, ParamDefsT, SchemaT, ContextT, PermissionsContextT>

Defined in: [api.ts:351](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L351)

The result of defining a sync table. Should not be necessary to use directly, instead, define sync tables using [makeSyncTable](../../functions/makeSyncTable/).

## Extended by

- [`DynamicSyncTableDef`](../DynamicSyncTableDef/)

## Type Parameters

| Type Parameter | | --- | | `K` *extends* `string` | | `L` *extends* `string` | | `ParamDefsT` *extends* [`ParamDefs`](../../type-aliases/ParamDefs/) | | `SchemaT` *extends* `ObjectSchema`\<`K`, `L`> | | `ContextT` *extends* [`SyncExecutionContext`](../SyncExecutionContext/)\<`any`, `any`> | | `PermissionsContextT` *extends* `SyncPassthroughData` |

## Properties

### defaultAddDynamicColumns?

> `optional` **defaultAddDynamicColumns**: `boolean`

Defined in: [api.ts:385](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L385)

See [DynamicOptions.defaultAddDynamicColumns](../DynamicOptions/#defaultadddynamiccolumns)

______________________________________________________________________

### description?

> `optional` **description**: `string`

Defined in: [api.ts:366](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L366)

See [SyncTableOptions.description](../SyncTableOptions/#description)

______________________________________________________________________

### displayName?

> `optional` **displayName**: `string`

Defined in: [api.ts:363](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L363)

See [SyncTableOptions.displayName](../SyncTableOptions/#displayname)

______________________________________________________________________

### entityName?

> `optional` **entityName**: `string`

Defined in: [api.ts:383](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L383)

See [DynamicOptions.entityName](../DynamicOptions/#entityname)

______________________________________________________________________

### getSchema?

> `optional` **getSchema**: [`MetadataFormula`](../../type-aliases/MetadataFormula/)\<[`ExecutionContext`](../ExecutionContext/), [`LegacyDefaultMetadataReturnType`](../../type-aliases/LegacyDefaultMetadataReturnType/)>

Defined in: [api.ts:381](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L381)

See [DynamicOptions.getSchema](../DynamicOptions/#getschema)

______________________________________________________________________

### getter

> **getter**: [`SyncFormula`](../../type-aliases/SyncFormula/)\<`K`, `L`, `ParamDefsT`, `SchemaT`, `ContextT`, `PermissionsContextT`>

Defined in: [api.ts:379](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L379)

See [SyncTableOptions.formula](../SyncTableOptions/#formula)

______________________________________________________________________

### identityName

> **identityName**: `string`

Defined in: [api.ts:377](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L377)

The `identityName` is persisted for all sync tables so that a dynamic schema can be annotated with an identity automatically.

See [SyncTableOptions.identityName](../SyncTableOptions/#identityname) for more details.

______________________________________________________________________

### indexing?

> `optional` **indexing**: `object`

Defined in: [api.ts:400](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L400)

See [SyncTableOptions.indexing](../SyncTableOptions/#indexing)

#### default

> **default**: [`DataIndexing`](../../enumerations/DataIndexing/)

See [DataIndexing](../../enumerations/DataIndexing/)

______________________________________________________________________

### instructions?

> `optional` **instructions**: `string`

Defined in: [api.ts:368](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L368)

See [SyncTableOptions.instructions](../SyncTableOptions/#instructions)

______________________________________________________________________

### name

> **name**: `string`

Defined in: [api.ts:360](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L360)

See [SyncTableOptions.name](../SyncTableOptions/#name)

______________________________________________________________________

### schema

> **schema**: `SchemaT`

Defined in: [api.ts:370](https://github.com/coda/packs-sdk/blob/b2b4c9dba5ca748bdbb94481cc13b5ca3c328ef6/api.ts#L370)

See [SyncTableOptions.schema](../SyncTableOptions/#schema)