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

core.SyncTableDef

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

Type parameters

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

Hierarchy

• SyncTableDef

↳ DynamicSyncTableDef

Properties

defaultAddDynamicColumns

• Optional defaultAddDynamicColumns: boolean

See defaultAddDynamicColumns

Defined in

api.ts:341

---

description

• Optional description: string

See description

Defined in

api.ts:324

---

displayName

• Optional displayName: string

See displayName

Defined in

api.ts:321

---

entityName

• Optional entityName: string

See entityName

Defined in

api.ts:339

---

getSchema

• Optional getSchema: MetadataFormula<ExecutionContext>

See getSchema

Defined in

api.ts:337

---

getter

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

See formula

Defined in

api.ts:335

---

identityName

• identityName: string

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

See identityName for more details.

Defined in

api.ts:333

---

name

• name: string

See name

Defined in

api.ts:318

---

schema

• schema: SchemaT

See schema

Defined in

api.ts:326