sqflitecon 1.1.0

  • Readme
  • Changelog
  • Installing
  • 44

sqflitecon #

pub.dev

An interface for manage sqflite connections.

Usage #

Setting up #

  1. Make sure you are using flutter_dotenv right.
  2. Include the DATABASE_PATH variable to your .env file with the path of your sqflite database.

Getting connection #

To get a connection instance you can use:

import 'package:sqflitecon/db.dart';

final connection = await DB.getConnetion();

Or just:

import 'package:sqflitecon/db.dart';

final connection = await databaseConnection();

In either case you can enter the same named parameters - like version, onConfigure - provided by sqflite (see here). An example below.

import 'package:sqflitecon/db.dart';

final connection = await databaseConnection(
    version: 1,
    onConfigure: onConfigure);

Changelog #

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased] #

[1.1.0] - 2020-01-01 #

Added: #

  • Handling of unspecified database path.

[1.0.0] - 2019-12-30 #

First version with initial source code.

Use this package as a library

1. Depend on it

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


dependencies:
  sqflitecon: ^1.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:sqflitecon/db.dart';
import 'package:sqflitecon/exceptions/unspecified_database_path.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
74
Overall:
Weighted score of the above. [more]
44
Learn more about scoring.

We analyzed this package on Apr 7, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.6
  • Flutter: 1.12.13+hotfix.8

Health issues and suggestions

Document public APIs. (-1 points)

9 out of 9 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.

Maintenance suggestions

The package description is too short. (-16 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and sqflitecon.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.6.0 <3.0.0
flutter 0.0.0
flutter_dotenv ^2.1.0 2.1.0
sqflite ^1.2.0 1.3.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
path 1.6.4
sky_engine 0.0.99
sqflite_common 1.0.0+1
synchronized 2.2.0
typed_data 1.1.6
vector_math 2.0.8