kv_store 1.0.1

  • Readme
  • Changelog
  • Example
  • Installing
  • 61

kv_store for Flutter #

kv_store is a key-value storeage plug-in used sqlite. It can be used for keeping user data like token/response/caches/preferences.

Getting Started #

    dependencies:
        kv_store: ^1.0.1

Base Object #

{
    "json": {
        "data": "qqnxI"
    },
    "updatedAt": "2019-02-20 08:50:49"
}

Basic Usage #

# 0.Get KvStore Instance
KvStore()

# Save/Update Key-Value pair in default collection(table in sqlite)
KvStore().putObject('city', {'data': randomAlpha(5)})

# Get object(row in sqlite) by Key
KvStore().getObjectByKey('name')

# Get object count
KvStore().getCountFromTable()

# Get all objects
KvStore().getAllItems()

# Delete object by key
KvStore().deleteObjectByKey('name')

# Delete multiple objects by keys
KvStore().deleteObjectsByKeys(['name', 'city'])

# Delete multiple objects by prefix
KvStore().deleteObjectsByKeyPrefix('c')

# Delete all objects
KvStore().clearTable()

Advanced Usage #

# Create new database
KvStore().createTable('t_example')

# Get databases
KvStore().allTables()

# Actions in specified database
KvStore().putObject(randomAlpha(5), {'data': randomAlpha(5)}, 't_example')

# Delete database
KvStore().dropTable('t_example')

Thanks #

YTKKeyValueStore sqflite

License #

MIT

1.0.1 #

  • Add instructions and example in README.md
  • Update sqflite: ^1.1.0

1.0.0 #

  • Formated logs output
  • Examples
  • Basic functions

example/README.md

kv_store_example #

Demonstrates how to use the kv_store plugin.

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:
  kv_store: ^1.0.1

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:kv_store/kv_store.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
23
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
61
Learn more about scoring.

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

  • Dart: 2.6.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.6

Health issues and suggestions

Document public APIs. (-1 points)

35 out of 35 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.68.0 <3.0.0
flutter 0.0.0
path ^1.6.2 1.6.4
sprintf ^4.0.0 4.0.2
sqflite ^1.1.0 1.1.8
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.7 1.1.8
sky_engine 0.0.99
synchronized 2.1.1
typed_data 1.1.6
vector_math 2.0.8