Skip to content

Deployment

octomate_protocol.deployment

The backup record exchanged between the CLI and server maintenance process.

DatabaseBackup pydantic-model

Bases: BaseModel

The database path and the snapshot taken of it before an update.

Fields:

Source code in protocol/octomate_protocol/deployment.py
class DatabaseBackup(BaseModel):
    """The database path and the snapshot taken of it before an update."""

    database: Path = Field(
        description="Absolute database path resolved before the update."
    )
    backup: Path | None = Field(
        description="Consistent snapshot; absent for a new database."
    )

database pydantic-field

database: Path

Absolute database path resolved before the update.

backup pydantic-field

backup: Path | None

Consistent snapshot; absent for a new database.