www.aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/migrate_plus/README.txt

   1 The migrate_plus module extends the core migration system with API enhancements
   2 and additional functionality, as well as providing practical examples.
   3
   4 Extensions to base API
   5 ======================
   6 * A Migration configuration entity is provided, enabling persistance of dynamic
   7   migration configuration.
   8 * A MigrationGroup configuration entity is provided, which enables migrations to
   9   be organized in groups, and to maintain shared configuration in one place.
  10 * A MigrateEvents::PREPARE_ROW event is provided to dispatch hook_prepare_row()
  11   invocations as events.
  12 * A SourcePluginExtension class is provided, enabling one to define fields and
  13   IDs for a source plugin via configuration rather than requiring PHP code.
  14
  15 Plugin types
  16 ============
  17 migrate_plus provides the following plugin types, for use with the url source
  18 plugin.
  19
  20 * A data_parser type, for parsing different formats on behalf of the url source
  21   plugin.
  22 * A data_fetcher type, for fetching data to feed into a data_parser plugin.
  23 * An authentication type, for adding authentication headers with the http
  24   data_fetcher plugin.
  25
  26 Plugins
  27 =======
  28
  29 Process
  30 -------
  31 * The entity_lookup process plugin allows you to populate references to entities
  32   which already exist in Drupal, whether they were migrated or not.
  33 * The entity_generate process plugin extends entity_lookup to also create the
  34   desired entity when it doesn't already exist.
  35 * The file_blob process plugin supports creating file entities from blob data.
  36 * The merge process plugin allows the merging of multiple arrays into a single
  37   field.
  38 * The skip_on_value process plugin allows you to skip a row, or a given field,
  39   for specific source values.
  40
  41 Source
  42 ------
  43 * A url source plugin is provided, implementing a common structure for
  44   file-based data providers.
  45
  46 Data parsers
  47 ------------
  48 * The xml parser plugin uses PHP's XMLReader interface to incrementally parse
  49   XML files. This should be used for XML sources which are potentially very
  50   large.
  51 * The simple_xml parser plugin uses PHP's SimpleXML interface to fully parse
  52   XML files. This should be used for XML sources where you need to be able to
  53   use complex xpaths for your item selectors, or have to access elements outside
  54   of the current item element via xpaths.
  55 * The json parser plugin supports JSON sources.
  56 * The soap parser plugin supports SOAP sources.
  57
  58 Data fetchers
  59 -------------
  60 * The file fetcher plugin works for most URLs regardless of protocol, as well as
  61   local filesystems.
  62 * The http fetcher plugin provides the ability to add headers to an HTTP
  63   request (particularly through authentication plugins).
  64
  65 Authentication
  66 --------------
  67 * The basic authentication plugin provides HTTP Basic authentication.
  68 * The digest authentication plugin provides HTTP Digest authentication.
  69 * The oauth2 authentication plugin provides OAuth2 authentication over HTTP.
  70
  71 Examples
  72 ========
  73 * The migrate_example submodule provides a fully functional and runnable
  74 example migration scenario demonstrating the basic concepts and most common
  75 techniques for SQL-based migrations.
  76 * The migrate_example_advanced submodule provides examples of migration from
  77 different kinds of sources, as well as less common techniques.