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

Defined in: api.ts:351

The result of defining a sync table. Should not be necessary to use directly, instead, define sync tables using makeSyncTable.

Extended by¶

DynamicSyncTableDef

Type Parameters¶

Type Parameter
`K` extends `string`
`L` extends `string`
`ParamDefsT` extends `ParamDefs`
`SchemaT` extends `ObjectSchema`<`K`, `L`>
`ContextT` extends `SyncExecutionContext`<`any`, `any`>
`PermissionsContextT` extends `SyncPassthroughData`

Properties¶

defaultAddDynamicColumns?¶

optional defaultAddDynamicColumns: boolean

Defined in: api.ts:385

See DynamicOptions.defaultAddDynamicColumns

description?¶

optional description: string

Defined in: api.ts:366

See SyncTableOptions.description

displayName?¶

optional displayName: string

Defined in: api.ts:363

See SyncTableOptions.displayName

entityName?¶

optional entityName: string

Defined in: api.ts:383

See DynamicOptions.entityName

getSchema?¶

optional getSchema: MetadataFormula<ExecutionContext, LegacyDefaultMetadataReturnType>

Defined in: api.ts:381

See DynamicOptions.getSchema

getter¶

getter: SyncFormula<K, L, ParamDefsT, SchemaT, ContextT, PermissionsContextT>

Defined in: api.ts:379

See SyncTableOptions.formula

identityName¶

identityName: string

Defined in: api.ts:377

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

See SyncTableOptions.identityName for more details.

indexing?¶

optional indexing: object

Defined in: api.ts:400

See SyncTableOptions.indexing

default¶

default: DataIndexing

See DataIndexing

instructions?¶

optional instructions: string

Defined in: api.ts:368

See SyncTableOptions.instructions

name¶

name: string

Defined in: api.ts:360

See SyncTableOptions.name

schema¶

schema: SchemaT

Defined in: api.ts:370

See SyncTableOptions.schema