Skip to content

Custom project configuration

Jelle Siderius edited this page Nov 12, 2025 · 9 revisions

Project specific configuration

Add a .mage-db-sync-config.json file to your Magento root folder for project-specific configuration.


Configuration Options

Store URLs (core_config_data)

Configure base URLs for each store view using their scope ID (store ID).

Scope IDs:

  • 0 - Default/Global scope
  • 1, 2, 3, etc. - Individual store view IDs

Database Table Exclusions

Version 1.2.11+

Exclude specific tables during database download using wildcard patterns or exact table names.

Available Options:

  • databaseStripDevelopment - Tables to exclude during development sync
  • databaseStripFull - Tables to exclude during full sync

Pattern Support:

  • Use * as wildcard for pattern matching (e.g., table_prefix_*)
  • Specify exact table names without wildcards
  • Separate multiple tables with spaces

Example Configuration

{
  "core_config_data": {
    "0": {
      "web/unsecure/base_url": "https://store-url.development/",
      "web/secure/base_url": "https://store-url.development/"
    },
    "1": {
      "web/unsecure/base_url": "https://store-url-1.development/",
      "web/secure/base_url": "https://store-url-1.development/"
    },
    "2": {
      "web/unsecure/base_url": "https://store-url-2.development/",
      "web/secure/base_url": "https://store-url-2.development/"
    }
  },
  "databaseStripDevelopment": "log_* report_* customer_log",
  "databaseStripFull": "session_* admin_analytics_* sales_bestsellers_*"
}

Common Use Cases

Single Store Setup

{
  "core_config_data": {
    "0": {
      "web/unsecure/base_url": "https://mystore.development/",
      "web/secure/base_url": "https://mystore.development/"
    }
  }
}

Multi-Store with Table Exclusions

{
  "core_config_data": {
    "0": {
      "web/unsecure/base_url": "https://main.development/",
      "web/secure/base_url": "https://main.development/"
    },
    "1": {
      "web/unsecure/base_url": "https://store-eu.development/",
      "web/secure/base_url": "https://store-eu.development/"
    },
    "2": {
      "web/unsecure/base_url": "https://store-us.development/",
      "web/secure/base_url": "https://store-us.development/"
    }
  },
  "databaseStripDevelopment": "log_visitor_* report_viewed_* customer_visitor",
  "databaseStripFull": "session_* indexer_state cache_tag"
}

Tips

  • Always use trailing slashes in URLs
  • Verify store IDs in store table before configuration
  • Use wildcards to exclude entire table groups efficiently
  • Test table exclusions with development sync first