Skip to content

DOCSP-47796: Database connections #230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mayaraman19 merged 2 commits into from
Mar 24, 2025
Merged

DOCSP-47796: Database connections #230

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
da9b921
commit
mayaraman19 Mar 18, 2025
4221995
ref
mayaraman19 Mar 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions source/database-connections/manage-database-connections.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,40 @@ You can copy, edit, or delete database connections from the Relational Migrator
tag. You can mouse over the :icon-fa5:`info-circle` icon for a connection to
see a list of projects that use that connection.

Create a Connection
-------------------

You can create a connection by using one of the following places in the
Relational Migrator UI.
Copy link
Collaborator

@jwilson-mdb jwilson-mdb Mar 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feedback from review session: Can we add a link or a sentence w/a link to the UI Overview page?

This would help newer users who aren't as familiar with RM identify the UI elements we list below.


Creating a New Project
~~~~~~~~~~~~~~~~~~~~~~

You can create a connection when you create a new project. After selecting
:guilabel:`Connect to live database` from the :guilabel:`New Project`
page, select the :guilabel:`Add a new connection` option. See :ref:`rm-projects`
for more information.

Connections Page
~~~~~~~~~~~~~~~~

In the :guilabel:`Connections` tab on the home screen, click
:guilabel:`+ Add connection`.

Database Connections Bar
~~~~~~~~~~~~~~~~~~~~~~~~

In a project's :guilabel:`Database Connections Bar`, open the
of :guilabel:`Relational` connections and click :guilabel:`+ Add connection`.

Creating or Modifying a Data Migration Job
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In a project's :guilabel:`Data Migration` tab,
click :guilabel:`Create migration job`
and select :guilabel:`Add a new connection`. See :ref:`rm-create-jobs`
for more information.

Copy a Connection
-----------------

Expand Down