kvsql 0.1.0

Kvsql #

A key/value store for Flutter backed by Sqlite. Powered by Sqlcool.

Usage #

Initialize #

   import 'package:kvsql/kvsql.dart';

   store = KvStore();
   await store.onReady;

Initialize with an existing Sqlcool database:

   db.init(path: "mydb.db", schema=[kvSchema()]);
   store = KvStore(db: db);

Insert #

   await store.insert("mykey", "myvalue");

Supported value types are: String, int, double, List, Map

Update #

   await store.update("mykey", "my_new_value");

Delete #

   await store.delete("mykey");

Select #

Returns a typed value

   final dynamic myValue = await store.select("mykey");

Upsert #

Inserts a value if it does not exists or update it otherwise

    await store.upsert("mykey", "my_new_value");

Push #

This method upserts a key/value using a queue: it can be safely called concurrently. Useful for high throughput updates.

Limitation: this method is executed asynchronously but can not be awaited.

    store.push("mykey", "my_value");

Check the examples for detailled usage.

Select sync #

Synchronously select a value.

   final dynamic myValue = store.selectSync("mykey");

For this to work you need to initialize the store with the inMemory option that keeps an in memory copy of the store values.

   store = KvStore(inMemory = true);

Note: if you don't await your mutations or use push you are exposed to eventual consistency using this method

Typed values select sync are available:

   final double myValue = store.selectDoubleSync("mykey");
   final int myValue = store.selectIntegerSync("mykey");
   final String myValue = store.selectStringSync("mykey");
   final List myValue = store.selectListSync("mykey");
   final Map myValue = store.selectMapSync("mykey");

Changelog #

0.1.0 #

Initial

example/README.md

example #

A new Flutter project.

Getting Started #

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  kvsql: ^0.1.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:kvsql/kvsql.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
41
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
70
Learn more about scoring.

We analyzed this package on Aug 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.4.0
  • pana: 0.12.19
  • Flutter: 1.7.8+hotfix.4

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
cupertino_icons ^0.1.2 0.1.2
flutter 0.0.0
path_provider ^1.1.0 1.2.0
pedantic ^1.6.0 1.8.0+1
sqlcool ^3.1.0 3.2.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.6 1.1.7
path 1.6.4
sky_engine 0.0.99
sqflite 1.1.6+3
synchronized 2.1.0+1
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test