Need help with WatermelonDB?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

Nozbe
7.1K Stars 377 Forks MIT License 2.9K Commits 70 Opened issues

Description

🍉 Reactive & asynchronous database for powerful React and React Native apps ⚡️

Services available

!
?

Need anything else?

Contributors list

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 | | 🔄 | Offline-first. Sync with your own backend | | 📱 | Multiplatform. iOS, Android, and the web | | ⚛️ | Works with React. Easily plug data into components | | ⏱ | Fast. And getting faster with every release! | | ✅ | Proven. Powers Nozbe Teams since 2017 (and many others) | | ✨ | Reactive. (Optional) RxJS API | | 🔗 | Relational. Built on rock-solid SQLite foundation | | ⚠️ | Static typing with Flow or TypeScript |

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 until it's 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 web 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 }) => (
  
    {comment.body} — by {comment.author}
  
)

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

And now you can render the whole Post:

const Post = ({ post, comments }) => (
  
    {post.name}
    Comments:
    {comments.map(comment =>
      
    )}
  
)

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


HaloGo

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.