You are here

README.txt in Data export import 6

Same filename and directory in other branches
  1. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Overview
 * Installation
 * Usage

OVERVIEW
--------

The purpose of this module is to provide a way to move data between
Drupal instances. 

This is not easy to achieve as Drupal stores configuration and data in
the same database. Also, Drupal can be extended and customised which
makes creating a standard data export/import module effectively
impossible. 

This module will provide a framework for exporting datasets as files
and also for importing these dataset files. That way if the module is
installed on two separate Drupal instances it will be possible to
export data as a dataset file from one instance and import it into a
different Drupal instance. 

This module will be customisable and extendable by adding new profiles
to take into account different Drupal builds. This means that if a
Drupal instance has a very specialised setup it will be possible to
create a new dataset profile to export/import data. 

The module currently includes two initial dataset profiles which can
be used on standard Drupal instances. These enable the following
datasets to be exported/imported.

 * Taxonomy vocabulary terms
 * Pages

When exporting all data should be exported - when importing the data
should be used in a way to make sure that the receiving Drupal
instance ends up with matching data. Careful checks will be needed to
ensure ID's match, that the data remains consistent.

Effectively this module will be similar to the backup_migrate module
except that the backup_migrate profiles will be extended. Currently
the backup_migrate profiles only allow for the choice of which tables
will be exported/imported and a few other settings. This module will
use the Druapl API to read data and produce rich data files which will
contain all data needed to reproduce a particular dataset. It will
also use the Drupal API to recreate data. It may also be necessary to
use SQL directly to export/import data.

The primary usage for this module is envisioned to be exporting
datasets from a live Drupal site and importing this live data into a
new updated version of the site which developers have been working
on - i.e. a beta version. Once the import has completed then the newly
developed site can become the new live site. This has the advantage of
being able to fall back to the original live site if there is an
unforseen problem between the new version of the site and the live
data.

It will be necessary to carry out proper checks when importing
datasets. E.g.. when node data is being imported it will be necessary
to check that the receiving site has the correct content type and
fields etc. It may be necessary to use the UUID module to provide
unique ID's.

INSTALLATION
------------

 * Put the module in your Drupal modules directory and enable it in
   admin/build/modules.
 * Go to admin/user/permissions and grant permission to any roles that
   need to be able to export or import datasets.

USAGE
-----

 * Configure and use the module at admin/content/data_export_import.
 * The dataset files are exported to and imported from
   {files}/data_export_import.  Various methods can be used to manage
   the files and to move the files between Drupal instances.
   Although not tested the module at:
   http://drupal.org/project/webfm looks suitable for file management.
 * The user which is running the module needs to have permissions to
   be able to delete nodes when importing pages.  It is expected that
   data exporting and importing will be carried out by the admin user
   which has correct permissions.
 * Currently the pages import has been created to import standard
   simple pages.  It can handle a simple added text type CCK field -
   but any other file type fields are not being handled yet.
 * If you have taxonomy terms associated with pages this has not been
   coded for yet.  It may work OK but you might be better to import
   the taxonomy terms separately first and then import the pages.

NOTES
-----

 * This module is not compatible with any site which has localisation
   enabled. Checks have been put in place to prevent data being output
   if localisation has been installed and enabled using the i18n
   module.
 * If this is a requirement then please get in touch with the
   maintainer.

File

README.txt
View source
  1. CONTENTS OF THIS FILE
  2. ---------------------
  3. * Overview
  4. * Installation
  5. * Usage
  6. OVERVIEW
  7. --------
  8. The purpose of this module is to provide a way to move data between
  9. Drupal instances.
  10. This is not easy to achieve as Drupal stores configuration and data in
  11. the same database. Also, Drupal can be extended and customised which
  12. makes creating a standard data export/import module effectively
  13. impossible.
  14. This module will provide a framework for exporting datasets as files
  15. and also for importing these dataset files. That way if the module is
  16. installed on two separate Drupal instances it will be possible to
  17. export data as a dataset file from one instance and import it into a
  18. different Drupal instance.
  19. This module will be customisable and extendable by adding new profiles
  20. to take into account different Drupal builds. This means that if a
  21. Drupal instance has a very specialised setup it will be possible to
  22. create a new dataset profile to export/import data.
  23. The module currently includes two initial dataset profiles which can
  24. be used on standard Drupal instances. These enable the following
  25. datasets to be exported/imported.
  26. * Taxonomy vocabulary terms
  27. * Pages
  28. When exporting all data should be exported - when importing the data
  29. should be used in a way to make sure that the receiving Drupal
  30. instance ends up with matching data. Careful checks will be needed to
  31. ensure ID's match, that the data remains consistent.
  32. Effectively this module will be similar to the backup_migrate module
  33. except that the backup_migrate profiles will be extended. Currently
  34. the backup_migrate profiles only allow for the choice of which tables
  35. will be exported/imported and a few other settings. This module will
  36. use the Druapl API to read data and produce rich data files which will
  37. contain all data needed to reproduce a particular dataset. It will
  38. also use the Drupal API to recreate data. It may also be necessary to
  39. use SQL directly to export/import data.
  40. The primary usage for this module is envisioned to be exporting
  41. datasets from a live Drupal site and importing this live data into a
  42. new updated version of the site which developers have been working
  43. on - i.e. a beta version. Once the import has completed then the newly
  44. developed site can become the new live site. This has the advantage of
  45. being able to fall back to the original live site if there is an
  46. unforseen problem between the new version of the site and the live
  47. data.
  48. It will be necessary to carry out proper checks when importing
  49. datasets. E.g.. when node data is being imported it will be necessary
  50. to check that the receiving site has the correct content type and
  51. fields etc. It may be necessary to use the UUID module to provide
  52. unique ID's.
  53. INSTALLATION
  54. ------------
  55. * Put the module in your Drupal modules directory and enable it in
  56. admin/build/modules.
  57. * Go to admin/user/permissions and grant permission to any roles that
  58. need to be able to export or import datasets.
  59. USAGE
  60. -----
  61. * Configure and use the module at admin/content/data_export_import.
  62. * The dataset files are exported to and imported from
  63. {files}/data_export_import. Various methods can be used to manage
  64. the files and to move the files between Drupal instances.
  65. Although not tested the module at:
  66. http://drupal.org/project/webfm looks suitable for file management.
  67. * The user which is running the module needs to have permissions to
  68. be able to delete nodes when importing pages. It is expected that
  69. data exporting and importing will be carried out by the admin user
  70. which has correct permissions.
  71. * Currently the pages import has been created to import standard
  72. simple pages. It can handle a simple added text type CCK field -
  73. but any other file type fields are not being handled yet.
  74. * If you have taxonomy terms associated with pages this has not been
  75. coded for yet. It may work OK but you might be better to import
  76. the taxonomy terms separately first and then import the pages.
  77. NOTES
  78. -----
  79. * This module is not compatible with any site which has localisation
  80. enabled. Checks have been put in place to prevent data being output
  81. if localisation has been installed and enabled using the i18n
  82. module.
  83. * If this is a requirement then please get in touch with the
  84. maintainer.