Class
SinterDatabase
A handle to a database on a server.
Get one from SinterClient.db.
class SinterDatabaseDefined in packages/driver/src/database.ts:12
Constructors#
constructor
#new SinterDatabase(client: SinterClient, name: string)Parameters
client: SinterClientThe client this database belongs to.
name: string
Defined in packages/driver/src/database.ts:16
Properties#
client
#readonly client: SinterClientThe client this database belongs to.
Defined in packages/driver/src/database.ts:18
name
#readonly name: stringThe database name.
Defined in packages/driver/src/database.ts:14
Methods#
collection
#collection<TDocument extends object = Document>(
name: string,
): SinterCollection<TDocument>Returns a handle to a collection. No request is sent; the collection is created by the first write.
Type parameters
TDocument extends object = DocumentThe shape of the documents, used for type-checking.
Parameters
name: stringThe collection name.
Defined in packages/driver/src/database.ts:33
listCollections
#listCollections(): Promise<string[]>Lists the names of the collections in this database.
Defined in packages/driver/src/database.ts:40