You are here

README.txt in User Relationships 5

User Relationship Migrate Module
---------------------------------

This is a plugin module for the User Relationships module. It allows admins to migrate
Buddy List relationships to User Relationships.

Send comments to JB Christy: http://drupal.org/user/174933, or post an issue at
http://drupal.org/project/user_relationships.


Requirements
------------
Drupal 5
User Relationships Module
Buddy List Module


Installation
------------
Enable User Relationship Migrate in the "Site building -> Modules" administration screen.


Usage
-----
After enabling the module, go to the "User management -> Relationships" page
(admin/user/relationships) and click on "Migrate buddylist" in the menu across the top.
Enter a relationship type for the migrated relationships, and click Migrate. Depending on
how many buddies are in your database, this could take several minutes, and the status /
confirmation page won't display until it's complete. [On my server, it took about 10
minutes to migrate 630,000 buddylist entries.] Don't click Migrate more than once, and
don't navigate away from the page, or you won't see the status / confirmation page that
tells you the results of the migration.

When the migration completes successfully, you will see the confirmation page, and the
module will automatically disable itself, since it's work is done.

Because the migration deals with a large quantity of data, it's very possible that it may
encounter errors during the migration. If it encounters more than 100 errors inserting
data, it will automatically abort the migration. PHP may also run out of memory, or other
errors may occur. The module has logic built in to keep track of its progress, and to pick
up where it left off in the event you need to restart it. It also has logic to prevent it
from being run more than once simultaneously, in case you accidentally click the Migrate
button twice. [However, if you do click Migrate more than once, you'll never see the page
telling you the results of the migration, so try not to do that.] Finally, it has logic to
prevent it from being run a second time after having completed successfully.


PLEASE NOTE: Due to overhead and performance considerations, this module creates
relationships without checking to see if the given relationship already exists. You should
therefore run this migration before making User Relationships module available to your
users, to minimize the likelihood that they manually recreate their relationships prior to
you migrating them.


Database Schema
---------------
N/A


Credits
-------
Written by JB Christy.
Written originally for and financially supported by OurChart Inc. (http://www.ourchart.com)
Thanks to Jeff Smick for the User Relationships module, and to the Buddy List folks.

File

plugins/user_relationship_migrate/README.txt
View source
  1. User Relationship Migrate Module
  2. ---------------------------------
  3. This is a plugin module for the User Relationships module. It allows admins to migrate
  4. Buddy List relationships to User Relationships.
  5. Send comments to JB Christy: http://drupal.org/user/174933, or post an issue at
  6. http://drupal.org/project/user_relationships.
  7. Requirements
  8. ------------
  9. Drupal 5
  10. User Relationships Module
  11. Buddy List Module
  12. Installation
  13. ------------
  14. Enable User Relationship Migrate in the "Site building -> Modules" administration screen.
  15. Usage
  16. -----
  17. After enabling the module, go to the "User management -> Relationships" page
  18. (admin/user/relationships) and click on "Migrate buddylist" in the menu across the top.
  19. Enter a relationship type for the migrated relationships, and click Migrate. Depending on
  20. how many buddies are in your database, this could take several minutes, and the status /
  21. confirmation page won't display until it's complete. [On my server, it took about 10
  22. minutes to migrate 630,000 buddylist entries.] Don't click Migrate more than once, and
  23. don't navigate away from the page, or you won't see the status / confirmation page that
  24. tells you the results of the migration.
  25. When the migration completes successfully, you will see the confirmation page, and the
  26. module will automatically disable itself, since it's work is done.
  27. Because the migration deals with a large quantity of data, it's very possible that it may
  28. encounter errors during the migration. If it encounters more than 100 errors inserting
  29. data, it will automatically abort the migration. PHP may also run out of memory, or other
  30. errors may occur. The module has logic built in to keep track of its progress, and to pick
  31. up where it left off in the event you need to restart it. It also has logic to prevent it
  32. from being run more than once simultaneously, in case you accidentally click the Migrate
  33. button twice. [However, if you do click Migrate more than once, you'll never see the page
  34. telling you the results of the migration, so try not to do that.] Finally, it has logic to
  35. prevent it from being run a second time after having completed successfully.
  36. PLEASE NOTE: Due to overhead and performance considerations, this module creates
  37. relationships without checking to see if the given relationship already exists. You should
  38. therefore run this migration before making User Relationships module available to your
  39. users, to minimize the likelihood that they manually recreate their relationships prior to
  40. you migrating them.
  41. Database Schema
  42. ---------------
  43. N/A
  44. Credits
  45. -------
  46. Written by JB Christy.
  47. Written originally for and financially supported by OurChart Inc. (http://www.ourchart.com)
  48. Thanks to Jeff Smick for the User Relationships module, and to the Buddy List folks.