.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "_auto_examples/aequilibrae_project/plot_project_upgrade.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download__auto_examples_aequilibrae_project_plot_project_upgrade.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr__auto_examples_aequilibrae_project_plot_project_upgrade.py:


.. _upgrade_project_db_example:

Upgrade project database
========================

In this example, we show how to upgrade a project database to the latest version.
This is useful when you need to use the latest AequilibraE's database schemas or formats.

.. GENERATED FROM PYTHON SOURCE LINES 12-15

.. admonition:: References

   * :ref:`database_migration`

.. GENERATED FROM PYTHON SOURCE LINES 17-21

.. seealso::
    Functions used in this example:

    * :func:`aequilibrae.project.project.Project.upgrade`

.. GENERATED FROM PYTHON SOURCE LINES 23-33

.. code-block:: Python


    # Imports
    from uuid import uuid4
    from tempfile import gettempdir
    from os.path import join

    from aequilibrae.project.tools import MigrationManager
    from aequilibrae.utils.create_example import create_example
    from aequilibrae.utils.spatialite_utils import connect_spatialite





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    No pre-existing parameter file exists for this project. Will use default




.. GENERATED FROM PYTHON SOURCE LINES 34-41

.. code-block:: Python


    # We create an empty project on an arbitrary folder
    fldr = join(gettempdir(), uuid4().hex)

    # Let's use Sioux Falls project
    project = create_example(fldr)








.. GENERATED FROM PYTHON SOURCE LINES 42-43

To upgrade all database migrations in a single transaction, we can use:

.. GENERATED FROM PYTHON SOURCE LINES 43-46

.. code-block:: Python


    # project.upgrade()








.. GENERATED FROM PYTHON SOURCE LINES 47-48

However, it is possible to upgrade only the project database.

.. GENERATED FROM PYTHON SOURCE LINES 48-50

.. code-block:: Python

    project.upgrade(ignore_transit=True, ignore_results=True)





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    /home/runner/work/aequilibrae/aequilibrae/aequilibrae/project/project.py:259: UserWarning: Take care when ignoring a database during an upgrade.
      warnings.warn("Take care when ignoring a database during an upgrade.")
    Ignoring transit database during upgrade
    Ignoring results database during upgrade




.. GENERATED FROM PYTHON SOURCE LINES 51-52

Finally, we close the project

.. GENERATED FROM PYTHON SOURCE LINES 52-53

.. code-block:: Python

    project.close()




.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    This project at /tmp/b5c68bd55a85455aa832bc73ef0d9e0e is already closed





.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 1.924 seconds)


.. _sphx_glr_download__auto_examples_aequilibrae_project_plot_project_upgrade.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_project_upgrade.ipynb <plot_project_upgrade.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_project_upgrade.py <plot_project_upgrade.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_project_upgrade.zip <plot_project_upgrade.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_