nanoSQL supports running anywhere from zero to any number of independent databases at once. Each database has it's own collection of tables with data models, indexes and an adapter to save the data to.

Databases and tables can be created and deleted on the fly, tables can additionally be updated with new properties, indexes, data models, or even name after being created.

If no databases are created nanoSQL won't be able to persist data and can only be used with temporary tables like this:

// temporary array table
    {name: "bill", age: 20},
    {name: "tom", age: 30}
]).query("select").where(["age", "=", 20]).exec().then..

// temporary table from promise
nSQL(() => fetch("data.json").then(d => d.json())).query("select").where(["age", "=", 20]).exec().then..

After a database is created you can still use temporary tables for queries, they won't affect your persistent data in any way.

Creating a Database

NanoSQL requires very little boilerplate code to start using. Simply call the createDatabase method and pass in an object describing your tables and other properties, then it's ready to use!

// typical setup
    id: "my_db", // can be anything that's a string
    mode: "PERM", // save changes to IndexedDB, WebSQL or SnapDB!
    tables: [ // tables can be created as part of createDatabase or created later with create table queries
            name: "users",
            model: {
                "id:uuid": {pk: true},
                "name:string": {},
                "age:int": {}
    version: 3, // current schema/database version
    onVersionUpdate: (prevVersion) => { // migrate versions
         return new Promise((res, rej) => {
             switch(prevVersion) {
                 case 1:
                     // migrate v1 to v2
                 case 2:
                     // migrate v2 to v3


}).then(() => {
    // ready to query!
}).catch(() => {
    // ran into a problem

The createDatabase method accepts one object as its argument and returns a promise. When the promise resolves the database is ready to use.

The object used in the createDatabase function is described by the InanoSQLConfig interface.

The properties of that interface are described in the table below.

GeneratePut tabs between columnsCompact mode Result (click "Generate" to refresh) Copy to clipboard

Property Type Required Details
id string yes The database name/id. Must remain the same to persist data between page/app reloads.
mode string | InanoSQLAdapter no Either a string describing a built in adapter or an adapter class to use an external adapter. Fully described here.
plugins InanoSQLPlugin[] no An array of plugins to initiate with the database.
warnOnSlowQuery bool no If this is true, nanoSQL will emit a console.warn when a query requires a full table scan to complete.
planetRadius number no When using the CROW function this is used to scale the results to different units. Default is 6,371 to return results in KM. Set to 3,958.8 to get results in miles.
path string no Some modes/adapters will save the database to a folder (like LevelDB, RocksDB, and SQLite). Set this to the folder you'd like the adapter to save the database into. Not supported by all adapters.
tables InanoSQLTableConfig[] no Can be used to include the table data models in database setup. This is the same as calling createTable a bunch of times after setting up the database. You can read about how to set up tables here.
version number no The current schema/database version.
onVersionUpdate (oldVersion: number) => Promise<number> no The database version is persisted to a utility table on each app load. If an older version is found this function is called until it returns the current version. You can use this function to perform migration actions between versions.

Keep in mind that nanoSQL has no way of saving database config data between reloads of your app (only table data), so the createDatabase method should be called on the first and every subsequent app load you intend to use the database in. If the database and tables already exist the createDatabase method just attaches nanoSQL to the existing data, otherwise the tables and indexes are created as needed.

Selecting A Database Or Table

You can switch between different databases on the fly with the useDatabase function.

// you can now create tables, select data, or otherwise use database "my_db"
// "my_db" database will be used for all queries until another database is selected.

// you can now create tables, select data, or otherwise use database "2"
// subsequent queries will happen on database "2"

// you can also chain useDatabase with queries.
// select from "users" table on database "2"

Selecting different tables works much the same way, except you pass your table into the nSQL variable.

// select "users" table

// "users" table will be used for all queries until another table is selected.

// these will all query "users" table
nSQL().query("upsert", {}).exec().then...

// there's no harm in selecting the table every time if you'd prefer...
nSQL("users").query("upsert", {}).exec().then...

Once you select a database or table that database/table combination will remain selected until you select a different table and/or database.

When you create a database or table that database/table is automatically selected for subsequent queries.

Listing Databases

To see the databases in nanoSQL you can call the listDatabases method.

const dbList = nSQL().listDatabases();
console.log(dbList) // ["db1", "db2", ...]

Dropping A Database

To drop a database, simply call dropDatabase with the database id and that database's tables and other related data will be removed.

nSQL().dropDatabase("my_db").then(() => {
    // database dropped!
}).catch(() => {
    // had a problem

This will destroy the database, it's tables, rows and indexes.

Disconnecting From A Database

In some cases you may want to disconnect from a database, to do that you can call disconnect().

If a database ID is passed into disconnect nanoSQL will disconnect from only that database, if no ID is passed nanoSQL will disconnect from all current databases.

// disconnect from all databases

// disconnect from "1" database

Disconnecting from the database will not cause any data loss on the underlying tables/indexes. This is mostly useful if you need to remove a file lock from the database files (like with SQLite or RocksDB) or free the database connection (like with Redis or MySQL).

Next Steps

You can dive deeper into how to make tables/data models in nanoSQL. You can create tables in your database using the create table query.

You can also learn the ins and outs of select query to unlock the power of nanoSQL.

Last Updated: 8/26/2019, 7:54:08 AM