База података
ChurchApps API користи архитектуру једна база по модулу. Сваки од шест модула података има сопствену MySQL базу са независним пулом веза, што даје јасне границе података и истовремено задржава све у оквиру једне инсталације.
Пре почетка
- Инсталирајте MySQL 8.0+ -- погледајте Предуслови
- Подесите стрингове за повезивање са базом у вашој
.envдатотеци -- погледајте Променљиве окружења
Преглед архитектуре
Api
├── membership_db ← Особе, групе, дозволе
├── attendance_db ← Служби, сесије, записи
├── content_db ← Странице, одељци, елементи
├── giving_db ← Донације, фондови, плаћања
├── messaging_db ← Разговори, обавештења
└── doing_db ← Задаци, планови, додељивања
Кључне одлуке у дизајну
- Једна база по модулу -- Сваки модул води сопствену MySQL базу са посебним пулом веза (којим управља
KyselyPool). Ово одржава модуле раздвојеним и омогућава независну еволуцију шеме. - Ексклузивно власништво -- Табеле модула читају и уписују само кодови тог модула. Када други модул треба податке, он позива капију власничког модула, а не упућује упите директно на табеле -- погледајте Комуникација између модула.
- Образац репозиторијума без ORM-а -- Сав приступ подацима иде кроз класе репозиторијума које граде типизиране SQL упите помоћу Kysely градитеља упита над шемом модула. Тиме се постиже потпуна контрола над перформансама и понашањем упита.
- Више цркава по дизајну -- Сваки упит је ограничен на
churchId. Све табеле садрже колонуchurchId, а слој репозиторијума аутоматски спроводи раздвајање података између цркава.
Стрингови за повезивање
Веза са базом сваког модула подешава се у .env датотеци стандардним MySQL форматом стринга за повезивање:
mysql://user:password@host:port/database
На пример, локално развојно окружење може изгледати овако:
Сваки модул чита своју везу из променљиве окружења под именом <MODULE>_CONNECTION_STRING:
MEMBERSHIP_CONNECTION_STRING=mysql://root:password@localhost:3306/churchapps_membership
ATTENDANCE_CONNECTION_STRING=mysql://root:password@localhost:3306/churchapps_attendance
CONTENT_CONNECTION_STRING=mysql://root:password@localhost:3306/churchapps_content
GIVING_CONNECTION_STRING=mysql://root:password@localhost:3306/churchapps_giving
MESSAGING_CONNECTION_STRING=mysql://root:password@localhost:3306/churchapps_messaging
DOING_CONNECTION_STRING=mysql://root:password@localhost:3306/churchapps_doing
У производном окружењу, стрингови за повезивање се чувају у AWS SSM Parameter Store и при покретању их чита класа Environment.
Скрипте шеме
Шеме табела дефинисане су као Kysely миграције у директоријуму tools/migrations/, организоване по модулу:
tools/migrations/
├── membership/
├── attendance/
├── content/
├── giving/
├── messaging/
└── doing/
Миграције дефинишу креирање табела, индексе и измене шеме. Директоријум tools/dbScripts/ садржи демо и почетне податке које је могуће учитати преко шеме.
Иницијализација базе
Иницијализација свих база
npm run initdb
Ова команда креира све шест база и покреће миграције за сваку од њих.
Иницијализација једног модула
npm run initdb -- --module=membership
Када радите на одређеном модулу, можете поново иницијализовати само базу тог модула, без утицаја на остале.
Образац приступа подацима
Репозиторијуми граде упите помоћу Kysely градитеља упита над типизираном шемом базе модула, којој се приступа преко функције getDb() модула. Типична метода репозиторијума изгледа овако:
public async loadAll(churchId: string) {
return getDb().selectFrom("people").selectAll()
.where("churchId", "=", churchId)
.execute();
}
Репозиторијуми се добијају преко RepoManager-а:
const repos = await RepoManager.getRepos<Repos>("membership");
const people = await repos.person.loadAll(churchId);
Увек укључите churchId у упите да бисте задржали раздвајање података између цркава. Никада не упућујте упите преко граница цркава осим ако за то немате конкретан и овлашћен разлог.
Референце између модула
Пошто подаци сваког модула живе у посебној бази, не постоје страни кључеви нити SQL спојеви преко граница модула. Запис који се односи на податке другог модула чува идентификатор тог записа -- на пример, донација у бази giving садржи personId особе из базе membership -- а састављање података из више модула се одвија у коду апликације.
Ово ограничење чини границе модула стварним: свака шема може да се развија независно, база модула може да се премести на сопствени сервер, а модул би чак могао да се издвоји у самостални сервис без распетљавања дељених табела или упита између база.
Повезани чланци
- Структура модула -- Како су контролери и репозиторијуми организовани унутар сваког модула
- Подешавање локалног API-ја -- Потпун водич за подешавање корак по корак