Implexus/Architecture

Implexus Architecture Documentation

A path-based document database library and engine for Vala.

Document Index

Document	Description
01-Overview	High-level description, goals, and design principles
02-Namespaces	Namespace organization and module structure
03-Core-Interfaces	Entity, EntityType, Storage, and Engine interfaces
04-Class-Hierarchy	Class diagrams and inheritance relationships
05-Path-System	Path parsing, resolution, and management
06-Entity-Types	Container, Document, Category, and Index implementations
07-Storage-Layer	DBM abstraction and binary serialization format
08-Set-Operations	Set operations API for entity children
09-Client-Server-Protocol	TCP protocol design for remote mode
10-File-Organization	Source file map and project structure

Quick Start

Implexus is a document database that organizes data using path-based identification, similar to a filesystem. It supports:

• Embedded mode: Library runs in-process
• Client/Server mode: Daemon over TCP with identical API

Dependencies

• GLib 2.0
• GObject 2.0
• Invercargill-1 (collections, expressions, Element types)

Architecture Overview

┌─────────────────────────────────────────────────────────────┐
│                      Application                             │
└─────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────┐
│                     Engine Interface                         │
│  ┌─────────────────────┐  ┌─────────────────────────────┐   │
│  │   EmbeddedEngine    │  │      RemoteEngine           │   │
│  └─────────────────────┘  └─────────────────────────────┘   │
└─────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────┐
│                    Entity System                             │
│  ┌──────────┐ ┌──────────┐ ┌───────────┐ ┌──────────────┐  │
│  │ Container │ │ Document │ │ Category │ │    Index     │  │
│  └──────────┘ └──────────┘ └───────────┘ └──────────────┘  │
└─────────────────────────────────────────────────────────────┘
                              │
                              ▼
┌─────────────────────────────────────────────────────────────┐
│                    Storage Layer                             │
│  ┌─────────────────────┐  ┌─────────────────────────────┐   │
│  │   Storage Interface │  │    Binary Serialization     │   │
│  └─────────────────────┘  └─────────────────────────────┘   │
│  ┌─────────────────────┐                                    │
│  │   DBM Interface     │                                    │
│  └─────────────────────┘                                    │
└─────────────────────────────────────────────────────────────┘