Merge pull request #222 from nvillahermosa-mdb/DOCSP-47931-analyze-your-application

DOCSP-47931 Analyze your application

Author: nvillahermosa-mdb

source/app-analysis/analysis-report.txt

@@ -0,0 +1,140 @@
+.. _rm-analysis-report:
+
+=================================
+The Pre-Migration Analysis Report
+=================================
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+The analysis report lists the migration risks detected in your database, and
+provides suggested mitigation actions for each one. To see all the potential
+migration risks that Relational Migrator can detect, see the :ref:`Migration
+Risk Reference <rm-app-analysis-risk-reference>`.
+
+Summary
+-------
+
+The :guilabel:`Summary` section lists the overall migration readiness of your
+database, and provides a breakdown of the metrics that affect that readiness
+level.
+
+Detection Breakdown
+~~~~~~~~~~~~~~~~~~~
+
+The Detection Breakdown shows how many detections have Actions Required,
+are Potential Risks, or are strictly Informational.
+
+.. image:: /img/app-analysis/app-analysis-detection-breakdown.png
+   :alt: A screenshot of the detection breakdown, with the migration readiness 
+   level and number of detections.
+
+Database Object Overview 
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+The Database Object Overview shows detections for Tables, Stored Procedures,
+Triggers, and Views. Table risks are further categorized as Data Type, Schema,
+Unsupported Feature, or Performance.
+
+.. note::
+
+   Pre-Migration Analysis doesn't analyze the SQL code of stored
+   procedures, views, and triggers. If your database has procedures that may
+   present an issue, please contact your account representative.
+
+.. image:: /img/app-analysis/app-analysis-db-objects.png
+   :alt: A screenshot of the database object overview, with the number of 
+   detections of each type.
+
+Once you've addressed the migration risks, you can run Pre-Migration Analysis
+again by clicking :guilabel:`Rerun analysis` to confirm that there aren't any
+more issues.
+
+Database
+--------
+
+The :guilabel:`Database` section lists all detected risks for your relational
+database. If you use the :guilabel:`Status` column of the table to mark
+resolved risks, they are hidden from the list. Check :guilabel:`Include
+resolved detections` to show them.
+
+You can switch between tabs for more information on different types of 
+detections.
+
+The All detections tab
+~~~~~~~~~~~~~~~~~~~~~~
+
+This is the default tab, and shows all detections in a single table. You can
+use the dropdown to switch between :guilabel:`Show all`, :guilabel:`Tasks
+only`, :guilabel:`Risks only`, and :guilabel:`Notes only`. 
+
+The Tables tab
+~~~~~~~~~~~~~~
+
+The :guilabel:`Tables` tab lists detections for each table. The
+:guilabel:`Overview and Analysis` toggle shows detections. Switch it to
+:guilabel:`Columns` to see the column definitions for the selected table.
+
+The Stored Procedures tab
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. note::
+
+   Pre-Migration Analysis doesn't analyze stored procedure SQL code 
+   for risks.
+
+The :guilabel:`Stored Procedures` tab shows each procedure. Switch the 
+:guilabel:`Overview and Analysis` toggle to :guilabel:`SQL code`
+to see the code for the selected procedure.
+
+The Triggers tab
+~~~~~~~~~~~~~~~~
+
+.. note::
+
+   Pre-Migration Analysis doesn't analyze trigger SQL code for
+   risks, because MongoDB doesn't natively support triggers. Consider using
+   :ref:`Query Converter <rm-query-converter>` to convert your SQL to
+   :atlas:`Atlas Triggers </atlas-ui/triggers/>`, in order to replicate
+   existing behavior.
+
+The :guilabel:`Triggers` tab shows each trigger. Switch the 
+:guilabel:`Overview and Analysis` toggle to :guilabel:`SQL code`
+to see the code for the selected trigger.
+
+The Views tab
+~~~~~~~~~~~~~
+
+.. note::
+
+   Pre-Migration Analysis doesn't analyze view definitions for
+   risks, because views must be converted to MQL. Consider using :ref:`Query
+   Converter <rm-query-converter>` to migrate views.
+
+The :guilabel:`Views` tab shows each view. Switch the 
+:guilabel:`Overview and Analysis` toggle to :guilabel:`SQL code`
+to see the SQL definition for the selected view.
+
+The Incompatible features tab
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The :guilabel:`Incompatible features` tab lists incompatible features in your
+source database that either don't have a MongoDB equivalent, or work
+differently enough that Relational Migrator can't automatically migrate them.
+
+Prerequisites
+-------------
+
+The :guilabel:`Prerequisites` section lists necessary tasks to prepare your
+database for migration. This is a targeted list of recommendations based on the
+information gathered during Pre-Migration Analysis. For general information on
+database prerequisites, see :ref:`rm-prerequisites`.
+
+Resources
+---------
+
+The :guilabel:`Planning Resources` section lists links to MongoDB blogs and
+documentation content about data modeling and migration.

