dart_database 0.0.3

  • Readme
  • Changelog
  • Installing
  • 42

Dart database #

Embeded database built in on Dart.

This package is still under development and will heavily change. Use on your own risk

How to use? #

All operations are syncronous and reflects the status at disk

import 'package:dart_database/dart_database.dart';

class Item extends Entity {}

void main() {
  bootstrap(
    dbFolder: Platform.script.resolve('./db').toFilePath(),
  );
  Collection<Item> items = new Collection<Item>(
    builder: () => new Item(),
  );
  Item item = new Item();

  item['id'] = 1;
  item['title'] = 'New item';
  items.add(item);
}

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

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [0.0.3] - 2019-03-04
### Fixed
- Handling String data

## [0.0.1] - 2019-03-03
### Added
- Initial commit
- Store and retreave data from file. Typed.

Use this package as a library

1. Depend on it

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


dependencies:
  dart_database: ^0.0.3

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or 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:dart_database/dart_database.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
0
Health:
Code health derived from static analysis. [more]
94
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
70
Overall:
Weighted score of the above. [more]
42
Learn more about scoring.

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

  • Dart: 2.5.1
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, other

Primary library: package:dart_database/dart_database.dart with components: io.

Health suggestions

Fix lib/storage/memory_storage.dart. (-1.99 points)

Analysis of lib/storage/memory_storage.dart reported 4 hints:

line 29 col 3: This function has a return type of 'Future

line 29 col 40: Don't explicitly initialize variables to null.

line 34 col 3: This function has a return type of 'int', but doesn't end with a return statement.

line 34 col 36: Don't explicitly initialize variables to null.

Fix lib/collection.dart. (-1 points)

Analysis of lib/collection.dart reported 2 hints:

line 15 col 17: The value of the field '_indexFile' isn't used.

line 16 col 22: The value of the field '_indexFields' isn't used.

Fix lib/storage/file_storage.dart. (-1 points)

Analysis of lib/storage/file_storage.dart reported 2 hints:

line 118 col 40: Don't explicitly initialize variables to null.

line 133 col 36: Don't explicitly initialize variables to null.

Fix additional 12 files with analysis or formatting issues. (-2 points)

Additional issues in the following files:

  • lib/storage/storage.dart (2 hints)
  • lib/entity.dart (1 hint)
  • lib/poc.dart (1 hint)
  • lib/block.dart (Run dartfmt to format lib/block.dart.)
  • lib/block_reader.dart (Run dartfmt to format lib/block_reader.dart.)
  • lib/enum/block_size.dart (Run dartfmt to format lib/enum/block_size.dart.)
  • lib/enum/block_type.dart (Run dartfmt to format lib/enum/block_type.dart.)
  • lib/field.dart (Run dartfmt to format lib/field.dart.)
  • lib/identifier.dart (Run dartfmt to format lib/identifier.dart.)
  • lib/indexes.dart (Run dartfmt to format lib/indexes.dart.)
  • lib/settings.dart (Run dartfmt to format lib/settings.dart.)
  • lib/utils.dart (Run dartfmt to format lib/utils.dart.)

Maintenance suggestions

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.

Maintain an example.

None of the files in the package's example/ directory matches known example patterns.

Common filename patterns include main.dart, example.dart, and dart_database.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.1.0 <3.0.0
meta ^1.1.7 1.1.7
test ^1.5.3 1.9.2
Transitive dependencies
analyzer 0.38.5
args 1.5.2
async 2.4.0
boolean_selector 1.0.5
charcode 1.1.2
collection 1.14.12
convert 2.1.1
coverage 0.13.3
crypto 2.1.3
csslib 0.16.1
front_end 0.1.27
glob 1.2.0
html 0.14.0+3
http 0.12.0+2
http_multi_server 2.1.0
http_parser 3.1.3
io 0.3.3
js 0.6.1+1
kernel 0.3.27
logging 0.11.3+2
matcher 0.12.5
mime 0.9.6+3
multi_server_socket 1.0.2
node_interop 1.0.3
node_io 1.0.1+2
node_preamble 1.4.8
package_config 1.1.0
package_resolver 1.0.10
path 1.6.4
pedantic 1.8.0+1
pool 1.4.0
pub_semver 1.4.2
shelf 0.7.5
shelf_packages_handler 1.0.4
shelf_static 0.2.8
shelf_web_socket 0.2.3
source_map_stack_trace 1.1.5
source_maps 0.10.8
source_span 1.5.5
stack_trace 1.9.3
stream_channel 2.0.0
string_scanner 1.0.5
term_glyph 1.1.0
test_api 0.2.9
test_core 0.2.13
typed_data 1.1.6
vm_service 1.2.0 2.1.1
watcher 0.9.7+12
web_socket_channel 1.1.0
yaml 2.2.0