Skip to main content

Interface: GenericDatabaseReaderWithTable<DataModel>

server.GenericDatabaseReaderWithTable

Type parameters

NameType
DataModelextends GenericDataModel

Hierarchy

Properties

system

system: BaseDatabaseReaderWithTable<SystemDataModel>

An interface to read from the system tables within Convex query functions

The two entry points are:

  • get, which fetches a single document by its GenericId.
  • query, which starts building a query.

Defined in

server/database.ts:132

Methods

table

table<TableName>(tableName): BaseTableReader<DataModel, TableName>

Scope the database to a specific table.

Type parameters

NameType
TableNameextends string

Parameters

NameType
tableNameTableName

Returns

BaseTableReader<DataModel, TableName>

Inherited from

BaseDatabaseReaderWithTable.table

Defined in

server/database.ts:61