crud-layer

Airweave CRUD Layer Architecture

Overview

The CRUD layer provides a consistent interface for database operations across all models in Airweave. It implements a sophisticated inheritance hierarchy that enforces proper access control, transaction management, and audit tracking.

Inheritance Hierarchy

Base Classes

1. CRUDBaseOrganization (_base_organization.py)

• Purpose: For resources scoped to organizations (most common pattern)
• Key Features:
  • Enforces organization-level access control via BaseContext
  • Tracks user modifications with created_by_email and modified_by_email
  • Validates organization access on every operation
  • Supports both user and API key authentication contexts
  • Logger access via ctx.logger for contextual logging

2. CRUDBaseUser (_base_user.py)

• Purpose: For pure user-level data (e.g., user profiles)
• Key Features:
  • Enforces strict user-level access (can only access own data)
  • No organization scoping
  • Simpler permission model - user can only CRUD their own resources

3. CRUDPublic (_base_public.py)

• Purpose: For system-wide public resources (e.g., sources, destinations, embedding models)
• Key Features:
  • No access control - publicly accessible
  • Often used for system configuration data
  • Supports filtering by organization for multi-tenant scenarios
  • Includes sync() method for bulk updates

Core Concepts

BaseContext

The BaseContext (from core.context) is the universal context type for the CRUD layer. ApiContext and SyncContext both inherit from it:

@dataclass
class BaseContext:
    organization: schemas.Organization  # Always present
    user: Optional[schemas.User] = None # Present for user auth, None for API keys/system
    logger: ContextualLogger            # Auto-derived from org/user if not provided

Key Properties:

• has_user_context: True if user is present (Auth0 or system with user)
• tracking_email: Returns user email for audit tracking
• user_id: Returns user UUID if available
• has_feature(flag): Check organization feature flags
• logger: Contextual logger (auto-derived from identity, overridable)