@st.db/sql
v1.0.2
Published
SQL DB driver for @st.db
Downloads
14
Maintainers
Readme
About ST.db
ST.db is a powerful npm package that provides an easy-to-use key-value interface for managing various types of databases, both local and cloud-based. This package simplifies the process of reading, writing, and seamlessly switching between different database engines. Whether you're working with local databases or cloud-based solutions, st.db offers a straightforward and efficient way to interact with your data.
Installation
To install the @st.db/sql package and its associated database drivers, follow these steps:
- Install the main @st.db/sql package:
npm install st.db @st.db/sql
Usage
Using Node.js require()
const { SQLDriver } = require('@st.db/sql');
TypeScript/ES Module support
import { SQLDriver } from '@st.db/sql';
Deno support
import { SQLDriver } from 'npm:@st.db/sql';
Using SQLDriver
The SQLDriver
enables interaction with Firestore databases. Here's how to use it:
import { Database } from "st.db";
import { SQLDriver } from "@st.db/sql";
const tableName = "my_table"; // Optional: specify the table name
const options = {
driver: new SQLDriver("data.sqlite", tableName), // Specify the SQLDriver and the SQLite database file name
};
const db = new Database(options);
Links
Sponsors
Love what I do? Send me some coffee!? ☕
Can't send coffees? 😥 Nominate me for a st.db: Reviews | Openbase instead! Your support will help me to continue working on open-source projects like this. 🙏😇
Help
If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official Discord Server .
Did you find it difficult to use?
You can see the Documentation of the st.db package to know all the details