UPE Big Little Database Design

Overview

• Status: In Progress

The UPE Website will be getting Big-Little data from a database instead of manually putting in Big-Little pairs.

Context

Goal

Eliminate the need to manually put in data to the Family Tree.

Problem

1. Too much manual work to display Big-Little pairs. Currently, we would have to add the data to "famtree.txt" and then run "fam_generator.py" to convert to JSON. If we just have the data in a SQL database and get the output from the UPE API, then the tree can be dynamic and not require any manual updates.
2. Difficult to move family tree to new website. We would have to copy over all the files related to the family tree rather than making a single API call to get the data we need.

Design

Database Design

Relevant Information

Engine: MySQL (MariaDB)

Max DB Size: 1 GB (requested by the OCF)

Table Size: 256 MB (general guideline)

Schema

CREATE TABLE big_little (

big_email TEXT NOT NULL;

little_email TEXT NOT NULL;

);

API Documentation

Swagger UI Documentation found at: /docs

ReDoc Documentation found at: /redoc