Scope on a smart field extracting a json's column attribute

Please be sure of your agent type and version and pick the right documentation accordingly.

Node.js

This is the documentation of the forest-express-sequelize and forest-express-mongoose Node.js agents that will soon reach end-of-support.

forest-express-sequelize v9 and forest-express-mongoose v9 are replaced by @forestadmin/agent v1.

Please check your agent type and version and read on or switch to the right documentation.

Ruby on Rails

This is still the latest Ruby on Rails documentation of the forest_liana agent, you’re at the right place, please read on.

Python

This is the documentation of the django-forestadmin Django agent that will soon reach end-of-support.

If you’re using a Django agent, notice that django-forestadmin v1 is replaced by forestadmin-agent-django v1.

If you’re using a Flask agent, go to the forestadmin-agent-flask v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

PHP

This is the documentation of the forestadmin/laravel-forestadmin Laravel agent that will soon reach end-of-support.

If you’re using a Laravel agent, notice that forestadmin/laravel-forestadmin v1 is replaced by forestadmin/laravel-forestadmin v3.

If you’re using a Symfony agent, go to the forestadmin/symfony-forestadmin v1 documentation.

Please check your agent type and version and read on or switch to the right documentation.

Scope on a smart field extracting a json's column attribute

Context: As a user, I want to scope a table's records based on the value of an attribute nested within a json column.

Example: I have a table users that includes a JSONB column named contact. The contact json can include a phone, email or country attribute. Since I want to scope my collection by country, I created a smart field called country that returns the value of the country attribute and I implemented a filter feature for this field.

Implementation

The smart field definition and the filtering logic are defined as follows in the forest/users.js file of my admin backend.

const { collection } = require('forest-express-sequelize');
const models = require('../models');

const { Op } = models.objectMapping;

collection('users', {
  actions: [],
  fields: [
    {
      field: 'country',
      isFilterable: true,
      type: 'String',
      get: (record) => record.contact.country,
      filter({ condition, where }) {
        switch (condition.operator) {
          case 'equal':
            return {
              'contact.country': { [Op.eq]: condition.value },
            };
          // ... And so on with the other operators not_equal, starts_with, etc.

          default:
            return null;
        }
      },
    },
  ],
  segments: [],
});

In order to make your smart field filterable in the UI, you both need to add the isFilterable: true option in the field's declaration and to enable filtering on this field in the field settings in the UI.