orm-modules

name: orm-modules description: ORM client for the modules API — provides typed CRUD operations for 59 tables and 12 custom operations

ORM client for the modules API — provides typed CRUD operations for 59 tables and 12 custom operations

Usage

// Import the ORM client
import { db } from './orm';

// Available models: defaultIdsModule, membershipTypesModule, userStateModule, sessionSecretsModule, configSecretsOrgModule, devicesModule, i18NModule, userCredentialsModule, ...
db.<model>.findMany({ select: { id: true } }).execute()
db.<model>.findOne({ id: '<UUID>', select: { id: true } }).execute()
db.<model>.create({ data: { ... }, select: { id: true } }).execute()
db.<model>.update({ where: { id: '<UUID>' }, data: { ... }, select: { id: true } }).execute()
db.<model>.delete({ where: { id: '<UUID>' } }).execute()

Examples

Query records

const items = await db.defaultIdsModule.findMany({
  select: { id: true }
}).execute();

References

See the references/ directory for detailed per-entity API documentation: