square/sqlbrite — an open-source project — sits at 4.5k GitHub stars. A lightweight wrapper around SQLiteOpenHelper which introduces reactive stream semantics to SQL operations.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
A lightweight wrapper around SupportSQLiteOpenHelper and ContentResolver which introduces reactive
stream semantics to queries.
Deprecated
This library is no longer actively developed and is considered complete.
Its database features (and far, far more) are now offered by SQLDelight
and its upgrading guide offers some
migration help.
For content provider monitoring please use Copper instead.
Usage
Create a SqlBrite instance which is an adapter for the library functionality.
SqlBrite sqlBrite = new SqlBrite.Builder().build();
Pass a SupportSQLiteOpenHelper instance and a Scheduler to create a BriteDatabase.
BriteDatabase db = sqlBrite.wrapDatabaseHelper(openHelper, Schedulers.io());
A Scheduler is required for a few reasons, but the most important is that query notifications can
trigger on the thread of your choice. The query can then be run without blocking the main thread or
the thread which caused the trigger.
The BriteDatabase.createQuery method is similar to SupportSQLiteDatabase.query except it takes an
additional parameter of table(s) on which to listen for changes. Subscribe to the returned
Observable<Query> which will immediately notify with a Query to run.
Observable<Query> users = db.createQuery("users", "SELECT * FROM users");
users.subscribe(new Consumer<Query>() {
@Override public void accept(Query query) {
Cursor cursor = query.run();
// TODO parse data...
}
});
Unlike a traditional query, updates to the specified table(s) will trigger additional
notifications for as long as you remain subscribed to the observable. This means that when you
insert, update, or delete data, any subscribed queries will update with the new data instantly.
final AtomicInteger queries = new AtomicInteger();
users.subscribe(new Consumer<Query>() {
@Override public void accept(Query query) {
queries.getAndIncrement();
}
});
System.out.println("Queries: " + queries.get()); // Prints 1
db.insert("users", SQLiteDatabase.CONFLICT_ABORT, createUser("jw", "Jake Wharton"));
db.insert("users", SQLiteDatabase.CONFLICT_ABORT, createUser("mattp", "Matt Precious"));
db.insert("users", SQLiteDatabase.CONFLICT_ABORT, createUser("strong", "Alec Strong"));
System.out.println("Queries: " + queries.get()); // Prints 4
In the previous example we re-used the BriteDatabase object "db" for inserts. All insert, update,
or delete operations must go through this object in order to correctly notify subscribers.
Unsubscribe from the returned Subscription to stop getting updates.
final AtomicInteger queries = new AtomicInteger();
Subscription s = users.subscribe(new Consumer<Query>() {
@Override public void accept(Query query) {
queries.getAndIncrement();
}
});
System.out.println("Queries: " + queries.get()); // Prints 1
db.insert("users", SQLiteDatabase.CONFLICT_ABORT, createUser("jw", "Jake Wharton"));
db.insert("users", SQLiteDatabase.CONFLICT_ABORT, createUser("mattp", "Matt Precious"));
s.unsubscribe();
db.insert("users", SQLiteDatabase.CONFLICT_ABORT, createUser("strong", "Alec Strong"));
System.out.println("Queries: " + queries.get()); // Prints 3
Use transactions to prevent large changes to the data from spamming your subscribers.
The full power of RxJava's operators are available for combining, filtering, and triggering any
number of queries and data changes.
Philosophy
SQL Brite's only responsibility is to be a mechanism for coordinating and composing the notification
of updates to tables such that you can update queries as soon as data changes.
This library is not an ORM. It is not a type-safe query mechanism. It won't serialize the same POJOs
you use for Gson. It's not going to perform database migrations for you.
Some of these features are offered by SQL Delight which can be used with SQL Brite.
Snapshots of the development version are available in Sonatype's snapshots repository.
License
Copyright 2015 Square, Inc.
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.
square/sqlbrite has 4.5k GitHub stars — refresh the page for the live number, or check github.com/square/sqlbrite. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is square/sqlbrite open source?
Yes — square/sqlbrite ships under the Apache-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/square/sqlbrite.
What is square/sqlbrite?
square/sqlbrite (square/sqlbrite) is a Java project on GitHub. From the project's own README: A lightweight wrapper around SQLiteOpenHelper which introduces reactive stream semantics to SQL operations.
Where can I see square/sqlbrite in action?
The project maintains a homepage at https://square.github.io/sqlbrite/3.x/sqlbrite/. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about square/sqlbrite?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/square/sqlbrite is the definitive source.
Read full README in the tab above.
Curious whether sqlbrite is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about sqlbrite.