Skip to content
🍉 Reactive & asynchronous database for powerful React and React Native apps ⚡️
JavaScript Objective-C Swift C++ Kotlin Objective-C++ Other
Branch: master
Clone or download

Latest commit

kokusGr Merge pull request #701 from Nozbe/hardening
Hardening & Various improvements
Latest commit 66c95f8 Jun 1, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Delete nodejs.yml Dec 8, 2019
assets [ImgBot] Optimize images Nov 14, 2019
docs-master Add note for some future performance work May 26, 2020
docs update docs May 18, 2020
examples add example Mar 16, 2020
flow-typed fix Jul 5, 2019
native Merge pull request #701 from Nozbe/hardening Jun 1, 2020
scripts [android] tracing… diagnostics… wip Oct 23, 2019
src skip two failing tests May 26, 2020
.eslintignore Add `development` mode Aug 30, 2018
.eslintrc.yml [lokijs] select best available persistence adapter Oct 2, 2019
.flowconfig .flowconfig tweak for development May 18, 2020
.gitattributes Add test Pods Sep 8, 2018
.gitignore docs test Jul 18, 2019
.imgbotconfig config Jul 18, 2019
.prettierrc Merge branch 'master' into master Mar 14, 2019
.travis.yml comment out travis iOS (for now) May 26, 2020
CHANGELOG.md Merge pull request #701 from Nozbe/hardening Jun 1, 2020
CONTRIBUTING.md Update CONTRIBUTING.md Sep 18, 2018
LICENSE Update LICENSE Jul 26, 2019
README.md Update links to demo Apr 22, 2020
SECURITY.md Update SECURITY.md Jun 1, 2020
babel.config.js [babel] Enable loose classes - spits out cleaner & faster output Oct 17, 2019
greenkeeper.json Update greenkeeper.json Oct 19, 2018
jest.config.js Fix warnings, improve coverage Mar 20, 2019
package.json add dev:native script May 26, 2020
rn-cli.config.js [rn-cli.config] changes for rn 0.57 Sep 17, 2018
rn-transformer.js IT RUNS Sep 8, 2018
tsconfig.json bundle typescript declarations Mar 1, 2019
tslint.json bundle typescript declarations Mar 1, 2019
yarn.lock Merge branch 'master' into hardening May 26, 2020

README.md

WatermelonDB

A reactive database framework

Build powerful React and React Native apps that scale from hundreds to tens of thousands of records and remain fast ⚡️

MIT License CI Status npm

WatermelonDB
⚡️ Launch your app instantly no matter how much data you have
📈 Highly scalable from hundreds to tens of thousands of records
😎 Lazy loaded. Only load data when you need it
Reactive API with RxJS
📱 Multiplatform. iOS, Android, and the web
⚛️ Made for React. Easily plug data into components
Fast. Async. Multi-threaded. Highly cached.
🔗 Relational. Built on rock-solid SQLite foundation
⚠️ Static typing with Flow or TypeScript
🔄 Offline-first. Sync with your own backend

Why Watermelon?

WatermelonDB is a new way of dealing with user data in React Native and React web apps.

It's optimized for building complex applications in React Native, and the number one goal is real-world performance. In simple words, your app must launch fast.

For simple apps, using Redux or MobX with a persistence adapter is the easiest way to go. But when you start scaling to thousands or tens of thousands of database records, your app will now be slow to launch (especially on slower Android devices). Loading a full database into JavaScript is expensive!

Watermelon fixes it by being lazy. Nothing is loaded unless requested. And since all querying is performed directly on the rock-solid SQLite database on a separate native thread, most queries resolve in an instant.

But unlike using SQLite directly, Watermelon is fully observable. So whenever you change a record, all UI that depends on it will automatically re-render. For example, completing a task in a to-do app will re-render the task component, the list (to reorder), and all relevant task counters. Learn more.

React Native EU: Next-generation React Databases WatermelonDB Demo

📺 Next-generation React databases
(a talk about WatermelonDB)

Check out the Demo

Usage

Quick (over-simplified) example: an app with posts and comments.

First, you define Models:

class Post extends Model {
  @field('name') name
  @field('body') body
  @children('comments') comments
}

class Comment extends Model {
  @field('body') body
  @field('author') author
}

Then, you connect components to the data:

const Comment = ({ comment }) => (
  <View style={styles.commentBox}>
    <Text>{comment.body} — by {comment.author}</Text>
  </View>
)

// This is how you make your app reactive! ✨
const enhance = withObservables(['comment'], ({ comment }) => ({
  comment: comment.observe()
}))
const EnhancedComment = enhance(Comment)

And now you can render the whole Post:

const Post = ({ post, comments }) => (
  <View>
    <Text>{post.name}</Text>
    <Text>Comments:</Text>
    {comments.map(comment =>
      <Comment key={comment.id} comment={comment} />
    )}
  </View>
)

const enhance = withObservables(['post'], ({ post }) => ({
  post,
  comments: post.comments
}))

The result is fully reactive! Whenever a post or comment is added, changed, or removed, the right components will automatically re-render on screen. Doesn't matter if a change occurred in a totally different part of the app, it all just works out of the box!

➡️ Learn more: see full documentation

Who uses WatermelonDB

Nozbe Teams
CAPMO
Steady
Aerobotics
Smash Appz
Rocket Chat

Does your company or app use 🍉? Open a pull request and add your logo/icon with link here!

Contributing

We need you

WatermelonDB is an open-source project and it needs your help to thrive!

If there's a missing feature, a bug, or other improvement you'd like, we encourage you to contribute! Feel free to open an issue to get some guidance and see Contributing guide for details about project setup, testing, etc.

If you're just getting started, see good first issues that are easy to contribute to. If you make a non-trivial contribution, email me, and I'll send you a nice 🍉 sticker!

If you make or are considering making an app using WatermelonDB, please let us know!

Author and license

WatermelonDB was created by @Nozbe. Main author and maintainer is Radek Pietruszewski.

Contributors: @mobily, @kokusGr, @rozPierog, @rkrajewski, @domeknn, @Tereszkiewicz and more.

WatermelonDB is available under the MIT license. See the LICENSE file for more info.

You can’t perform that action at this time.