@nozbe/watermelondb/src/decorators/children/index.js

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

// @flow

import makeDecorator, { type Decorator } from '../../utils/common/makeDecorator'
import logError from '../../utils/common/logError'
import invariant from '../../utils/common/invariant'

import * as Q from '../../QueryDescription'
import type { TableName } from '../../Schema'
import type Model from '../../Model'
import type Query from '../../Query'

// Defines a model property that queries records that *belong_to* this model
// Pass name of the table with desired records. (The model defining a @children property must
// have a has_many association defined with this table)
//
// Example: a Task has_many Comments, so it may define:
//   @children('comment') comments: Query<Comment>

const children: Decorator = makeDecorator((childTable: TableName<any>) => () => ({
  get(): Query<Model> {
    // $FlowFixMe
    const that = this
    // Use cached Query if possible
    that._childrenQueryCache = that._childrenQueryCache || {}
    const cachedQuery = that._childrenQueryCache[childTable]
    if (cachedQuery) {
      return cachedQuery
    }

    // Cache new Query
    const model: Model = that.asModel
    const childCollection = model.collections.get(childTable)

    const association = model.constructor.associations[childTable]
    invariant(
      association && association.type === 'has_many',
      `@children decorator used for a table that's not has_many`,
    )

    const query = childCollection.query(Q.where(association.foreignKey, model.id))

    that._childrenQueryCache[childTable] = query
    return query
  },
  set(): void {
    logError('Setter called on a @children-marked property')
  },
}))

export default children