Naming conflicts

This is the official documentation of the @forestadmin/agent Node.js agent.

Collection naming collisions

When importing collections to an admin panel, you may encounter naming collisions.

You can tackle them by renaming the collection that is causing issues.

There are two ways to rename collections: either provide a plain object which maps the old names to the new names, or a function which does the same.

Don't worry about leaving naming collisions: your development agent will warn you and crash at startup.

const { createAgent } = require('@forestadmin/agent');
const { createSqlDataSource } = require('@forestadmin/datasource-sql');
const { toPascalCase } = require('./utils');

const agent = createAgent(options);
const sqlDataSource = createSqlDataSource(
  'postgres://user:pass@localhost:5432/mySchema',
);

// Rename sqlDataSource collections by providing replacements
agent
  // Rename the `customers` and `stores` collections.
  // Note that other collections won't be renamed.
  .addDataSource(sqlDataSource, {
    rename: {
      customers: 'customersFromFrenchBranch',
      stores: 'storesFromFrenchBranch',
    },
  })

  // Renaming collection can also be done by providing a function.
  // All collections will be renamed (the handler is called once per collection)
  // This example is pretty usefull if you are migrating an old project following our migration guide
  .addDataSource(sqlDataSource, {
    rename: underscoreCasedName => toPascalCase(underscoreCasedName),
  });

Field naming collisions

You can tackle them by renaming the fields that are causing issues too.

Use the renameField method to change the name inside your forestadmin-schema.

We have developed an additional plugin to tackle this issue more easily: @forestadmin-experimental/plugin-rename-all-fields ↗

TypeScript

import renameAllFields, {
  snakeToCamelCase,
} from '@forestadmin-experimental/plugin-rename-all-fields';

agent
  // Add all your datasources then ...
  ...
  // Renaming fields
  // All field will be renamed (the handler is called once per field)
  .use(renameAllFields, snakeToCamelCase);

JavaScript

const { default: renameAllFields, snakeToCamelCase } = require('@forestadmin-experimental/plugin-rename-all-fields');

agent
  // Add all your datasources then ...
  ...
  // Renaming fields
  // All fields will be renamed (the handler is called once per field)
  .use(renameAllFields, snakeToCamelCase);