Multi-Tenancy Pattern — Isolated Data Per Customer

In this tutorial, you'll learn how the Multi-Tenancy pattern isolates customer data in shared or dedicated database schemas.

What You'll Learn

how the Multi-Tenancy pattern isolates customer data in shared or dedicated database schemas.

Why It Matters

SaaS applications serve multiple customers. Multi-tenancy ensures data isolation and fair resource usage.

Real-World Use

Database per tenant, schema per tenant, or shared schema with tenant_id column.

The Multi-Tenancy Pattern

The Multi-Tenancy pattern addresses a specific recurring design problem by providing a reusable solution structure. Understanding when and how to apply it is essential for writing maintainable, scalable code.

Key Concepts

• Registry/Tracking: Multi-Tenancy maintains a registry of objects or operations.
• Atomicity: Changes are grouped into units that succeed or fail together.
• Isolation: Each unit operates independently.
• Consistency: The pattern ensures data integrity across operations.

Structure

The following diagram shows the structure of this pattern:

classDiagram
    class MultiTenancy {
        +findById()
        +findAll()
        +save()
        +delete()
    }
    class Database { +query() }
    Client --> MultiTenancy
    MultiTenancy --> Database

Implementation

from typing import List
from dataclasses import dataclass

@dataclass
class Migration:
    version: int
    name: str
    sql: str

class MultiTenancy:
    def __init__(self):
        self._migrations: List[Migration] = []
        self._applied: set = set()

    def register(self, m: Migration):
        self._migrations.append(m)

    def migrate(self):
        for m in sorted(self._migrations, key=lambda x: x.version):
            if m.version not in self._applied:
                print(f"Applying v{m.version}: {m.name}")
                print(f"  SQL: {m.sql}")
                self._applied.add(m.version)

    def rollback(self, version: int):
        if version in self._applied:
            print(f"Rolling back v{version}")
            self._applied.remove(version)

migrator = MultiTenancy()
migrator.register(Migration(1, "Create users", "CREATE TABLE users (...)"))
migrator.register(Migration(2, "Add email", "ALTER TABLE users ADD email TEXT"))
migrator.migrate()
print("---")
migrator.rollback(1)

Expected output:

Applying v1: Create users
  SQL: CREATE TABLE users (...)
Applying v2: Add email
  SQL: ALTER TABLE users ADD email TEXT
---
Rolling back v1

Key Participants

• Multi-Tenancy: Coordinates tracking and persistence of changes.
• Entity: The domain object being tracked.
• Client: Code that uses the Multi-Tenancy.
• Data Mapper: Handles actual database operations.

Real-World Examples

• DodaTech uses this pattern internally for consistent cross-cutting concerns.
• Major frameworks and libraries implement this pattern as a core architectural element.
• Production systems at scale depend on this pattern for reliability.

Related Patterns

• Sharding

• Saas Pattern

• Repository

• Design Patterns — the complete patterns catalog.

Pros and Cons

Common Mistakes

1. **Over-engineering: Applying Multi-Tenancy where a simpler solution suffices, adding unnecessary complexity.

2. **Wrong granularity: Implementing Multi-Tenancy at the wrong level of abstraction.

3. **Thread Safety ignored: Using Multi-Tenancy in concurrent context without proper synchronization.

4. **Tight coupling: Violating the pattern intent by creating hidden dependencies.

5. **Premature optimization: Introducing Multi-Tenancy before there is evidence it is needed.

Practice Questions

1. What problem does the Multi-Tenancy pattern solve? Describe a real-world scenario where using it improves code quality.

2. How does Multi-Tenancy differ from alternative approaches? What are the trade-offs?

3. What testing Strategy would you use for code that implements Multi-Tenancy?

4. How would you refactor legacy code to introduce Multi-Tenancy?

5. When should you NOT use Multi-Tenancy? Describe scenarios where it adds unnecessary complexity.

Challenge

Implement a complete Multi-Tenancy example in Python with unit tests. Include error handling, edge cases (empty data, null values, concurrent access), and a performance comparison against a simpler alternative. Document your design decisions.

Real-World Task

Find a section of code in your current project that could benefit from the Multi-Tenancy pattern. Refactor it, write tests, and measure the improvement in testability, coupling, and cohesion.

Security Tip: When implementing Multi-Tenancy, ensure proper input validation, avoid exposing internal state, and follow Least Privilege. At DodaTech, all implementations undergo security review.

Built by the developers of Doda Browser, DodaZIP, and Durga Antivirus Pro.