sqlite_js

SQLite JS is a powerful extension that brings JavaScript capabilities to SQLite. With this extension, you can create custom SQLite functions, aggregates, window functions, and collation sequences using JavaScript code, allowing for flexible and powerful data manipulation directly within your SQLite database.

Installation

dart pub add sqlite_js

Requires Dart 3.10+ / Flutter 3.38+.

Usage

With sqlite3

import 'package:sqlite3/sqlite3.dart';
import 'package:sqlite_js/sqlite_js.dart';

void main() {
  // Load once at startup.
  sqlite3.loadSqliteJsExtension();

  final db = sqlite3.openInMemory();

  // Execute JavaScript code.
  final result = db.select("SELECT js_eval('1 + 2') AS result");
  print(result.first['result']); // 3

  // Use JavaScript for more complex operations.
  db.execute('''
    SELECT js_eval('
      const data = JSON.parse(input);
      return data.map(x => x * 2);
    ', '[1, 2, 3]') AS doubled
  ''');

  db.dispose();
}

With drift

import 'package:sqlite3/sqlite3.dart';
import 'package:sqlite_js/sqlite_js.dart';
import 'package:drift/native.dart';

Sqlite3 loadExtensions() {
  sqlite3.loadSqliteJsExtension();
  return sqlite3;
}

// Use when creating the database:
NativeDatabase.createInBackground(
  File(path),
  sqlite3: loadExtensions,
);

Supported platforms

API

See the full sqlite-js API documentation.

License

See LICENSE.