2-to-3.rst 1.3 KB

12345678910111213141516171819202122232425262728293031
  1. .. _upgrading.2-to-3:
  2. ==============
  3. Version 2 to 3
  4. ==============
  5. While we have made significant internal changes to the library, we have made
  6. every effort to ensure a seamless upgrade path from the 2.x series of this
  7. library to 3.x.
  8. One major breaking change is the transition from the ``Rhumsaa`` root namespace
  9. to ``Ramsey``. In most cases, all you will need is to change the namespace to
  10. ``Ramsey`` in your code, and everything will "just work."
  11. .. note::
  12. For more details on the namespace change, including reasons for the change,
  13. read the blog post "`Introducing ramsey/uuid
  14. <https://benramsey.com/blog/2016/04/ramsey-uuid/>`_".
  15. Here are full details on the breaking changes to the public API of this library:
  16. 1. All namespace references of ``Rhumsaa`` have changed to ``Ramsey``. Simply
  17. change the namespace to ``Ramsey`` in your code and everything should work.
  18. 2. The console application has moved to
  19. `ramsey/uuid-console <https://packagist.org/packages/ramsey/uuid-console>`_.
  20. If using the console functionality, use Composer to require
  21. ``ramsey/uuid-console``.
  22. 3. The Doctrine field type mapping has moved to
  23. `ramsey/uuid-doctrine <https://packagist.org/packages/ramsey/uuid-doctrine>`_.
  24. If using the Doctrine functionality, use Composer to require
  25. ``ramsey/uuid-doctrine``.