Woodshop for old agent generation
Try the new agent generation
  • What is woodshop
  • How to's
    • Smart Relationship
      • GetIdsFromRequest
    • Smart views
      • Display a calendar view
      • Create a custom tinder-like validation view
      • Create a custom moderation view
      • Create a dynamic calendar view for an event-booking use case
    • Configure environment variables
      • NodeJS/Express projects
    • Elasticsearch Integration
      • Interact with your Elasticsearch data
      • Elasticsearch service/utils
      • Another example
    • Zendesk Integration
      • Authentication, Filtering & Sorting
      • Display Zendesk tickets
      • Display Zendesk users
      • View tickets related to a user
      • Bonus: Direct link to Zendesk + change priority of a ticket
    • Dwolla integration
      • Display Dwolla customers
      • Display Dwolla funding sources
      • Display Dwolla transfers
      • Link users and Dwolla customers
      • Dwolla service
    • Make filters case insensitive
    • Use Azure Table Storage
    • Create multiple line charts
    • Create Charts with AWS Redshift
    • View soft-deleted records
    • Send Smart Action notifications to Slack
    • Authenticate a Forest Admin API against an OAuth protected API Backend
    • Translate your project into TypeScript
      • V8
        • Migrate Mongoose files
        • Migrate Sequelize files
      • v7
        • Migrate Mongoose files
        • Migrate Sequelize files
      • v6
    • Geocode an address with Algolia
    • Display/edit a nested document
    • Send an SMS with Zapier
    • Hash a password with bcrypt
    • Display a customized response
    • Search on a smart field with two joints
    • Override the count route
    • Make a field readOnly with Sequelize
    • Hubspot integration
      • Create a Hubspot company
      • Display Hubspot companies
    • Impersonate a user
    • Import data from a CSV file
    • Import data from a JSON file
    • Load smart fields using hook
    • Pre-fill a form with data from a relationship
    • Re-use a smart field logic
    • Link to record info in a smart view
    • Display data in html format
    • Upload files to AWS S3
    • Display AWS S3 files from signed URLs
    • Prevent record update
    • Display, search and update attributes from a JSON field
    • Add many existing records at the same time (hasMany-belongsTo relationship)
    • Track users’ logs with morgan
    • Search on relationship fields by default
    • Export related data as CSV
    • Run automated tests
  • Forest Admin Documentation
Powered by GitBook
On this page
  • Requirements
  • How it works
  • Directory: /routes

Was this helpful?

  1. How to's

Search on relationship fields by default

PreviousTrack users’ logs with morganNextExport related data as CSV

Last updated 3 years ago

Was this helpful?

By default, the search is performed only on the classic columns of your table and does not take into account the belongsTo fields.

You usually have the possibility to click on Try an extended search to extend the search to belongsTo fields in a second step.

But you can as well extend Forest Admin's default routes to use the extended search by default.

Requirements

  • An admin backend running on forest-express-sequelize

How it works

Directory: /routes

This directory contains the customers.js file where the model is declared.

You will have to update the routes that get the list but also the count of customers.

/routes/customers.js
...

// Get a list of Customers - Check out our documentation for more details: https://docs.forestadmin.com/documentation/reference-guide/routes/default-routes#get-a-list-of-records
router.get('/customers', permissionMiddlewareCreator.list(), (request, response, next) => {
  request.query.searchExtended = '1';
  
  const recordsGetter = new RecordsGetter(customers, request.user, request.query);
  recordsGetter.getAll()
    .then(records => recordsGetter.serialize(records))
    .then(recordsSerialized => response.send(recordsSerialized))
    .catch(next);
});

// Get a number of Customers - Check out our documentation for more details: https://docs.forestadmin.com/documentation/reference-guide/routes/default-routes#get-a-list-of-records
router.get('/customers/count', permissionMiddlewareCreator.list(), (request, response, next) => {
  request.query.searchExtended = '1';

  const recordsCounter = new RecordsCounter(customers, request.user, request.query);
  recordsCounter.count()
    .then(count => response.send({ count }))
    .catch(next);
});

...

With this snippet, only the customers'collection would use extended search by default.

Using extended search is less performant than default search. Use this wisely.