@tauri-apps/plugin-sql

Clases

default

Database

La clase Database sirve como la interfaz principal para comunicarse con el lado de Rust del plugin sql.

Constructores

new default()

new default(path): default

Parámetros

Parámetro	Tipo
path	string

Devuelve

default

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/sql/guest-js/index.ts#L29

Propiedades

Propiedad	Tipo	Definido en
path	string	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/sql/guest-js/index.ts#L28

Métodos

close()

close(db?): Promise<boolean>

close

Cierra el grupo de conexiones (connection pool) a la base de datos.

Parámetros

Parámetro	Tipo	Descripción
db?	string	Opcionalmente indica el nombre de una base de datos si estás gestionando más de una. De lo contrario, todos los grupos de bases de datos estarán dentro del alcance.

Devuelve

Promise<boolean>

Ejemplo

const success = await db.close()

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/sql/guest-js/index.ts#L162

execute()

execute(query, bindValues?): Promise<QueryResult>

execute

Pasa una expresión SQL a la base de datos para su ejecución.

Parámetros

Parámetro	Tipo
query	string
bindValues?	unknown[]

Devuelve

Promise<QueryResult>

Ejemplo

// 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 ]
);

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/sql/guest-js/index.ts#L108

select()

select<T>(query, bindValues?): Promise<T>

select

Pasa una consulta SELECT a la base de datos para su ejecución.

Parámetros de tipo

Parámetro de tipo
T

Parámetros

Parámetro	Tipo
query	string
bindValues?	unknown[]

Devuelve

Promise<T>

Ejemplo

// 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 ]
);

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/sql/guest-js/index.ts#L141

get()

static get(path): default

get

Un inicializador estático que devuelve de forma síncrona una instancia de la clase Database mientras pospone la conexión real a la base de datos hasta la primera invocación o selección en la base de datos.

Sqlite

La ruta es relativa a tauri::path::BaseDirectory::App y debe comenzar con sqlite:.

Parámetros

Parámetro	Tipo
path	string

Devuelve

default

Ejemplo

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

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/sql/guest-js/index.ts#L72

load()

static load(path): Promise<default>

load

Un inicializador estático que se conecta a la base de datos subyacente y devuelve una instancia de Database una vez que se establece una conexión con la base de datos.

Sqlite

La ruta es relativa a tauri::path::BaseDirectory::App y debe comenzar con sqlite:.

Parámetros

Parámetro	Tipo
path	string

Devuelve

Promise<default>

Ejemplo

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

Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/sql/guest-js/index.ts#L48

Interfaces

QueryResult

Propiedades

Propiedad	Tipo	Descripción	Definido en
lastInsertId?	number	El último id insertado. Este valor no se establece para bases de datos Postgres. Si se requiere el último id insertado en Postgres, se debe usar la función select, con una cláusula RETURNING (INSERT INTO todos (title) VALUES ($1) RETURNING id).	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/sql/guest-js/index.ts#L18
rowsAffected	number	El número de filas afectadas por la consulta.	Fuente: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/sql/guest-js/index.ts#L9