# mORMot 2 Software Architecture Design

Foreword

About This Document

Document Purpose

The Software Architecture Design document describes the architecture, design patterns, and implementation guidelines for the Synopse mORMot 2 Framework. It serves as both a learning resource for new developers and a reference guide for experienced users.

This document has been adapted from the original mORMot 1.18 SAD to reflect the complete rewrite that is mORMot 2, including:

• New unit organization and naming
• Updated class names and APIs
• New features and capabilities
• Removed deprecated functionality

Document License

Synopse mORMot 2 Framework Documentation Copyright (C) 2008-2025 Arnaud Bouchez Synopse Informatique - https://synopse.info

The Synopse mORMot 2 Framework Source Code is licensed under GPL / LGPL / MPL licensing terms, free to be included in any application.

The Synopse mORMot 2 Framework Documentation is a free document, released under a GPL 3.0 License, distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Trademark Notice

Rather than indicating every occurrence of a trademarked name as such, this document uses the names only in an editorial fashion and to the benefit of the trademark owner with no intention of infringement of the trademark.

Resources

Table of Contents

Part I: Introduction and Core Concepts

Part II: Object-Relational Mapping

Part III: Database Access

Part IV: REST and Client-Server

Part V: Services and SOA

Part VI: Web Applications

Part VII: Security and Advanced Topics

Part VIII: Reference

What's New in mORMot 2

mORMot 2 is a complete rewrite of the framework. Key changes include:

Naming Changes

New Features

• OpenSSL Integration: Full OpenSSL 1.1/3.0 support for cryptography
• Async Servers: Non-blocking HTTP and WebSocket servers
• QuickJS Scripting: Modern JavaScript engine (replaces SpiderMonkey)
• Let's Encrypt: Automatic HTTPS certificate management
• libdeflate: Faster compression alternative
• Modern Syntax: Optional generics and enumerators

Deprecated Features

The following mORMot 1 features are not available in mORMot 2:

• RTTI-based UI Generation: mORMotUI, mORMotToolBar, mORMotUIEdit
• BigTable: Large binary storage
• LVCL: Light VCL replacement
• Kylix/CrossKylix: Linux via Kylix compiler
• Delphi 5-6: Minimum is now Delphi 7
• SpiderMonkey: Replaced by QuickJS
• SynFile Demo: No equivalent demo application

Quick Start

Installation Summary

1. Clone repository: git clone https://github.com/synopse/mORMot2.git 2. Download static files: Extract mormot2static.7z to static/ folder 3. Configure IDE: - Lazarus: Open packages/lazarus/mormot2.lpk - Delphi: Add library paths via $(mormot2) environment variable 4. Verify: Compile and run test/mormot2tests.dpr

First Steps

uses
  mormot.core.base,
  mormot.orm.core,
  mormot.rest.sqlite3;

type
  TOrmPerson = class(TOrm)
  private
    fName: RawUtf8;
    fAge: Integer;
  published
    property Name: RawUtf8 read fName write fName;
    property Age: Integer read fAge write fAge;
  end;

var
  Model: TOrmModel;
  Server: TRestServerDB;
  Person: TOrmPerson;
begin
  Model := TOrmModel.Create([TOrmPerson]);
  Server := TRestServerDB.Create(Model, 'test.db');
  try
    Server.CreateMissingTables;

    Person := TOrmPerson.Create;
    try
      Person.Name := 'John';
      Person.Age := 30;
      Server.Add(Person, true);
    finally
      Person.Free;
    end;
  finally
    Server.Free;
    Model.Free;
  end;
end.

Learning Path

For those new to mORMot 2, we recommend the following reading order:

1. Chapters 1-2: Understand the framework philosophy 2. Chapters 3-4: Learn the unit structure and core utilities 3. Chapters 5-6: Master the ORM layer 4. Chapters 10-12: Understand client-server architecture 5. Chapters 14-16: Explore service-oriented features 6. Chapter 26: Set up your development environment

Then, based on your needs:

• Database Integration: Chapters 7-9
• Web Development: Chapters 18-20
• Security: Chapter 21
• Advanced Patterns: Chapters 22-25

Sample Applications

The ex/ folder contains many examples:

Acknowledgments

• Arnaud Bouchez: Original framework author and architect
• All Contributors: See CONTRIBUTORS.md
• The Community: Forum members, bug reporters, and documentation contributors

Adopt a mORMot!

Continue to Chapter 1: mORMot 2 Overview

Navigation