From a91d2118891d198c7888679cab8e30eacf438bf4 Mon Sep 17 00:00:00 2001
From: saa150 <saa150@sfu.ca>
Date: Mon, 4 Apr 2022 00:51:23 -0700
Subject: [PATCH] (fix): added details of postgres and mysql in docs

---
 .../user_guide/eda/create_db_report.ipynb     | 103 ++++++++++++++++--
 1 file changed, 93 insertions(+), 10 deletions(-)

diff --git a/docs/source/user_guide/eda/create_db_report.ipynb b/docs/source/user_guide/eda/create_db_report.ipynb
index 9477136b1..6f6784625 100644
--- a/docs/source/user_guide/eda/create_db_report.ipynb
+++ b/docs/source/user_guide/eda/create_db_report.ipynb
@@ -27,7 +27,9 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Creating SQLAlchemy `create_engine` object"
+    "## Generate report via `create_db_report(sqlite_engine)`\n",
+    "\n",
+    "Here we provide with an example using SQLite database to demonstrate the functionality:"
    ]
   },
   {
@@ -40,15 +42,6 @@
     "db_engine = load_db('sakila.db')"
    ]
   },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "## Generate report via `create_db_report(database_engine)`\n",
-    "\n",
-    "Here we provide with an example using SQLite database to demonstrate the functionality:"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -63,6 +56,96 @@
     "from dataprep.eda import create_db_report\n",
     "create_db_report(db_engine)"
    ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Generate report via `create_db_report(mysql_engine)`\n",
+    "\n",
+    "Here we provide with an example using a MySQL database to demonstrate the functionality:"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Creating SQLAlchemy `create_engine` connector for MySQL"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "user = 'user'\n",
+    "password = 'password'\n",
+    "database_url=\"database-2.cnpnvdy4yt13.us-west-2.rds.amazonaws.com:3306/classicmodels\"\n",
+    "mysql_engine = create_engine('mysql://' + user + ':' + password + database_url)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Running `create_db_report` on MySQL database hosted on Amazon RDS"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from dataprep.eda import create_db_report\n",
+    "create_db_report(mysql_engine)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Generate report via `create_db_report(postgreSQL_engine)`\n",
+    "\n",
+    "Here we provide with an example using a local postgreSQL database to demonstrate the functionality:"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Creating SQLAlchemy `create_engine` connector for PostgreSQL"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "user = 'user'\n",
+    "password = 'password'\n",
+    "database_url='@localhost:5432/classicmodels'\n",
+    "postgresql_engine = create_engine('postgresql://' + user + ':' + password + database_url)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Running `create_db_report` on local PostgreSQL database"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from dataprep.eda import create_db_report\n",
+    "create_db_report(postgresql_engine)"
+   ]
   }
  ],
  "metadata": {