Skip to content

Commit 2ed789d

Browse files
nvillahermosa-mdbnvillahermosa-mdb
authored
Merge pull request #224 from nvillahermosa-mdb/DOCSP-44350-merge-app-analysis-docs
DOCSP-44350 Merge app analysis docs
2 parents 6efc35f + 71de4e7 commit 2ed789d

File tree

9 files changed

+968
-2
lines changed

9 files changed

+968
-2
lines changed

‎snooty.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ toc_landing_pages = [
1919
"installation/kafka-deployments/migrator-with-kafka",
2020
"installation/file-location",
2121
"database-connections/database-connections",
22+
"app-analysis",
2223
"projects",
2324
"mapping-rules/introduction",
2425
"mapping-rules/mapping-rule-options/introduction",
@@ -58,3 +59,12 @@ variant = "warning"
5859
value = """\
5960
DB2 database support is currently in public preview. Users looking for production-grade migration assistance, please contact your account representative to engage in a guided evaluation.
6061
"""
62+
63+
[[banners]]
64+
targets = [
65+
"app-analysis.txt",
66+
]
67+
variant = "warning"
68+
value = """\
69+
Pre-Migration Analysis is new in Relational Migrator 1.13 and currently in public preview. Users looking for production-grade migration assistance, please contact your account representative to engage in a guided evaluation.
70+
"""

‎source/app-analysis.txt

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
.. _rm-app-analysis:
2+
3+
======================
4+
Pre-Migration Analysis
5+
======================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
After connecting to a supported relational database, run Pre-Migration
14+
Analysis to identify potential data and configuration risks before attempting
15+
data migration. The resulting report summarizes necessary actions to take
16+
before migrating your data.
17+
18+
.. important::
19+
20+
Relational Migrator supports Pre-Migration Analysis for Microsoft SQL
21+
Server, MySQL, Oracle, and PostgreSQL. Pre-Migration Analysis isn't
22+
supported for databases connected through a JDBC driver. For more
23+
information on supported databases and versions, see
24+
:ref:`supported-databases`.
25+
26+
Types of Risks
27+
--------------
28+
29+
Pre-Migration Analysis groups potential risks into the following types:
30+
31+
- Unsupported source database features
32+
- Data type incompatibilities
33+
- Schema mapping risks
34+
- Migration performance risks
35+
36+
After :ref:`running analysis <rm-run-app-analysis>`, the report lists each
37+
identified risk, its severity, and suggested remediation actions.
38+
39+
For a list of all risks Relational Migrator reports on, see the
40+
:ref:`Migration Risk Reference <rm-app-analysis-risk-reference>`.
41+
42+
43+
Get Started
44+
-----------
45+
46+
- :ref:`Connect to a Database <rm-save-relational-connection>`
47+
- :ref:`Run Pre-Migration Analysis <rm-run-app-analysis>`
48+
49+
.. toctree::
50+
:hidden:
51+
:titlesonly:
52+
53+
Run Pre-Migration Analysis </app-analysis/run-analysis>
54+
Analysis Report </app-analysis/analysis-report>
55+
Risk Reference </app-analysis/risk-reference>

‎source/app-analysis/analysis-report.txt

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
.. _rm-analysis-report:
2+
3+
=================================
4+
The Pre-Migration Analysis Report
5+
=================================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
The analysis report lists the migration risks detected in your database, and
14+
provides suggested mitigation actions for each one. To see all the potential
15+
migration risks that Relational Migrator can detect, see the :ref:`Migration
16+
Risk Reference <rm-app-analysis-risk-reference>`.
17+
18+
Summary
19+
-------
20+
21+
The :guilabel:`Summary` section lists the overall migration readiness of your
22+
database, and provides a breakdown of the metrics that affect that readiness
23+
level.
24+
25+
Detection Breakdown
26+
~~~~~~~~~~~~~~~~~~~
27+
28+
The Detection Breakdown shows how many detections have Actions Required,
29+
are Potential Risks, or are strictly Informational.
30+
31+
.. image:: /img/app-analysis/app-analysis-detection-breakdown.png
32+
:alt: A screenshot of the detection breakdown, with the migration readiness level and number of detections.
33+
34+
Database Object Overview
35+
~~~~~~~~~~~~~~~~~~~~~~~~
36+
37+
The Database Object Overview shows detections for Tables, Stored Procedures,
38+
Triggers, and Views. Table risks are further categorized as Data Type, Schema,
39+
Unsupported Feature, or Performance.
40+
41+
.. note::
42+
43+
Pre-Migration Analysis doesn't analyze the SQL code of stored
44+
procedures, views, and triggers. If your database has procedures that may
45+
present an issue, please contact your account representative.
46+
47+
.. image:: /img/app-analysis/app-analysis-db-objects.png
48+
:alt: A screenshot of the database object overview, with the number of detections of each type.
49+
50+
Once you've addressed the migration risks, you can run Pre-Migration Analysis
51+
again by clicking :guilabel:`Rerun analysis` to confirm that there aren't any
52+
more issues.
53+
54+
Database
55+
--------
56+
57+
The :guilabel:`Database` section lists all detected risks for your relational
58+
database. If you use the :guilabel:`Status` column of the table to mark
59+
resolved risks, they are hidden from the list. Check :guilabel:`Include
60+
resolved detections` to show them.
61+
62+
You can switch between tabs for more information on different types of
63+
detections.
64+
65+
The All detections tab
66+
~~~~~~~~~~~~~~~~~~~~~~
67+
68+
This is the default tab, and shows all detections in a single table. You can
69+
use the dropdown to switch between :guilabel:`Show all`, :guilabel:`Tasks
70+
only`, :guilabel:`Risks only`, and :guilabel:`Notes only`.
71+
72+
The Tables tab
73+
~~~~~~~~~~~~~~
74+
75+
The :guilabel:`Tables` tab lists detections for each table. The
76+
:guilabel:`Overview and Analysis` toggle shows detections. Switch it to
77+
:guilabel:`Columns` to see the column definitions for the selected table.
78+
79+
The Stored Procedures tab
80+
~~~~~~~~~~~~~~~~~~~~~~~~~
81+
82+
.. note::
83+
84+
Pre-Migration Analysis doesn't analyze stored procedure SQL code
85+
for risks.
86+
87+
The :guilabel:`Stored Procedures` tab shows each procedure. Switch the
88+
:guilabel:`Overview and Analysis` toggle to :guilabel:`SQL code`
89+
to see the code for the selected procedure.
90+
91+
The Triggers tab
92+
~~~~~~~~~~~~~~~~
93+
94+
.. note::
95+
96+
Pre-Migration Analysis doesn't analyze trigger SQL code for
97+
risks, because MongoDB doesn't natively support triggers. Consider using
98+
:ref:`Query Converter <rm-query-converter>` to convert your SQL to
99+
:atlas:`Atlas Triggers </atlas-ui/triggers/>`, in order to replicate
100+
existing behavior.
101+
102+
The :guilabel:`Triggers` tab shows each trigger. Switch the
103+
:guilabel:`Overview and Analysis` toggle to :guilabel:`SQL code`
104+
to see the code for the selected trigger.
105+
106+
The Views tab
107+
~~~~~~~~~~~~~
108+
109+
.. note::
110+
111+
Pre-Migration Analysis doesn't analyze view definitions for
112+
risks, because views must be converted to MQL. Consider using :ref:`Query
113+
Converter <rm-query-converter>` to migrate views.
114+
115+
The :guilabel:`Views` tab shows each view. Switch the
116+
:guilabel:`Overview and Analysis` toggle to :guilabel:`SQL code`
117+
to see the SQL definition for the selected view.
118+
119+
The Incompatible features tab
120+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
121+
122+
The :guilabel:`Incompatible features` tab lists incompatible features in your
123+
source database that either don't have a MongoDB equivalent, or work
124+
differently enough that Relational Migrator can't automatically migrate them.
125+
126+
Prerequisites
127+
-------------
128+
129+
The :guilabel:`Prerequisites` section lists necessary tasks to prepare your
130+
database for migration. This is a targeted list of recommendations based on the
131+
information gathered during Pre-Migration Analysis. For general information on
132+
database prerequisites, see :ref:`rm-prerequisites`.
133+
134+
Resources
135+
---------
136+
137+
The :guilabel:`Planning Resources` section lists links to MongoDB blogs and
138+
documentation content about data modeling and migration.

0 commit comments

Comments
 (0)