Floor Generator (Community) #

The typesafe, reactive and lightweight SQLite abstraction for your Flutter applications (iOS, Android, Linux, macOS, Windows)

This is the dev dependency and contains the annotation processor. Use this package as the dev dependency paired with floor_community. See the Floor Community repository for migration guidance and documentation.

Usage #

dependencies:
  floor_community: ^1.1.0

dev_dependencies:
  floor_generator_community: ^1.1.0
  build_runner: ">=2.15.0 <3.0.0"

Generate Floor-compatible .g.dart files with:

dart run build_runner build --delete-conflicting-outputs

The generator intentionally preserves Floor annotations and the generated $Floor<DatabaseName> database entry-point convention.

The generator itself uses compatibility ranges for Analyzer and Build rather than exact latest pins. This is intentional: Flutter SDK packages may pin transitive packages used by Analyzer, and Pub should be free to choose the newest compatible toolchain for the installed Flutter SDK.

The library's name derives from the following. Floor as the bottom layer of a Room which points to the analogy of the database layer being the bottom and foundation layer of most applications. Where fl also gives a pointer that the library is used in the Flutter context.

Bugs and Feedback #

For bugs, questions and discussions please use Github Issues.

License #

Copyright 2022 The Floor Project Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.