diff --git a/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php b/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php index 1e6a1b500e..18895c1901 100644 --- a/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php +++ b/core/modules/migrate/src/Plugin/migrate/source/SourcePluginBase.php @@ -16,12 +16,34 @@ * The base class for source plugins. * * Available configuration keys: - * - cache_counts: (optional) (Integer) If set cache the source count. - * - skip_count: (optional) (Integer) If set not attempt to count the source. - * - track_changes: (optional) (Integer) If set track changes to incoming data. + * - cache_counts: (optional) (boolean) If set cache the source count. + * - skip_count: (optional) (boolean) If set not attempt to count the source. + * - track_changes: (optional) (boolean) If set track changes to incoming data. * - high_water_property: It is an array of single value (optional table alias) * which have the high_water_property corresponding to it. * + * Example: + * + * @code + * source: + * plugin: some_source_plugin_name + * cache_counts: true + * skip_count: true + * track_changes: true + * @endcode + * + * The highwater mark or track changes not should be set at the same time. + * They are both designed to solve the same problem. + * + * Example: + * + * @code + * source: + * plugin: some_source_plugin_name + * high_water_property: + * name: something + * @endcode + * * @see \Drupal\migrate\Plugin\MigratePluginManager * @see \Drupal\migrate\Annotation\MigrateSource * @see \Drupal\migrate\Plugin\MigrateSourceInterface