mateusabelli/refine-sqlite

Connector for backends created with SQLite.

refine-sqlite

Connector for backends created with SQLite.

Getting Started

With refine-sqlite you can quickly start creating your app as fast as possible by leveraging the easy-to-use methods powered by refine to interact with your SQLite database.

Features

• Well tested - All the methods are tested using Jest.
• Fully featured - All CRUD operations are supported.
• Synchronous - Everything works synchronously using better-sqlite3.
• Type safe - Written in TypeScript with strict mode enabled.

Installation

npm install refine-sqlite

Usage

1. Create a database file. You can use the DB Browser for SQLite to easily create the tables and insert some data, or you can also use the sqlite3 command line shell.
   
2. Import the dataProvider function in your file and pass the database file path as a string parameter.
   
3. Use the methods to create, update, delete, and get data from your database, filtering and sorting as you wish.

Note resource is the name of the table in the database.

import { dataProvider } from "refine-sqlite";

const response = dataProvider("database.db")
  .getList({
    resource: "posts",
    filters: [
      {
        field: "category_id",
        operator: "eq",
        value: ["2"],
      },
    ],
    sorters: [
      {
        field: "title",
        order: "asc",
      },
    ],
  });

console.log(response)

// {
//   data: [
//     { id: 6, title: 'Dolorem unde et officiis.', category_id: 2 },
//     { id: 1, title: 'Soluta et est est.', category_id: 2 }
//   ],
//   total: 2
// }

Documentation

• Methods
• Filters
• Sorters

Development

Clone the repository

git clone https://github.com/mateusabelli/refine-sqlite.git

Install the dependencies

cd refine-sqlite
pnpm install

Build and test

pnpm run build
pnpm run test

Important Before the tests run, the database file test.db is deleted and recreated.

Contributing

All contributions are welcome and appreciated! Please create an Issue or Pull Request if you encounter any problems or have suggestions for improvements.

If you want to say thank you or/and support active development of refine-sqlite

• Add a GitHub Star to the project.
• Tweet about the project on Twitter / X.
• Write interesting articles about the project on Dev.to, Medium or personal blog.
• Consider becoming a sponsor on GitHub.

Special Thanks

refine

I'd like to thank refine, my first GitHub sponsor ❤️
For believing and supporting my projects!

License

refine-sqlite is free and open-source software licensed under the MIT License.
The feather icon is from Phosphor Icons licensed under the MIT License.

refine-sqlite's Issues

promisify is not a function

Uncaught TypeError: promisify is not a function
at node_modules/better-sqlite3/lib/methods/backup.js (refine-sqlite.js?v=e0b491c1:423:20)
at __require2 (chunk-AUZ3RYOM.js?v=47f26262:18:50)
at node_modules/better-sqlite3/lib/database.js (refine-sqlite.js?v=e0b491c1:842:33)
at __require2 (chunk-AUZ3RYOM.js?v=47f26262:18:50)
at node_modules/better-sqlite3/lib/index.js (refine-sqlite.js?v=e0b491c1:861:22)
at __require2 (chunk-AUZ3RYOM.js?v=47f26262:18:50)
at refine-sqlite.js?v=e0b491c1:867:37
When adding it as an dataprovider

Update README to reflect changes with `better-sqlite3`

Error when using the package

When I updated my data provider according to the README on a newly created refine app using Vite I received the following error

X [ERROR] Could not resolve "mock-aws-s3"

    node_modules/@mapbox/node-pre-gyp/lib/util/s3_setup.js:43:28:
      43 │     const AWSMock = require('mock-aws-s3');
         ╵                             ~~~~~~~~~~~~~

  You can mark the path "mock-aws-s3" as external to exclude it from the bundle, which will remove this error. You can also surround this "require" call with a try/catch block to handle this failure at 
run-time instead of bundle-time.

X [ERROR] Could not resolve "aws-sdk"

    node_modules/@mapbox/node-pre-gyp/lib/util/s3_setup.js:76:22:
      76 │   const AWS = require('aws-sdk');
         ╵                       ~~~~~~~~~

  You can mark the path "aws-sdk" as external to exclude it from the bundle, which will remove this error. You can also surround this "require" call with a try/catch block to handle this failure at run-
time instead of bundle-time.

X [ERROR] Could not resolve "nock"

    node_modules/@mapbox/node-pre-gyp/lib/util/s3_setup.js:112:23:
      112 │   const nock = require('nock');
          ╵                        ~~~~~~

  You can mark the path "nock" as external to exclude it from the bundle, which will remove this error. You can also surround this "require" call with a try/catch block to handle this failure at run-tim
e instead of bundle-time.

sqlite3 over better-sqlite3

Hello Mateus.

I think it's great that there is finally a way to connect refine and sqlite. Thank you very much for that. But i´ve got a question.
Why have you choosen sqlite3 instead of better-sqlite3?

What was your motivation for this?

Thx a lot
Thomas

Add examples

Include a folder with an example refine project using the refine-sqlite as a data provider