Update config and example notebook

Author: kennethleungty

Example-Notebook.ipynb

@@ -2,15 +2,15 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "id": "909edcb0",
+   "id": "2ec6e0e7",
    "metadata": {},
    "source": [
-    "## Using PyMySQL to access and modify RDS MySQL Database Instance"
+    "# Using PyMySQL to access and modify RDS MySQL Database Instance"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "f4e125bd",
+   "id": "29d02d2b",
    "metadata": {},
    "source": [
     "### Necessary imports"
@@ -19,7 +19,7 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "id": "f70c9d8c",
+   "id": "f4706480",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -29,7 +29,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "9f6288a7",
+   "id": "5ea1c5d0",
    "metadata": {},
    "source": [
     "___\n",
@@ -38,8 +38,8 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
-   "id": "caded1e3",
+   "execution_count": 2,
+   "id": "66a73d8e",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -52,29 +52,36 @@
     "                                     db=DBNAME,\n",
     "                                     cursorclass=CURSORCLASS,\n",
     "                                     ssl_ca=SSL_CA)\n",
-    "        status = 'Success'\n",
     "        print('[+] RDS Connection Successful')\n",
     "    except Exception as e:\n",
-    "        print(f'[+] RDS Connection Failed: {e}')\n",
-    "        status, connection = 'Failed', None\n",
+    "        print(f'[-] RDS Connection Failed: {e}')\n",
+    "        connection = None\n",
     "\n",
-    "    return connection, status"
+    "    return connection"
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": null,
-   "id": "2e6db776",
+   "execution_count": 3,
+   "id": "961eb394",
    "metadata": {},
-   "outputs": [],
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "[+] RDS Connection Successful\n"
+     ]
+    }
+   ],
    "source": [
     "# Initiate RDS connection\n",
-    "connection, status = start_rds_connection()"
+    "connection = start_rds_connection()"
    ]
   },
   {
    "cell_type": "markdown",
-   "id": "42adf77b",
+   "id": "49ffd330",
    "metadata": {},
    "source": [
     "___\n",
@@ -83,8 +90,8 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
-   "id": "db24605f",
+   "execution_count": 4,
+   "id": "dc36379b",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -97,8 +104,8 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
-   "id": "361c09da",
+   "execution_count": 5,
+   "id": "66a455b6",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -108,13 +115,63 @@
     "            sql = f\"INSERT INTO `{tableName}` (`nClientID`, `dtRecordAdded`, `dtLastVisit`) VALUES (%s, %s, %s)\"\n",
     "            cursor.execute(sql, (nClientID, dtRecordAdded, dtLastVisit))\n",
     "\n",
-    "        # connection is not autocommit by default. So you must commit to save your changes.\n",
+    "        # Connection is not autocommit by default, so we must commit to save changes\n",
     "        connection.commit()\n",
-    "        print(f'Successfully inserted record into {table_name}')\n",
+    "        print(f'Successfully inserted record into {tableName}')\n",
     "        \n",
     "    except Exception as e:\n",
     "        print(f'Error in insertion to MySQL database: {e}')"
    ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 6,
+   "id": "f6894d17",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "Successfully inserted record into tblClients\n"
+     ]
+    }
+   ],
+   "source": [
+    "insert_record(tableName, nClientID, dtRecordAdded, dtLastVisit)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "id": "9a1c25f2",
+   "metadata": {},
+   "source": [
+    "### Query table to verify insertion"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 7,
+   "id": "3c5b7bb8",
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
+      "[{'nClientID': 'S0000001A', 'dtRecordAdded': datetime.datetime(2022, 1, 1, 0, 0), 'dtLastVisit': datetime.datetime(2022, 12, 31, 0, 0)}]\n"
+     ]
+    }
+   ],
+   "source": [
+    "with connection.cursor() as cursor:\n",
+    "    sql = f\"SELECT * FROM `{tableName}`\"\n",
+    "    cursor.execute(sql)\n",
+    "    result = cursor.fetchall()\n",
+    "    print(result)\n",
+    "    \n",
+    "connection.commit()"
+   ]
   }
  ],
  "metadata": {

config.py

@@ -1,12 +1,10 @@
 import pymysql
 
-ACCESS_KEY_USER_KENNETH = 'xxxxx'
-SECRET_KEY_USER_KENNETH = 'xxxxx'
-USERNAME = 'admin' # Master username
-PASSWORD = 'xxx' # Password of RDS Credential Settings
-ENDPOINT = "client-database.xxxxx.ap-southeast-1.rds.amazonaws.com"
-PORT = 3306
-REGION = "ap-southeast-1"
-DBNAME = "client-database"
-CURSORCLASS = pymysql.cursors.DictCursor
-SSL_CA = "ssl/ap-southeast-1-bundle.pem"
+USERNAME = 'admin'  # Replace with your master username 
+PASSWORD = 'XXXXX'  # Replace with your RDS instance password
+ENDPOINT = "XXXXXXX.XXXXXXX.ap-southeast-1.rds.amazonaws.com"  # Replace with your RDS endpoint
+PORT = 3306   # Replace with the RDS instance port
+REGION = "ap-southeast-1b"  # Replace with your AWS region
+DBNAME = 'schema1'  # Replace with the name of your SCHEMA in MySQL workbench
+SSL_CA = "ssl/ap-southeast-1-bundle.pem"  # Replace with the folder location of your SSL bundle
+CURSORCLASS = pymysql.cursors.DictCursor  # No need to modify this