Interface: BaseTableReader<DataModel, TableName>

server.BaseTableReader

​

Type parameters

​

Hierarchy

• BaseTableReader ↳ BaseTableWriter

​

Methods

​

get

▸ get<Fields>(id, options): Promise<null | SelectedDocument<DocumentByName<DataModel, TableName>, Fields>> Read selected top-level properties, retaining identity and creation time.

​

Type parameters

​

Parameters

​

Returns

Promise<null | SelectedDocument<DocumentByName<DataModel, TableName>, Fields>> ▸ get(id): Promise<null | DocumentByName<DataModel, TableName>> Fetch a single document from the table by its GenericId.

​

Parameters

​

Returns

Promise<null | DocumentByName<DataModel, TableName>>

• The GenericDocument of the document at the given GenericId, or null if it no longer exists.

---

​

query

▸ query(): SelectableQueryInitializer<NamedTableInfo<DataModel, TableName>> Begin a query for the table. Queries don’t execute immediately, so calling this method and extending its query are free until the results are actually used.

​

Returns

SelectableQueryInitializer<NamedTableInfo<DataModel, TableName>>

• A QueryInitializer object to start building a query.