Chuyển tới nội dung chính

Public API Reference

This compact map lists the supported top-level imports in Fluvius 1.2. Prefer these imports over private module paths.

Domain​

from fluvius.domain import (
    Aggregate, Command, CommandBundle, CommandState,
    Domain, DomainContext, DomainResponse, Event,
    MessageBundle, MessageDispatcher,
    SQLDomainLogStore, StateManager, data_query,
)
from fluvius.domain.aggregate import action

Domain subclasses configure __namespace__, __aggregate__, __statemgr__, __logstore__, and optionally policy, event, and message handlers. Define commands by subclassing YourDomain.Command.

Data​

from fluvius.data import (
    BackendQuery, DataAccessManager, DataModel, Field,
    ReadonlyDataManagerProxy, SqlaDataSchema, SqlaDriver,
    StructModel, UUID_GENR, UUID_TYPE,
    data_query, item_query, list_query, value_query,
)

DataAccessManager operates on registered schema models through a SqlaDriver. Mutating manager calls are asynchronous and should run inside async with manager.transaction().

FastAPI​

from fluvius.fastapi import (
    app_lifespan, auth_required, configure_authentication,
    configure_domain_manager, configure_media,
    configure_query_manager, create_app, on_shutdown, on_startup,
)

The configurators are pipe.Pipe objects: create_app(pkginfo) | configure_authentication(...).

Query​

from fluvius.query import (
    DomainQueryManager, DomainQueryResource, Field, Filter,
    FilterPreset, FrontendQuery, QueryManager, QueryParams,
    QueryResource, ReportResource, endpoint,
)

Work queue​

from fluvius.workq import (
    DomainWorkqClient, DomainWorkqService, WorkqClientProxy,
    WorkqHandle, WorkqResultBackend, WorkqService, WorkqTaskScope,
)

The old fluvius.worker package contains compatibility aliases only. New code should import from fluvius.workq.

MCP and transport​

from fluvius.mcp import configure_mcp_server, create_mcp_token
from fluvius.transport import (
    RTCBridge, ServiceTransport, TransportCodec,
    configure_rtc_bridge, configure_svc_transport,
)

Forms and workflows​

from fluvius.dform import FormDomain, FormModel, FormConnector, setup_dform
from fluvius.navis import Workflow, Stage, Step, transition, WorkflowManager

For exact signatures, inspect the installed version with help() or the linked source; stable imports are declared in each package's __all__.