basic_sqflite_entity_framework 0.0.1

  • Readme
  • Changelog
  • Example
  • Installing
  • new40

basic_sqflite_entity_framework #

A new Flutter package project.

Getting Started #

This project is a starting point for a Dart package, a library module containing code that can be shared easily across multiple Flutter or Dart projects.

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

[0.0.1] - TODO: Add release date. #

  • TODO: Describe initial release.

example/main.dart

import 'package:flutter/material.dart';
import 'package:basic_sqflite_entity_framework/DbUtils.dart';
import 'package:basic_sqflite_entity_framework/TableColumn.dart';
import 'package:basic_sqflite_entity_framework/TableColumnTypes.dart';
import 'package:basic_sqflite_entity_framework/TableSchema.dart';
import 'package:basic_sqflite_entity_framework/TableModel.dart';


void main() => runApp(MyApp());

class MyApp extends StatelessWidget {

  @override
  Widget build(BuildContext context) {

    Db.users.insert(User(name: 'Ehsan')).then((int resultId) {

      print('insert main ' + resultId.toString());
      
      Db.users.all().then((dynamic result) {
        print('all ' + result.toString());
      });
      
    });

    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Hello'),),
        body: Container(
          child: Text('Hello'),
        ),
      ),
    );
  }
  
}

class User extends TableModel {

  int id;
  String name;

  User({this.id, this.name});

  @override
  Map<String, dynamic> toMap() => {
    'id': this.id,
    'name': this.name,
  };

  @override
  String toString() {
    return 'User{id: $id, name: $name}';
  }

}


class Db {

  static DbUtils users = DbUtils(TableSchema(
    databaseName: 'Karbara',
    tableName: 'Users',

    columns: <TableColumn>[
      TableColumn( name: 'id', type: TableColumnTypes.PRIMARY_KEY_INT ),
      TableColumn( name: 'name', type: TableColumnTypes.TEXT ),
    ],

    fromMap: (Map<String, dynamic> map) => User(
      id: map['id'],
      name: map['name'],
    ),

  ));

}

Use this package as a library

1. Depend on it

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


dependencies:
  basic_sqflite_entity_framework: ^0.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:basic_sqflite_entity_framework/DbUtils.dart';
import 'package:basic_sqflite_entity_framework/ForeignKeyField.dart';
import 'package:basic_sqflite_entity_framework/ForeignKeyTypes.dart';
import 'package:basic_sqflite_entity_framework/TableColumn.dart';
import 'package:basic_sqflite_entity_framework/TableColumnTypes.dart';
import 'package:basic_sqflite_entity_framework/TableModel.dart';
import 'package:basic_sqflite_entity_framework/TableSchema.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]
50
Overall:
Weighted score of the above. [more]
40
Learn more about scoring.

We analyzed this package on Mar 31, 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)

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

Format lib/DbUtils.dart.

Run flutter format to format lib/DbUtils.dart.

Format lib/ForeignKeyField.dart.

Run flutter format to format lib/ForeignKeyField.dart.

Format lib/ForeignKeyTypes.dart.

Run flutter format to format lib/ForeignKeyTypes.dart.

Fix additional 4 files with analysis or formatting issues.

Additional issues in the following files:

  • lib/TableColumn.dart (Run flutter format to format lib/TableColumn.dart.)
  • lib/TableColumnTypes.dart (Run flutter format to format lib/TableColumnTypes.dart.)
  • lib/TableModel.dart (Run flutter format to format lib/TableModel.dart.)
  • lib/TableSchema.dart (Run flutter format to format lib/TableSchema.dart.)

Maintenance issues and suggestions

Use constrained dependencies. (-20 points)

The pubspec.yaml contains 2 dependencies without version constraints. Specify version ranges for the following dependencies: path, sqflite.

The package description is too short. (-20 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.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
path any 1.6.4
sqflite any 1.3.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
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
Dev dependencies
flutter_test