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

Defined in: api.ts:410

Type definition for a Dynamic Sync Table. Should not be necessary to use directly, instead, define dynamic sync tables using makeDynamicSyncTable.

Extends

• SyncTableDef<K, L, ParamDefsT, SchemaT, ContextT, PermissionsContextT>

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

Inherited from

SyncTableDef.defaultAddDynamicColumns

---

description?

optional description: string

Defined in: api.ts:366

See SyncTableOptions.description

Inherited from

SyncTableDef.description

---

displayName?

optional displayName: string

Defined in: api.ts:363

See SyncTableOptions.displayName

Inherited from

SyncTableDef.displayName

---

entityName?

optional entityName: string

Defined in: api.ts:383

See DynamicOptions.entityName

Inherited from

SyncTableDef.entityName

---

getDisplayUrl

getDisplayUrl: MetadataFormula<ContextT>

Defined in: api.ts:425

See DynamicSyncTableOptions.getDisplayUrl

---

getName

getName: MetadataFormula<ContextT>

Defined in: api.ts:423

See DynamicSyncTableOptions.getName

---

getSchema

getSchema: MetadataFormula<ContextT>

Defined in: api.ts:421

See DynamicSyncTableOptions.getSchema

Overrides

SyncTableDef.getSchema

---

getter

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

Defined in: api.ts:379

See SyncTableOptions.formula

Inherited from

SyncTableDef.getter

---

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.

Inherited from

SyncTableDef.identityName

---

indexing?

optional indexing: object

Defined in: api.ts:400

See SyncTableOptions.indexing

default

default: DataIndexing

See DataIndexing

Inherited from

SyncTableDef.indexing

---

instructions?

optional instructions: string

Defined in: api.ts:368

See SyncTableOptions.instructions

Inherited from

SyncTableDef.instructions

---

isDynamic

isDynamic: true

Defined in: api.ts:419

Identifies this sync table as dynamic.

---

listDynamicUrls?

optional listDynamicUrls: MetadataFormula<ExecutionContext, LegacyDefaultMetadataReturnType>

Defined in: api.ts:427

See DynamicSyncTableOptions.listDynamicUrls

---

name

name: string

Defined in: api.ts:360

See SyncTableOptions.name

Inherited from

SyncTableDef.name

---

propertyOptions?

optional propertyOptions: PropertyOptionsMetadataFormula<any>

Defined in: api.ts:434

See DynamicSyncTableOptions.propertyOptions

---

schema

schema: SchemaT

Defined in: api.ts:370

See SyncTableOptions.schema

Inherited from

SyncTableDef.schema

---

searchDynamicUrls?

optional searchDynamicUrls: MetadataFormula<ExecutionContext, LegacyDefaultMetadataReturnType>

Defined in: api.ts:429

See DynamicSyncTableOptions.searchDynamicUrls