Better demo database schema for testing (#196)

* better schema

* typo

* Refactor readme

* update

* fix mysql migration

* mysql 5.6

* fix tests

* fix

* wip: figuring out why JSONB return

* fix tests

* fmt

* fixed all tests

* fixing clippy

* fix

* fix

* revert version

* fix

* fix demo

Author: JasonShin

LICENSE

@@ -1,4 +1,4 @@
-Copyright <2024> <Jason Shin>
+Copyright <2025> <Jason Shin>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

playpen/README.md

@@ -0,0 +1,76 @@
+# World of Warcraft Inspired SQL Schema
+
+This repository contains a comprehensive World of Warcraft-themed SQL schema designed to demonstrate the capabilities of [sqlx-ts](https://github.com/JasonShin/sqlx-ts). The schema models core game mechanics such as characters, races, classes, guilds, items, and quests, while incorporating MySQL and PostgreSQL's advanced features like JSONB, ENUM types, and relationships.
+
+## Overview
+The schema covers:
+- **Factions**: Represents the two primary factions - Alliance and Horde.
+- **Races**: Lists all playable races, associated with their faction.
+- **Classes**: Defines class specializations, including roles, weapons, and abilities stored as JSONB.
+- **Characters**: Central entity representing player characters, linked to races and classes.
+- **Guilds**: Guilds that characters can join, supporting a many-to-many relationship.
+- **Items**: Collectible items with dynamic stats stored as JSONB.
+- **Inventory**: Tracks character inventory, supporting multiple item quantities.
+- **Quests**: Represents character progression, including quest rewards and status.
+- **Random Data**: Demonstrates MySQL/PostgreSQL's wide range of data types for testing and exploration.
+
+## ERD Diagram
+
+<img src="./assets/schema.png" width="65%">
+
+## Installation and Setup
+
+1. Clone this repository:
+   ```bash
+   git clone https://github.com/jasonshin/sqlx-ts
+   ```
+   
+2. Ensure that you have [docker](https://www.docker.com/) and [docker-compose](https://docs.docker.com/compose/) installed
+
+3. Navigate to root directory of the project:
+   ```bash
+   docker compose up -d
+   ```
+
+4. Run the SQL schema on your MySQL/PostgreSQL instance:
+   ```bash
+   mysql -h 127.0.0.1 -P 33306 -u root sqlx-ts
+   psql -h 127.0.0.1 -p 54321 -U postgres # and then enter `postgres` as password
+   ```
+
+## Key Features
+- **Enum Types**: Faction, Race, and Class columns leverage MySQL/PostgreSQL ENUMs for better data consistency.
+- **JSONB Fields**: Flexible and scalable fields for class specializations, item stats, and quest rewards.
+- **Referential Integrity**: Foreign key relationships ensure data consistency across races, classes, and factions.
+- **Various types**: The schema utilises a wide range of string/numeric/date types to ensure every types are supported by sqlx-ts
+- **Complex Constraints**: Advanced CHECK constraints validate JSONB fields to ensure proper specialization structures.
+
+## Example Queries
+Fetch all characters with their race and class:
+```sql
+SELECT c.name AS character_name, r.name AS race, cl.name AS class
+FROM characters c
+JOIN races r ON c.race_id = r.id
+JOIN classes cl ON c.class_id = cl.id;
+```
+
+Retrieve all items in a character's inventory:
+```sql
+SELECT ch.name AS character_name, i.name AS item, inv.quantity
+FROM inventory inv
+JOIN characters ch ON inv.character_id = ch.id
+JOIN items i ON inv.item_id = i.id;
+```
+
+List all active quests for a character:
+```sql
+SELECT q.name AS quest_name, cq.status
+FROM character_quests cq
+JOIN quests q ON cq.quest_id = q.id
+WHERE cq.character_id = 1;
+```
+
+## License
+Please refer to [LICENSE](../LICENSE)
+
+

playpen/db/mysql_migration.sql

@@ -1,36 +1,141 @@
-CREATE TABLE tables (
-    id INTEGER NOT NULL AUTO_INCREMENT,
-    number INTEGER NOT NULL,
-    occupied BOOL NOT NULL DEFAULT FALSE,
-    PRIMARY KEY (id)
+CREATE TABLE faction_enum (
+  name ENUM('alliance', 'horde') NOT NULL PRIMARY KEY
 );
 
+CREATE TABLE race_enum (
+  name ENUM('human', 'night elf', 'dwarf', 'gnome', 'orc', 'troll', 'tauren', 'undead') NOT NULL PRIMARY KEY
+);
+
+CREATE TABLE class_enum (
+  name ENUM('warrior', 'hunter', 'priest', 'paladin', 'druid', 'mage', 'warlock') NOT NULL PRIMARY KEY
+);
+
+-- Factions Table
+CREATE TABLE factions (
+  id INT AUTO_INCREMENT PRIMARY KEY,
+  name ENUM('alliance', 'horde') UNIQUE NOT NULL,
+  description TEXT
+);
+
+-- Races Table
+CREATE TABLE races (
+  id INT AUTO_INCREMENT PRIMARY KEY,
+  name ENUM('human', 'night elf', 'dwarf', 'gnome', 'orc', 'troll', 'tauren', 'undead') UNIQUE NOT NULL,
+  faction_id INT,
+  FOREIGN KEY (faction_id) REFERENCES factions(id) ON DELETE CASCADE
+);
+
+-- Classes Table
+CREATE TABLE classes (
+  id INT AUTO_INCREMENT PRIMARY KEY,
+  name ENUM('warrior', 'hunter', 'priest', 'paladin', 'druid', 'mage', 'warlock') UNIQUE NOT NULL,
+  specialization JSON,
+  CHECK (
+    JSON_VALID(specialization) AND
+    JSON_UNQUOTE(JSON_EXTRACT(specialization, '$.role')) IN ('tank', 'healer', 'ranged', 'melee', 'hybrid') AND
+    JSON_LENGTH(JSON_EXTRACT(specialization, '$.abilities')) > 0 AND
+    (
+      JSON_EXTRACT(specialization, '$.tier') IS NULL OR
+      CAST(JSON_UNQUOTE(JSON_EXTRACT(specialization, '$.tier')) AS UNSIGNED) BETWEEN 1 AND 5
+    )
+  )
+);
+
+-- Characters Table
+CREATE TABLE characters (
+  id INT AUTO_INCREMENT PRIMARY KEY,
+  name VARCHAR(100) NOT NULL,
+  race_id INT,
+  class_id INT,
+  level SMALLINT DEFAULT 1,
+  experience BIGINT DEFAULT 0,
+  gold DOUBLE DEFAULT 0,
+  last_chat_time TIME,
+  login_time DATETIME,
+  logout_time DATETIME,
+  last_trade_time TIME,
+  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+  FOREIGN KEY (race_id) REFERENCES races(id),
+  FOREIGN KEY (class_id) REFERENCES classes(id)
+);
+
+-- Guilds Table
+CREATE TABLE guilds (
+  id INT AUTO_INCREMENT PRIMARY KEY,
+  name VARCHAR(100) UNIQUE NOT NULL,
+  description TEXT,
+  created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Guild Members Table
+CREATE TABLE guild_members (
+  guild_id INT,
+  character_id INT,
+  guild_rank VARCHAR(50),
+  joined_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+  PRIMARY KEY (guild_id, character_id),
+  FOREIGN KEY (guild_id) REFERENCES guilds(id) ON DELETE CASCADE,
+  FOREIGN KEY (character_id) REFERENCES characters(id) ON DELETE CASCADE
+);
+
+-- Inventory Table
+CREATE TABLE inventory (
+  id INT AUTO_INCREMENT PRIMARY KEY,
+  quantity INT DEFAULT 1,
+  character_id INT,
+  FOREIGN KEY (character_id) REFERENCES characters(id) ON DELETE CASCADE
+);
+
+-- Items Table
 CREATE TABLE items (
-   id INTEGER NOT NULL,
-   food_type VARCHAR(30) NOT NULL,
-   time_takes_to_cook INTEGER NOT NULL,
-   table_id INTEGER NOT NULL,
-   points SMALLINT NOT NULL,
-   description VARCHAR(255) NULL,
-   FOREIGN KEY (table_id) REFERENCES tables (id),
-   PRIMARY KEY (id)
+  id INT AUTO_INCREMENT PRIMARY KEY,
+  name VARCHAR(100) NOT NULL,
+  rarity VARCHAR(50),
+  inventory_id INT,
+  flavor_text TEXT,
+  FOREIGN KEY (inventory_id) REFERENCES inventory(id) ON DELETE CASCADE
+);
+
+-- Quests Table
+CREATE TABLE quests (
+  id INT AUTO_INCREMENT PRIMARY KEY,
+  name VARCHAR(100) NOT NULL,
+  description TEXT,
+  rewards JSON,
+  completed BOOL DEFAULT false,
+  required_level INT DEFAULT 1
 );
 
-INSERT INTO tables (number)
-VALUES
-    (1), (2), (3), (4), (5), (6), (7), (8), (9), (10);
+-- Character Quests Table
+CREATE TABLE character_quests (
+  character_id INT,
+  quest_id INT,
+  status VARCHAR(50) DEFAULT 'In Progress',
+  PRIMARY KEY (character_id, quest_id),
+  FOREIGN KEY (character_id) REFERENCES characters(id) ON DELETE CASCADE,
+  FOREIGN KEY (quest_id) REFERENCES quests(id) ON DELETE CASCADE
+);
 
-INSERT INTO items (id, food_type, time_takes_to_cook, table_id, points)
-VALUES
-  (1, 'korean', 10, 1, 2),
-  (2, 'chinese', 10, 1, 2),
-  (3, 'japanese', 10, 1, 2),
-  (4, 'italian', 10, 1, 2),
-  (5, 'french', 10, 1, 2);
+-- Seed Data
+INSERT INTO factions (name, description) VALUES
+('alliance', 'The noble and righteous faction'),
+('horde', 'The fierce and battle-hardened faction');
 
+INSERT INTO races (name, faction_id) VALUES
+('human', 1),
+('night elf', 1),
+('dwarf', 1),
+('gnome', 1),
+('orc', 2),
+('troll', 2),
+('tauren', 2),
+('undead', 2);
 
--- We can primarily use this table to check how a column in MySQL can be converted to a TsFieldType
+INSERT INTO classes (name, specialization) VALUES
+('warrior', '{"role": "tank", "weapon": "sword", "abilities": ["charge", "slam", "shield block"]}'),
+('hunter', '{"role": "ranged", "weapon": "bow", "abilities": ["aimed shot", "multi-shot", "trap"]}');
 
+-- We can primarily use this table to check how a column in MySQL can be converted to a TsFieldType
 CREATE TABLE random (
 	-- numeric types
     intz INT,
@@ -61,11 +166,9 @@ CREATE TABLE random (
 	blob1 BLOB,
 	text1 TEXT,
 		-- ideally this one should be generated as a legit enum type
-	enum1 ENUM('x-small', 'small', 'medium', 'large', 'x-large'),
+	enum1 ENUM('alliance', 'horde'),
 	set1 SET('one', 'two'),
 
 	-- JSON types
 	json1 JSON
-
 );
-