firebase_database 1.0.1

  • README.md
  • CHANGELOG.md
  • Example
  • Installing
  • Versions
  • 100

Firebase Realtime Database for Flutter

pub package

A Flutter plugin to use the Firebase Realtime Database API.

For Flutter plugins for other Firebase products, see FlutterFire.md.

Note: This plugin is still under development, and some APIs might not be available yet. Feedback and Pull Requests are most welcome!

Usage

To use this plugin, add firebase_database as a dependency in your pubspec.yaml file.

Getting Started

See the example directory for a complete sample app using Firebase Realtime Database.

1.0.1

  • Updated Gradle tooling to match Android Studio 3.1.2.

1.0.0

  • Bump to released version

0.4.6

  • Allow null value for startAt, endAt and equalTo queries on Android.

0.4.5

  • Updated Google Play Services dependencies to version 15.0.0.

0.4.4

  • Updated firebase_core dependency to ^0.2.2

0.4.3

  • Simplified podspec for Cocoapods 1.5.0, avoiding link issues in app archives.

0.4.2

  • Updated firebase_core dependency.
  • Removed meta dependency.

0.4.1

  • Fixes Dart 2 runtime cast error.

0.4.0

  • Breaking change. Set SDK constraints to match the Flutter beta release.

0.3.6

  • Fixed Dart 2 type errors.

0.3.5

  • Enabled use in Swift projects.

0.3.4

  • Allow null values for Query startAt, endAt, and equalTo

0.3.3

  • Support to specify a database by URL if required

0.3.2

  • Fix warnings from the Dart 2.0 analyzer.
  • Simplified and upgraded Android project template to Android SDK 27.
  • Updated package description.

0.3.1

  • Fix function name collision when using Firebase Database and Cloud Firestore together on iOS.

0.3.0

  • Breaking change. Upgraded to Gradle 4.1 and Android Studio Gradle plugin 3.0.1. Older Flutter projects need to upgrade their Gradle setup as well in order to use this version of the plugin. Instructions can be found here.

0.2.0

  • Support for multiple databases, new dependency on firebase_core
  • Relax GMS dependency to 11.+

0.1.4

  • Add FLT prefix to iOS types
  • Avoid error when clearing FirebaseSortedList

0.1.3

  • Fix memory leak in FirebaseAnimatedList
  • Change GMS dependency to 11.4.+

0.1.2

  • Change GMS dependency to 11.+

0.1.1

  • Add RTDB transaction support.

0.1.0+1

  • Aligned author name with rest of repo.

0.1.0

  • Breaking Change: Added current list index to the type signature of itemBuilder for FirebaseAnimatedList.

0.0.14

  • Fix FirebaseSortedList to show data changes.

0.0.13

  • Fixed lingering value/child listeners.

0.0.12

  • Updated to Firebase SDK to always use latest patch version for 11.0.x builds

0.0.11

  • Fixes startAt/endAt on iOS when used without a key

0.0.10

  • Added workaround for inconsistent numeric types when using keepSynced on iOS
  • Bug fixes to Query handling

0.0.9

  • Updated to Firebase SDK Version 11.0.1

0.0.8

  • Added missing offline persistence and query functionality on Android
  • Fixed startAt query behavior on iOS
  • Persistence methods no longer throw errors on failure, return false instead
  • Updates to docs and tests

0.0.7

  • Fixed offline persistence on iOS

0.0.6

  • Various APIs added to FirebaseDatabase and Query
  • Added removal and priority to DatabaseReference
  • Improved documentation
  • Added unit tests

0.0.5

  • Fixed analyzer warnings

0.0.4

  • Removed stub code and replaced it with support for more event types, paths, auth
  • Improved example

0.0.3

  • Updated README.md
  • Bumped buildToolsVersion to 25.0.3
  • Added example app

0.0.2

  • Fix compilation error

0.0.1

  • Initial Release

example/lib/main.dart

// Copyright 2017, the Flutter project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'dart:async';
import 'dart:io' show Platform;

import 'package:flutter/material.dart';
import 'package:firebase_core/firebase_core.dart';
import 'package:firebase_database/firebase_database.dart';
import 'package:firebase_database/ui/firebase_animated_list.dart';

Future<void> main() async {
  final FirebaseApp app = await FirebaseApp.configure(
    name: 'db2',
    options: Platform.isIOS
        ? const FirebaseOptions(
            googleAppID: '1:297855924061:ios:c6de2b69b03a5be8',
            gcmSenderID: '297855924061',
            databaseURL: 'https://flutterfire-cd2f7.firebaseio.com',
          )
        : const FirebaseOptions(
            googleAppID: '1:297855924061:android:669871c998cc21bd',
            apiKey: 'AIzaSyD_shO5mfO9lhy2TVWhfo1VUmARKlG4suk',
            databaseURL: 'https://flutterfire-cd2f7.firebaseio.com',
          ),
  );
  runApp(new MaterialApp(
    title: 'Flutter Database Example',
    home: new MyHomePage(app: app),
  ));
}

class MyHomePage extends StatefulWidget {
  MyHomePage({this.app});
  final FirebaseApp app;

  @override
  _MyHomePageState createState() => new _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter;
  DatabaseReference _counterRef;
  DatabaseReference _messagesRef;
  StreamSubscription<Event> _counterSubscription;
  StreamSubscription<Event> _messagesSubscription;
  bool _anchorToBottom = false;

  String _kTestKey = 'Hello';
  String _kTestValue = 'world!';
  DatabaseError _error;

