Migrate API

The Migrate API provides services for migrating data from different sources to Drupal 9 (or later).

This is the documentation handbook for the Migrate API. More detailed technical documentation for the Migrate API classes and interfaces can be found at api.drupal.org.

For instructions on how to upgrade an existing Drupal 6 or Drupal 7 site to Drupal 8, refer to the Upgrading Drupal handbook.

Migrate API overview

The Migrate API provides services for migrating data from different sources.

Migrate source plugins

Migrate API source plugins extract the data from the source. Examples include CSV, SQL table and JSON sources.

Migrate process plugins

Processing pipeline of a Drupal 8 migration and the general purpose process plugins provided by core and contrib modules.

Migrate destination plugins & examples

Examples on how to migrate nodes, users and other entities to Drupal 8.

Executing migrations

This page describes how migration definitions can be imported and executed.

Writing migrations for contributed and custom modules

Examples for writing migrations for contributed and custom modules.

Migration Tests

This is a overview of the types of migration tests in Drupal core.

Generating database fixtures for migration tests

Introduction to creating test fixtures for use in testing Drupal 6 or Drupal 7 migrations.

Debugging migrations

This page describes how migration definitions can be debugged.

Migrate field plugins

Field plugins provide a direct upgrade solution from D6 and D7 fields to modern Drupal equivalents

Process Pipelines

Process plugins are the building blocks of migrations. Here are some examples of stacking those blocks into towers for real-life purposes.

Guide maintainers

masipila's picture
benjifisher's picture
j. ayen green's picture