constructor

• new default(path: string): default

  Parameters

  • path: string

  Returns default

path

Staticload

• load(path: string): Promise<default>

  load

  A static initializer which connects to the underlying database and returns a Database instance once a connection to the database is established.

  Sqlite

  The path is relative to tauri::path::BaseDirectory::App and must start with sqlite:.

  Parameters

  • path: string

  Returns Promise<default>

  Example

  const db = await Database.load("sqlite:test.db");
  Copy

Staticget

• get(path: string): default

  get

  A static initializer which synchronously returns an instance of the Database class while deferring the actual database connection until the first invocation or selection on the database.

  Sqlite

  The path is relative to tauri::path::BaseDirectory::App and must start with sqlite:.

  Parameters

  • path: string

  Returns default

  Example

  const db = Database.get("sqlite:test.db");
  Copy

execute

• execute(query: string, bindValues?: unknown[]): Promise<QueryResult>

  execute

  Passes a SQL expression to the database for execution.

  Parameters

  • query: string
  • OptionalbindValues: unknown[]

  Returns Promise<QueryResult>

  Example

  // for sqlite & postgres
  // INSERT example
  const result = await db.execute(
     "INSERT into todos (id, title, status) VALUES ($1, $2, $3)",
     [ todos.id, todos.title, todos.status ]
  );
  // UPDATE example
  const result = await db.execute(
     "UPDATE todos SET title = $1, completed = $2 WHERE id = $3",
     [ todos.title, todos.status, todos.id ]
  );
  
  // for mysql
  // INSERT example
  const result = await db.execute(
     "INSERT into todos (id, title, status) VALUES (?, ?, ?)",
     [ todos.id, todos.title, todos.status ]
  );
  // UPDATE example
  const result = await db.execute(
     "UPDATE todos SET title = ?, completed = ? WHERE id = ?",
     [ todos.title, todos.status, todos.id ]
  );
  Copy

select

• select<T>(query: string, bindValues?: unknown[]): Promise<T>

  select

  Passes in a SELECT query to the database for execution.

  Type Parameters

  • T

  Parameters

  • query: string
  • OptionalbindValues: unknown[]

  Returns Promise<T>

  Example

  // for sqlite & postgres
  const result = await db.select(
     "SELECT * from todos WHERE id = $1", [ id ]
  );
  
  // for mysql
  const result = await db.select(
     "SELECT * from todos WHERE id = ?", [ id ]
  );
  Copy

close

• close(db?: string): Promise<boolean>

  close

  Closes the database connection pool.

  Parameters

  • Optionaldb: string

    Optionally state the name of a database if you are managing more than one. Otherwise, all database pools will be in scope.

  Returns Promise<boolean>

  Example

  const success = await db.close()
  Copy