localstore 1.3.1 icon indicating copy to clipboard operation
localstore: ^1.3.1 copied to clipboard

A JSON file-based storage package provides a persistent repository for simple NoSQL database.

Localstore #

pub package

Between SQL or NoSQL, there's no one best database, there's the right database for your specific project. Localstore is a JSON file-based storage package (localstorage) provides a persistent repository for simple NoSQL database.

Localstore (NoSQL)SQLite (SQL)
Data formatFile path (collection)Table
Data itemJSON Document (doc)Record / Row
ScalabilityHorizontalLimited vertical
OrganizationSchema-lessFixed schema

Demo Screenshot #

UML diagram #

Localstore UML diagram

Getting Started #

  1. Calling WidgetsFlutterBinding.ensureInitialized(); in main() before calling runApp():
void main() {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(MyApp());
}
  1. Import import 'package:localstore/localstore.dart';
import 'package:flutter/material.dart';
import 'package:localstore/localstore.dart';

void main() {
  WidgetsFlutterBinding.ensureInitialized();
  runApp(MyApp());
}
  1. Creates an instance using the default Localstore
final db = Localstore.instance;

or using anywhere in your project.

  1. Creates new item
// gets new id
final id = db.collection('todos').doc().id;

// save the item
db.collection('todos').doc(id).set({
  'title': 'Todo title',
  'done': false
});
  1. Gets item by id
final data = await db.collection('todos').doc(id).get();
  1. Delete item by id
db.collection('todos').doc(id).delete();
  1. Fetch the documents for the collection
final items = await db.collection('todos').get();
  1. Using stream
final stream = db.collection('todos').stream;

Features and bugs #

Please file feature requests and bugs at the issue tracker.

117
likes
140
pub points
93%
popularity

Publisher

verified publisher iconhumg.edu.vn

A JSON file-based storage package provides a persistent repository for simple NoSQL database.

Repository (GitHub)

Documentation

API reference

License

Icon for licenses.MIT (LICENSE)

Dependencies

flutter, path, path_provider

More

Packages that depend on localstore