|
| 1 | +.. _rm-manage-projects: |
| 2 | + |
| 3 | +=============== |
| 4 | +Manage Projects |
| 5 | +=============== |
| 6 | + |
| 7 | +.. default-domain:: mongodb |
| 8 | + |
| 9 | +.. contents:: On this page |
| 10 | + :local: |
| 11 | + :backlinks: none |
| 12 | + :depth: 1 |
| 13 | + :class: singlecol |
| 14 | + |
| 15 | +You can export, import, delete, or rename Relational Migrator projects |
| 16 | +from the :guilabel:`home page`. |
| 17 | + |
| 18 | +.. _export-project: |
| 19 | + |
| 20 | +Export a Project |
| 21 | +---------------- |
| 22 | + |
| 23 | +Export Relational Migrator projects to share a project with other users, |
| 24 | +duplicate a project, or back up a project. Before you export your project, |
| 25 | +consider the following: |
| 26 | + |
| 27 | +- Relational Migrator can only export ``.relmig`` files. |
| 28 | + |
| 29 | +- Exported project files do not include the migration job history or passwords. |
| 30 | + |
| 31 | +Steps |
| 32 | +~~~~~ |
| 33 | + |
| 34 | +.. procedure:: |
| 35 | + :style: normal |
| 36 | + |
| 37 | + .. step:: Open your project commands. |
| 38 | + |
| 39 | + - To open your project commands from the :guilabel:`home page`, click the |
| 40 | + :icon-lg:`Ellipsis` icon next to the project. |
| 41 | + |
| 42 | + - To open your project commands from your :guilabel:`open project page`, click |
| 43 | + the :icon-lg:`VerticalEllipsis` icon next to the project name. |
| 44 | + |
| 45 | + .. step:: Select :guilabel:`Export`. |
| 46 | + |
| 47 | + .. step:: Click :guilabel:`Export` to confirm. |
| 48 | + |
| 49 | + Your project is exported as a ``.relmig`` file. |
| 50 | + |
| 51 | +.. _import-project: |
| 52 | + |
| 53 | +Import a Project |
| 54 | +---------------- |
| 55 | + |
| 56 | +Import a project when you want to collaborate on a shared project. You |
| 57 | +can also duplicate a project by :ref:`exporting <export-project>` the |
| 58 | +project and then importing it. Before you import a project, consider |
| 59 | +the following: |
| 60 | + |
| 61 | +- When you import projects, Relational Migrator only uses ``.relmig`` files. |
| 62 | + |
| 63 | +- Relational Migrator rejects files for import and returns an error message in |
| 64 | + the following conditions: |
| 65 | + |
| 66 | + - The format of the file cannot be determined. |
| 67 | + |
| 68 | + - Required information is missing from the file. |
| 69 | + |
| 70 | + - The file was exported from an unsupported version of Relational Migrator. |
| 71 | + |
| 72 | + - The version number of the file is older than a well-defined minimum version. |
| 73 | + |
| 74 | +Steps |
| 75 | +~~~~~ |
| 76 | + |
| 77 | +.. procedure:: |
| 78 | + :style: normal |
| 79 | + |
| 80 | + .. step:: On your :guilabel:`home page`, select :guilabel:`New Project`. |
| 81 | + |
| 82 | + .. step:: Select :guilabel:`Import an existing project`. |
| 83 | + |
| 84 | + .. step:: Choose a file, or drag and drop the ``.relmig`` file. |
| 85 | + |
| 86 | + .. step:: Click :guilabel:`Import`. |
| 87 | + |
| 88 | +.. _delete-project: |
| 89 | + |
| 90 | +Delete a Project |
| 91 | +---------------- |
| 92 | + |
| 93 | +Delete a project to remove migration workloads that are no longer needed. |
| 94 | +If the last project on the :guilabel:`Recent Projects` page is deleted, the |
| 95 | +:guilabel:`New Project` page is displayed. |
| 96 | + |
| 97 | +Steps |
| 98 | +~~~~~ |
| 99 | + |
| 100 | +.. procedure:: |
| 101 | + :style: normal |
| 102 | + |
| 103 | + .. step:: From the :guilabel:`project view`, click the :icon-lg:`Home` icon in the top-left corner. |
| 104 | + |
| 105 | + .. step:: Click the :icon-lg:`Ellipsis` icon next to your project of choice. Select :guilabel:`Delete`. |
| 106 | + |
| 107 | + .. step:: Click :guilabel:`Delete` to confirm. |
| 108 | + |
| 109 | + .. warning:: |
| 110 | + |
| 111 | + You cannot recover a deleted project. |
| 112 | + |
| 113 | +.. _rename-project: |
| 114 | + |
| 115 | +Rename a Project |
| 116 | +---------------- |
| 117 | + |
| 118 | +To update the name of an existing project, use the :guilabel:`Rename` option. |
| 119 | + |
| 120 | +Steps |
| 121 | +~~~~~ |
| 122 | + |
| 123 | +.. procedure:: |
| 124 | + :style: normal |
| 125 | + |
| 126 | + .. step:: From the project view, click the :icon-lg:`Home` icon in the top-left corner. |
| 127 | + |
| 128 | + .. step:: Click the :icon-lg:`Ellipsis` icon next to your project of choice. Select :guilabel:`Rename`. |
| 129 | + |
| 130 | + .. step:: Enter a new project name. |
| 131 | + |
| 132 | + The new name must be 1-50 characters long and can't be in use by another project. |
| 133 | + |
| 134 | + .. step:: Click :guilabel:`Save`. |
| 135 | + |
| 136 | +Next Steps |
| 137 | +---------- |
| 138 | + |
| 139 | +- :ref:`<rm-create-project-live>` |
| 140 | +- :ref:`<migrator-without-live-connection>` |
| 141 | +- :ref:`Connect to Databases <rm-database-connections>` |
| 142 | +- :ref:`<rm-mapping-rules>` |
| 143 | +- :ref:`<rm-sync-jobs>` |
0 commit comments