SmartNgRX Documentation

Home
Using Smart NgRX
Intro Effects Service Injection Token Entity Definitions Global Registration Entity Registration ChildDefinition Smart Selector
Mark and Delete
Introduction MarkAndDeleteInit Global Mark and Delete Entity Mark and Delete
Child Fields
CRUD Support
Retrieving Rows Virtual IDs Updates Create (Add) a Row Delete a Row
Using With Existing Selectors WebSockets Error Handling
Demo Walkthrough
Introduction Database Structure Retrieving Data Setup Client Side Effects Services Selectors Tree Component Updating Fields Adding Rows Deleting Rows Processing WebSocket Messages
API
Public API Internal API
Demo Walkthrough Database Structure

Database Structure

The backend database uses SqlLite3, a lightweight database that is easy to use and set up. The database is stored in a file called database.db in the root of the project and is created and populated with data when you pnpm install the project for the first time.

We use Prisma to interact with the database, including creating tables, inserting data, and querying data. Prisma is a modern database toolkit that makes it easy to interact with databases in a type-safe way. It is used to generate the database schema and typescript types from the database schema.

The database schema and subsequent changes are managed using Prisma Migrate. Prisma Migrate is a database schema migration tool that allows you to make changes to the database schema and apply those changes to the database.

You can find the Prisma schema in the prisma/schema.prisma` file. This file defines the database schema and is used by Prisma to generate the database schema and typescript types.

Tables

Currently all of our tables are structured the same with the exception of a field that points to the parent table's id. This is used to create a tree structure in the database.

The fields all tables have are:

  • id: a unique identifier for the record as a guid.
  • name: the name of the record.
  • version: the version of the record as an integer that increments every time something gets updated.
  • created: the timestamp for when the record was created, we use this to order the records in the UI.

The database has the following tables:

  • locations: this is the top level table.
  • departments: this table as a locationId field that points back to the locations table.
  • docs: this table has a departmentId field that points back to the departments table.
  • folders: this table has a departmentId field that points back to the departments table.
  • lists: this table has a departmentId field that points back to the departments table.
  • sprintFolders: this table has a departmentId field that points back to the departments table.

You'll notice that the docs, folders, lists, and sprintFolders tables all have a departmentId field that points back to the departments table. This allows these to all be children of the departments table.

Previous
Introduction
Next
Retrieving Data