source/app-analysis/run-analysis.txt

@@ -10,3 +10,76 @@ Run Pre-Migration Analysis
    :depth: 1
    :class: singlecol
 
+
+You can run Pre-Migration Analysis against a relational database to
+review potential migration risks before migrating data to MongoDB. Running
+Pre-Migration Analysis generates a report that identifies risks and provides
+guidance on how to mitigate them.
+
+About this Task
+---------------
+
+Relational Migrator typically takes 5-10 minutes to crawl the database, though
+it can take longer if the machine running Relational Migrator isn't near the
+database server.
+
+.. important::
+
+   Relational Migrator supports Pre-Migration Analysis for Microsoft SQL
+   Server, MySQL, Oracle, and PostgreSQL. Pre-Migration Analysis isn't
+   supported for databases connected through a JDBC driver. For more
+   information on supported databases and versions, see 
+   :ref:`supported-databases`.
+
+Before you Begin
+----------------
+
+To run Pre-Migration Analysis, you need a :ref:`project with a live database
+connection <rm-create-project-live>`.
+
+Steps
+-----
+
+.. procedure::
+   :style:  normal
+
+   .. step:: Open your project
+
+      If your project has no Pre-Migration Analysis reports, Relational
+      Migrator displays help text to suggest analyzing your application.
+
+   .. step:: Navigate to the :guilabel:`Pre-Migration Analysis` tab
+
+      You can review previous reports here, or run Pre-Migration Analysis.
+
+   .. step:: Select a relational database connection if one isn't already set
+      
+      In the Database Connections bar, select the saved connection from the 
+      :guilabel:`Relational DB` dropdown.
+
+   .. step:: Click :guilabel:`Run analysis`
+
+      If you didn't save credentials when saving the relational database
+      connection, enter them now and then click :guilabel:`Connect
+      and run analysis` to continue.
+      
+      Relational Migrator analyzes the connected source database. You can click
+      :guilabel:`Terminate` if you need to stop the process. Once complete,
+      Relational Migrator shows the resulting report.
+
+      .. important::
+
+         If Relational Migrator encounters errors, it displays the message "An
+         error occurred during the analysis. As a result, there may be
+         information missing from the report." If this happens, click
+         :guilabel:`Rerun analysis` on the report Summary page to run analysis
+         again. If the problem persists, please contact your account 
+         representative.
+
+Next Steps
+----------
+
+After running Pre-Migration Analysis, :ref:`review the report
+<rm-analysis-report>` and follow the recommended actions. You can then re-run
+analysis by navigating to the report Summary and clicking :guilabel:`Rerun
+analysis` to see if any risks remain.

source/database-connections/database-connections.txt renamed to source/database-connections.txt

@@ -147,7 +147,7 @@ Explore libraries and tools for MongoDB.
 
    Get Started </getting-started>
    Installation </installation>
-   Database Connections </database-connections/database-connections>
+   Database Connections </database-connections>
    Pre-Migration Analysis </app-analysis>
    Projects </projects>
    Mapping Rules </mapping-rules/introduction>