getDatabaseFile

Access the SQLite database file so that it can be uploaded to the server or allowed to be downloaded by the user.

Usage

Access or destructure getDatabaseFile from the SQLocal client.

import { SQLocal } from 'sqlocal';

const { getDatabaseFile } = new SQLocal('database.sqlite3');

NOTE

If you are using the Kysely Query Builder or Drizzle ORM for type-safe queries, you will initialize the client with a child class of SQLocal. See the corresponding setup page. Usage is the same otherwise.

The getDatabaseFile method takes no arguments. It will return a Promise for a File object. That object can then be used to upload or download the database file of the SQLocal instance.

For example, you can upload the database file to your server.

const databaseFile = await getDatabaseFile();
const formData = new FormData();
formData.set('databaseFile', databaseFile);

await fetch('https://example.com/upload', {
	method: 'POST',
	body: formData,
});

Or, you can use it to make the database file available to the user for download.

const databaseFile = await getDatabaseFile();
const fileUrl = URL.createObjectURL(databaseFile);

const a = document.createElement('a');
a.href = fileUrl;
a.download = 'database.sqlite3';
a.click();
a.remove();

URL.revokeObjectURL(fileUrl);