Library Core / src / Database

Class: Database

src.Database

Wraps a sqlite3 database and provides abstracted methods to access database information.

Hierarchy

• Database

  ↳ CatalogDatabase

Table of contents

Constructors

• constructor

Methods

• getRow
• getRows

Constructors

constructor

• new Database(path)

Parameters

Name	Type	Description
path	string	The path to the database.

Defined in

src/classes/Database.ts:21

Methods

getRow

▸ getRow<T>(query, params?): Promise<undefined | T>

Returns the first matched row of the provided query. The return type must be provided in TS as the row structure is unknown.

example

const db = new Database(path)
const row = await db.getRow<PublicationRow>(query)

Type parameters

Name
T

Parameters

Name	Type	Description
query	string	The SQL query to run.
params?	QueryParams	Query params to use.

Returns

Promise<undefined | T>

A single row if it exists, or undefined if not found.

Defined in

src/classes/Database.ts:49

---

getRows

▸ getRows<T>(query, params?): Promise<T[]>

Returns all matched rows of the provided query. The return type of a single row must be provided in TS as the row structure is unknown.

example

const db = new Database(path)
const rows = await db.getRows<PublicationRow>(query)

Type parameters

Name
T

Parameters

Name	Type	Description
query	string	The SQL query to run.
params?	QueryParams	Query params to use.

Returns

Promise<T[]>

An array of matched rows. If none were found an empty array will be returned.

Defined in

src/classes/Database.ts:69