12_configuracion_de_bases_de_datos.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "[![imagenes/pythonista.png](imagenes/pythonista.png)](https://pythonista.io)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Configuración de bases de datos."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**ADVERTENCIAS:** \n",
    "\n",
    "* Para poder realizar exitosamente los ejercicios de esta notebook, es necesario haber seguido al pie de la letra y en orden sucesivo las instrucciones de todas las notebooks previas.\n",
    "* Se da por sentado de que el sistema desde el que se ejecute esta notebook tiene instalado y habilitado un gestor de bases de datos *MySQL* o *MariaDB* con un usuario *root* acreditado."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Bases de datos soportadas por *Django*.\n",
    "\n",
    "El paquete ```django.db.backends``` contiene los motores o *engines* que *Django* puede utilizar para conectarse a las siguientes bases de datos.\n",
    "\n",
    "* *PostgreSQL*. Es el gestor de base de datos preferido por los desarrolladores de Django.\n",
    "* *MySQL*. Este *engine* no funciona correctamente con Python 3.\n",
    "* *Oracle*.\n",
    "* *SQLite*.\n",
    "\n",
    "La referencia completa del usos de bases de datos de *Django* puede ser consultada en:\n",
    "\n",
    "https://docs.djangoproject.com/en/3.1/ref/databases/\n",
    "\n",
    "Existen proyectos que pueden soportan la creaciór de modelos en bases de datos NoSQL, tales como [*djongo*](https://nesdis.github.io/djongo/), pero para este curso sólo se estudiarán las bases de datos relacionales soportadas por defecto."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Ejemplo:**\n",
    "\n",
    "El paquete ```django.backends``` contiene los conectores a diversas bases de datos."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from django.db import backends"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "help(backends)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "##  El contenido de ```DATABASE``` en el script ```settings.py```.\n",
    "\n",
    "Django siempre estará ligado a una base de datos desde su instalación.\n",
    "\n",
    "La confguración de las bases de datos a las que *Django* puede acceder se encuentran en la variable ```DATABASES``` del archivo ```settings``` del proyecto."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Configuración inicial del proyecto con *SQLite*.\n",
    "\n",
    "El archivo ```tutorial/tutorial/settings.py``` contiene la configuración que se creó al momento de generar el proyecto, la cual define una conexión a una base de datos [*SQLite*](https://www.sqlite.org) cuyo archivo se encuentra localizado en ```tutorial/db.sqlite3```.\n",
    "\n",
    "\n",
    "La variable ```DATABASES``` define lo siguiente:\n",
    "\n",
    "``` python\n",
    "DATABASES = {\n",
    "    'default': {\n",
    "        'ENGINE': 'django.db.backends.sqlite3',\n",
    "        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),\n",
    "    }\n",
    "}\n",
    "```\n",
    "\n",
    "**Nota:** La base de datos *SQLite* instalada es totalmente funcional para fines didácticos, por lo que no es obligatorio modificar la configuración inicial a menos que se desee utilizar otro gestor de bases de datos."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%pycat tutorial/tutorial/settings.py"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Estructura de ```DATABASES```.\n",
    "\n",
    "El objeto con nombre ```DATABASES``` es de tipo ```dict``` y puede contener más de un acceso a base de datos conforme a la siguiente sintaxis.\n",
    "\n",
    "```\n",
    "DATABASES = {<dentificador 1>:{<argumentos de configuración>}, \n",
    "            <dentificador 2>:{<argumentos de configuración>},...\n",
    "            ...\n",
    "            <dentificador n>:{<argumentos de configuración>},} \n",
    "```\n",
    "La configuración de cada base de datos también corresponde a un objeto ```dict``` ligado a una clavee específica.\n",
    "\n",
    "### La configuración ```default```.\n",
    "\n",
    "La clave por defecto es ```default```. Siempre debe de existir una comnfiguración d bases de datos con esta clave."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Ejemplo:**\n",
    "\n",
    "```python\n",
    " 'default': {\n",
    "        'ENGINE': 'django.db.backends.sqlite3',\n",
    "        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),\n",
    "    }\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Parámetros de configuración de una base de datos.\n",
    "\n",
    "Los parámetros que definen la conexión de una base de datos pueden ser consultados en la siguiente liga:\n",
    "\n",
    "https://docs.djangoproject.com/en/3.1/ref/settings/#databases\n",
    "\n",
    "Los parámetros más comunes son los siguientes:\n",
    "\n",
    "* ```'ENGINE'```: indica el módulo de *Django* que se utilizará, dependiendo de la base de datos de la que se trate.\n",
    "* ```'NAME'```: indica el nombre de la base de datos.\n",
    "* ```'USER'```: indica el usuario con acceso a los recursos de la base da datos.\n",
    "* ```'PASSWORD'```: indica la contraseña del usuario con acceso a los recursos de la base da datos.\n",
    "* ```'HOST'```: Indica la URL en la que se encuentra escuchando el gestor de la base de datos.\n",
    "* ```'PORT'```: Indica el puerto en el que se encuentra escuchando el gestor de la base de datos."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Ejemplo ilustrativo."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Nota:** Las celdas de esta sección configurarán una conexión creada específicamente para la base de datos que se encuentra ejecutándose en la máquina virtual publicada por Pythonista®. En caso de usar un gestor de bases de datos distinto, no se deben de ejecutar las siguientes celdas."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "https://docs.djangoproject.com/en/3.0/topics/db/multi-db/"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### La base de datos *MySQL*."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### Preparación del conector de *MySQL*."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "!sudo apt-get install libmariadb-dev default-libmysqlclient-dev libssl-dev -y"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "!pip install mysqlclient"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "La máquina virtual publicada por Pythonista<sup>®</sup> cuenta con un servicio de *MariaDB* ejecutándose con las siguientes características:\n",
    "\n",
    "* Usuario: ```root```\n",
    "* Contraseña: ```0p3n5t4ck```\n",
    "* Host: ```localhost``` accesible exclusivamente desde la máquina virtual.\n",
    "* Puerto: ```3306```\n",
    "* Nombre de la base de datos: ```db_django```\n",
    "\n",
    "**Nota:** Es necesario crear previamente la base ```db_django``` en *MySQL*."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Configuración de ```settings.DATABASES```.\n",
    "\n",
    "El script ```src/12/settings.py``` contiene la siguiente configuración que define una conexión al gestor de bases de datos *MySQL* con clave ```'default'```.\n",
    "\n",
    "``` python\n",
    "\n",
    "DATABASES = {'default': {'ENGINE': 'django.db.backends.sqlite3',\n",
    "                         'NAME': os.path.join(BASE_DIR, 'db.sqlite3')},\n",
    "            'pythonista': {'ENGINE': 'django.db.backends.mysql',\n",
    "                           'USER': 'root',\n",
    "                           'PASSWORD': '0p3n5t4ck',\n",
    "                           'HOST': 'localhost',\n",
    "                           'PORT': 3306}}\n",
    "```\n",
    "\n",
    "**Advertencia:** Esta configuración fue creada para el gestor de base de datos de la máquina virtual publicada por Pythonista<sup>®</sup>. En caso de usar otra base de datos con otras credenciales de usuario, es necesario editar directamemente el script ```tutorial/tutorial/settings.py```."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "* La siguiente celda sustituirá al archivo ```tutorial/tutorial/settings.py``` con el archivo ```src/12/settings.py```."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "* Para la plataforma GNU/Linux y MacOS X."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "!cp src/12/settings.py tutorial/tutorial/settings.py"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "* Para la plataforma Windows."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "!copy src\\12\\settings.py tutorial\\tutorial\\settings.py"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "scrolled": false
   },
   "outputs": [],
   "source": [
    "%pycat tutorial/tutorial/settings.py"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## El subcomando ```migrate```.\n",
    "\n",
    "Al ejecutar ```manage.py```con el subcomando ```migrate``` se da de alta y sincronizar cada bases de datos indentificada con la clave correspondiente en el objeto ```DATABASES``` definido en ```settings.py```.\n",
    "\n",
    "``` bash\n",
    "./manage.py migrate --database=<clave>\n",
    "```\n",
    "o\n",
    "``` bash\n",
    "python manage.py migrate --database= <clave>\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Ejemplo:**\n",
    "\n",
    "* Se hará la sincronización de la configuración con identificador ```default```."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%cd tutorial"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "scrolled": true
   },
   "outputs": [],
   "source": [
    "!python manage.py migrate --database=default"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "!python manage.py migrate --database=pythonista"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## La extensión ```ipython-sql```.\n",
    "\n",
    "La extensión de ```IPython``` llamada ```ipython-sql``` permite conectarse a un gestor de bases de datos y ejecutar consultas *SQL* desde una celda usando el comando mágico ```%%sql```.\n",
    "\n",
    "La referencia a esta extensión se encuentra en https://github.com/catherinedevlin/ipython-sql."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Ejemplo:**"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "* La siguiente celda instalará la extensión ```ipython-sql```."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "! pip install ipython-sql mysql-connector"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "* La siguiente celda cargará la extensión a esta notebook."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%load_ext sql"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Inspección de una base de datos *MySQL* con ```ipython-sql```.\n",
    "\n",
    "* La siguiente celda se conectará al servidor utilizando ```mysql-connector-python```.\n",
    "\n",
    "**Nota:** En caso de que la contraseña del usuario ```root``` sea distinta de ```0p3n5t4ck```,es necesario sustituirla donde corresponda."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%sql mysql+mysqlconnector:https://root:0p3n5t4ck@localhost"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%sql show databases;"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%sql SHOW TABLES FROM db_django;"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Inspección de una base de datos *SQLite* con ```ipython-sql```.\n",
    "\n",
    "* La siguiente celda se conectará al servidor utilizando ```mysql-connector-python```."
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%sql sqlite:https:///tutorial/db.sqlite3"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "%%sql sqlite:https:///tutorial/db.sqlite3\n",
    "SELECT name FROM sqlite_master WHERE type = \"table\""
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "<p style=\"text-align: center\"><a rel=\"license\" href=\"https://creativecommons.org/licenses/by/4.0/\"><img alt=\"Licencia Creative Commons\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by/4.0/80x15.png\" /></a><br />Esta obra está bajo una <a rel=\"license\" href=\"https://creativecommons.org/licenses/by/4.0/\">Licencia Creative Commons Atribución 4.0 Internacional</a>.</p>\n",
    "<p style=\"text-align: center\">&copy; José Luis Chiquete Valdivieso. 2020.</p>"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3 (ipykernel)",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.2"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}