DataEngine Framework for Delphi & Lazarus

🇬🇧 English
🇧🇷 Português

🇬🇧 English

DataEngine is a high-performance, modular, and extensible database engine abstraction framework for Delphi and Lazarus. It provides a robust, uniform interface layer that decouples applications from database-specific drivers, allowing developers to write database-agnostic code effortlessly. With native support for multi-tenant connection pooling, intelligent query monitoring, and advanced client-side caching, DataEngine is built for high-throughput enterprise systems, microservices, and SaaS applications.

🚀 Key Features

Database Engine Independence: Write code once and run it on any RDBMS. Abstract and switch between FireDAC, dbExpress, UniDAC, Zeos, and more.
Factory-Based DI: Inject specific engine implementations (e.g., FireDAC, UniDAC) into a unified IDBConnection interface.
Multi-tenant Connection Pooling: Efficiently manage high-concurrency connections with tenant isolation, custom eviction policies, and resource capping.
Observability & Query Metrics: Built-in high-precision execution monitoring to detect slow queries and track performance statistics.
Agnostic Client Caching & Snapshots: Minimize network latency using local disk-based or in-memory caches, with intelligent heuristics to auto-invalidate cache entries upon DML operations.

🏛 Compatibility Matrix

Environment / IDE	Platform / Compiler	Connection Pooling	Client Caching
Delphi XE or superior	VCL, FMX, Console (Win/Linux/macOS/iOS/Android)	✅ Yes	✅ Yes
Lazarus / FreePascal	LCL, Console (Cross-platform)	✅ Yes	✅ Yes

⚙️ Installation

To install using the package manager Boss:

boss install DBEngine4D

[!NOTE] For historical registry reasons on Boss, the package name is declared as DBEngine4D in its manifest, but the official framework name is DataEngine.

⚡️ Quick Start

1. Basic Connection Setup (FireDAC Factory)

uses
  DataEngine.Factory.FireDAC,
  DataEngine.Interfaces;

var
  FDBConnection: IDBConnection;
begin
  // Establish an engine-agnostic connection using the FireDAC factory
  FDBConnection := TFactoryFireDAC.Create(MyFDConnection, dnSQLite);
  FDBConnection.Connect;
end;

2. Fluent Query Execution

var
  LQuery: IDBQuery;
begin
  LQuery := FDBConnection.CreateQuery;
  try
    LQuery.CommandText := 'UPDATE users SET active = 1 WHERE id = :id';
    LQuery.ParamByName('id').AsInteger := 123;
    LQuery.ExecuteDirect;
  finally
    // Interfaces manage cleanup automatically via ARC
  end;
end;

3. Transaction Management

FDBConnection.StartTransaction;
try
  // Database operations
  FDBConnection.Commit;
except
  FDBConnection.Rollback;
  raise;
end;

4. Connection Pooling (Multi-tenant)

var
  LConn: IDBConnection;
begin
  LConn := PoolManager.AcquireConnection(
    'Tenant_A',
    function: IDBConnection
    begin
      Result := TFactoryFireDAC.Create(CreateNativeConn, dnPostgreSQL);
    end
  );
  try
    // Use your connection here
  finally
    PoolManager.ReleaseConnection('Tenant_A', LConn);
  end;
end;

🇧🇷 Português

DataEngine é um framework de alta performance, modular e extensível para abstração de motores de banco de dados em Delphi e Lazarus. Ele fornece uma camada de interface uniforme e robusta que desacopla a aplicação dos drivers de banco de dados específicos, permitindo que desenvolvedores criem softwares totalmente agnósticos a banco de dados de maneira simplificada. Projetado para sistemas corporativos, microsserviços e aplicações SaaS com alta carga, o DataEngine oferece pooling de conexões multi-tenant, monitoramento inteligente de consultas e cache avançado local.

🚀 Recursos Principais

Independência de Bancos de Dados: Escreva seu código uma vez e rode em qualquer SGBD. Abstraia drivers como FireDAC, dbExpress, UniDAC, Zeos e outros.
Injeção via Factory Pattern: Injete implementações específicas (como FireDAC ou UniDAC) sob uma única interface unificada IDBConnection.
Pooling de Conexões Multi-tenant: Gerencie eficientemente centenas de conexões simultâneas com isolamento estrito de tenants e limpeza ativa de recursos ociosos.
Observabilidade e Métricas de Consulta: Rastreamento estruturado de tempo de execução com hooks automáticos para registrar slow queries e coletar estatísticas de execução.
Cache e Snapshots Agnósticos: Reduza a latência de rede salvando dados localmente em disco ou memória, com invalidação heurística automática durante operações DML.

🏛 Matriz de Compatibilidade

Ambiente / IDE	Plataforma / Compilador	Pooling de Conexões	Cache Local
Delphi XE ou superior	VCL, FMX, Console (Win/Linux/macOS/iOS/Android)	✅ Sim	✅ Sim
Lazarus / FreePascal	LCL, Console (Multiplataforma)	✅ Sim	✅ Sim

⚙️ Instalação

Para instalar usando o gerenciador de pacotes Boss:

boss install DBEngine4D

[!NOTE] Por motivos históricos de registro no Boss, o pacote é declarado como DBEngine4D no manifesto, embora o nome oficial do projeto seja DataEngine.

⚡️ Início Rápido

1. Conexão Básica (Factory do FireDAC)

uses
  DataEngine.Factory.FireDAC,
  DataEngine.Interfaces;

var
  FDBConnection: IDBConnection;
begin
  // Estabelece uma conexão agnóstica a banco usando o factory do FireDAC
  FDBConnection := TFactoryFireDAC.Create(MyFDConnection, dnSQLite);
  FDBConnection.Connect;
end;

2. Execução Direta de Consulta

var
  LQuery: IDBQuery;
begin
  LQuery := FDBConnection.CreateQuery;
  try
    LQuery.CommandText := 'UPDATE users SET active = 1 WHERE id = :id';
    LQuery.ParamByName('id').AsInteger := 123;
    LQuery.ExecuteDirect;
  finally
    // As interfaces gerenciam a destruição automática do recurso via ARC
  end;
end;

3. Controle de Transações

FDBConnection.StartTransaction;
try
  // Suas operações de banco de dados
  FDBConnection.Commit;
except
  FDBConnection.Rollback;
  raise;
end;

4. Pool de Conexões Multi-tenant

var
  LConn: IDBConnection;
begin
  LConn := PoolManager.AcquireConnection(
    'Tenant_A',
    function: IDBConnection
    begin
      Result := TFactoryFireDAC.Create(CreateNativeConn, dnPostgreSQL);
    end
  );
  try
    // Use a conexão adquirida do pool
  finally
    PoolManager.ReleaseConnection('Tenant_A', LConn);
  end;
end;