@temporary-escape/mod-sdk / Database

Class: Database

Defined in: database/database.ts:15

The shared document-database API, implemented by TransactionalDatabase and Transaction.

AssemblyScript forbids type parameters on interface and abstract methods (the generic T on get/insert/seek/...), so this is a concrete base class whose methods throw; the two implementations override every method. Treat it as the Database interface.

Extended by

• Transaction
• TransactionalDatabase

Constructors

Constructor

new Database(): Database;

Returns

Database

Methods

get()

get<T extends Serializable>(
   _factory: () => T, 
   _doc: string, 
   _key: number
): T | null;

Defined in: database/database.ts:22

Returns a document from the database, or null if not found.

Type Parameters

Type Parameter
T extends Serializable

Parameters

Parameter	Type
_factory	() => T
_doc	string
_key	number

Returns

T | null

---

getByIndex()

getByIndex<T extends Serializable>(
   _factory: () => T, 
   _doc: string, 
   _index: string, 
   _keys: number[]
): IndexResult<T> | null;

Defined in: database/database.ts:88

Looks up a single document by one of its indexes.

Type Parameters

Type Parameter
T extends Serializable

Parameters

Parameter	Type
_factory	() => T
_doc	string
_index	string
_keys	number[]

Returns

IndexResult<T> | null

The matching document and its id, or null if nothing matches

---

insert()

insert<T extends Serializable>(_doc: string, _value: T): number;

Defined in: database/database.ts:31

Inserts a new document into the database, returning its new unique numeric ID

Type Parameters

Type Parameter
T extends Serializable

Parameters

Parameter	Type
_doc	string
_value	T

Returns

number

---

remove()

remove(_doc: string, _key: number): void;

Defined in: database/database.ts:50

Remove a document from the database

Parameters

Parameter	Type
_doc	string
_key	number

Returns

void

---

seek()

seek<T extends Serializable>(
   _factory: () => T, 
   _doc: string, 
   _key: number
): DocumentCursor<T>;

Defined in: database/database.ts:60

Creates a document cursor for seeking through the database

Type Parameters

Type Parameter
T extends Serializable

Parameters

Parameter	Type
_factory	() => T
_doc	string
_key	number

Returns

DocumentCursor<T>

---

seekIndex()

seekIndex<T extends Serializable>(
   _factory: () => T, 
   _doc: string, 
   _index: string, 
   _keys: number[]
): IndexCursor<T>;

Defined in: database/database.ts:104

Creates a cursor over every document whose index key begins with keys.

Type Parameters

Type Parameter
T extends Serializable

Parameters

Parameter	Type
_factory	() => T
_doc	string
_index	string
_keys	number[]

Returns

IndexCursor<T>

---

seekRange()

seekRange<T extends Serializable>(
   _factory: () => T, 
   _doc: string, 
   _keyStart: number, 
   _keyEnd: number
): DocumentCursor<T>;

Defined in: database/database.ts:71

Creates a document cursor for seeking through the database in a specific range

Type Parameters

Type Parameter
T extends Serializable

Parameters

Parameter	Type
_factory	() => T
_doc	string
_keyStart	number
_keyEnd	number

Returns

DocumentCursor<T>

---

update()

update<T extends Serializable>(
   _doc: string, 
   _key: number, 
   _value: T
): boolean;

Defined in: database/database.ts:41

Updates an existing document in the database, returning true if the document exists

Type Parameters

Type Parameter
T extends Serializable

Parameters

Parameter	Type
_doc	string
_key	number
_value	T

Returns

boolean