  @override
  void initState() {
    super.initState();
    // Demonstrates configuring to the database using a file
    _counterRef = FirebaseDatabase.instance.reference().child('counter');
    // Demonstrates configuring the database directly
    final FirebaseDatabase database = new FirebaseDatabase(app: widget.app);
    _messagesRef = database.reference().child('messages');
    database.reference().child('counter').once().then((DataSnapshot snapshot) {
      print('Connected to second database and read ${snapshot.value}');
    });
    database.setPersistenceEnabled(true);
    database.setPersistenceCacheSizeBytes(10000000);
    _counterRef.keepSynced(true);
    _counterSubscription = _counterRef.onValue.listen((Event event) {
      setState(() {
        _error = null;
        _counter = event.snapshot.value ?? 0;
      });
    }, onError: (Object o) {
      final DatabaseError error = o;
      setState(() {
        _error = error;
      });
    });
    _messagesSubscription =
        _messagesRef.limitToLast(10).onChildAdded.listen((Event event) {
      print('Child added: ${event.snapshot.value}');
    }, onError: (Object o) {
      final DatabaseError error = o;
      print('Error: ${error.code} ${error.message}');
    });
  }

  @override
  void dispose() {
    super.dispose();
    _messagesSubscription.cancel();
    _counterSubscription.cancel();
  }

  Future<Null> _increment() async {
    // Increment counter in transaction.
    final TransactionResult transactionResult =
        await _counterRef.runTransaction((MutableData mutableData) async {
      mutableData.value = (mutableData.value ?? 0) + 1;
      return mutableData;
    });

    if (transactionResult.committed) {
      _messagesRef.push().set(<String, String>{
        _kTestKey: '$_kTestValue ${transactionResult.dataSnapshot.value}'
      });
    } else {
      print('Transaction not committed.');
      if (transactionResult.error != null) {
        print(transactionResult.error.message);
      }
    }
  }

  @override
  Widget build(BuildContext context) {
    return new Scaffold(
      appBar: new AppBar(
        title: const Text('Flutter Database Example'),
      ),
      body: new Column(
        children: <Widget>[
          new Flexible(
            child: new Center(
              child: _error == null
                  ? new Text(
                      'Button tapped $_counter time${ _counter == 1 ? '' : 's' }.\n\n'
                          'This includes all devices, ever.',
                    )
                  : new Text(
                      'Error retrieving button tap count:\n${_error.message}',
                    ),
            ),
          ),
          new ListTile(
            leading: new Checkbox(
              onChanged: (bool value) {
                setState(() {
                  _anchorToBottom = value;
                });
              },
              value: _anchorToBottom,
            ),
            title: const Text('Anchor to bottom'),
          ),
          new Flexible(
            child: new FirebaseAnimatedList(
              key: new ValueKey<bool>(_anchorToBottom),
              query: _messagesRef,
              reverse: _anchorToBottom,
              sort: _anchorToBottom
                  ? (DataSnapshot a, DataSnapshot b) => b.key.compareTo(a.key)
                  : null,
              itemBuilder: (BuildContext context, DataSnapshot snapshot,
                  Animation<double> animation, int index) {
                return new SizeTransition(
                  sizeFactor: animation,
                  child: new Text("$index: ${snapshot.value.toString()}"),
                );
              },
            ),
          ),
        ],
      ),
      floatingActionButton: new FloatingActionButton(
        onPressed: _increment,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

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


dependencies:
  firebase_database: "^1.0.1"

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


      import 'package:firebase_database/firebase_database.dart';
  
Version Uploaded Documentation Archive
1.0.1 Jun 1, 2018 Go to the documentation of firebase_database 1.0.1 Download firebase_database 1.0.1 archive
1.0.0 May 21, 2018 Go to the documentation of firebase_database 1.0.0 Download firebase_database 1.0.0 archive
0.4.6 Apr 23, 2018 Go to the documentation of firebase_database 0.4.6 Download firebase_database 0.4.6 archive
0.4.5 Apr 18, 2018 Go to the documentation of firebase_database 0.4.5 Download firebase_database 0.4.5 archive
0.4.4 Apr 12, 2018 Go to the documentation of firebase_database 0.4.4 Download firebase_database 0.4.4 archive
0.4.3 Apr 11, 2018 Go to the documentation of firebase_database 0.4.3 Download firebase_database 0.4.3 archive
0.4.2 Apr 5, 2018 Go to the documentation of firebase_database 0.4.2 Download firebase_database 0.4.2 archive
0.4.1 Mar 20, 2018 Go to the documentation of firebase_database 0.4.1 Download firebase_database 0.4.1 archive
0.4.0 Mar 9, 2018 Go to the documentation of firebase_database 0.4.0 Download firebase_database 0.4.0 archive
0.3.6 Feb 28, 2018 Go to the documentation of firebase_database 0.3.6 Download firebase_database 0.3.6 archive

All 35 versions...

Analysis

We analyzed this package on Jun 12, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0-dev.60.0
  • pana: 0.11.3
  • Flutter: 0.5.2

Scores

Popularity:
Describes how popular the package is relative to other packages. [more]
99 / 100
Health:
Code health derived from static analysis. [more]
100 / 100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100 / 100
Overall score:
Weighted score of the above. [more]
100
Learn more about scoring.

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.28.0 <3.0.0
firebase_core ^0.2.2 0.2.4
flutter 0.0.0
Transitive dependencies
collection 1.14.6 1.14.10
meta 1.1.5
sky_engine 0.0.99
typed_data 1.1.5
vector_math 2.0.6 2.0.7
Dev dependencies
flutter_test
mockito ^2.0.2