Miscellaneous

initialize_database(; file_name::String="deardiary.db")

Open file_name (creating it if needed), run every pending Migration via apply_migrations, and re-seed the default user. Safe to call repeatedly: each migration runs at most once per database, and the default-user INSERT OR IGNORE is a no-op when the row already exists.

get_database()::Union{SQLite.DB,Nothing}

Returns a SQLite database connection. If the database has not been initialized, it returns nothing.

Returns

A SQLite.DB object, or nothing if the database is not initialized.

close_database()

Closes the database connection if it is open.

@enum ExperimentStatus IN_PROGRESS = 1 STOPPED = 2 FINISHED = 3

An enumeration representing the lifecycle status of an Experiment.

IN_PROGRESS::ExperimentStatus

An enumeration value representing an experiment that is currently in progress.

STOPPED::ExperimentStatus

An enumeration value representing an experiment that has been stopped.

FINISHED::ExperimentStatus

An enumeration value representing an experiment that has finished.

@enum IterationStatus RUNNING = 1 SUCCEEDED = 2 FAILED = 3 KILLED = 4

An enumeration representing the lifecycle status of an Iteration. A freshly created iteration is RUNNING; the value transitions to a terminal status (SUCCEEDED, FAILED, or KILLED) when the iteration ends.

RUNNING::IterationStatus

An enumeration value representing an Iteration that is still in progress. This is the value assigned when the iteration is created.

SUCCEEDED::IterationStatus

An enumeration value representing an Iteration that ran to completion without raising an exception.

FAILED::IterationStatus

An enumeration value representing an Iteration that ended because of an exception. The captured exception text is stored in error_message.

KILLED::IterationStatus

An enumeration value representing an Iteration that was terminated externally (operator action, timeout, scheduler kill) rather than by a clean return or an exception.

UpsertResult

A marker abstract type for the result of an upsert operation.

Created

A marker type indicating that a record was successfully created.

Updated <: UpsertResult

A marker type indicating that a record was successfully updated.

Duplicate <: UpsertResult

A marker type indicating that a record already exists.

Unprocessable <: UpsertResult

A marker type indicating that a record violates a constraint and cannot be processed.

Error <: UpsertResult

A marker type indicating that an error occurred while creating or updating a record.

PermissionAction

Abstract supertype representing a CRUD action that a UserPermission can grant on a Project. Concrete subtypes are dispatched on by has_permission to read the matching boolean field.

CreatePermission <: PermissionAction

Action that requires create_permission on the target Project.

ReadPermission <: PermissionAction

Action that requires read_permission on the target Project.

UpdatePermission <: PermissionAction

Action that requires update_permission on the target Project.

DeletePermission <: PermissionAction

Action that requires delete_permission on the target Project.

ErrorCode

Marker abstract type for error codes returned in non-2xx response bodies.

Concrete subtypes pair with error_code to produce a stable, frontend-facing identifier (e.g., "NOT_FOUND", "PROJECT_PERMISSION_REQUIRED") that callers can switch on without parsing English messages.

NotFound <: ErrorCode

The requested entity does not exist. Pairs with HTTP 404 Not Found.

InvalidCredentials <: ErrorCode

The supplied username/password did not authenticate. Pairs with HTTP 401 Unauthorized.

TokenMissing <: ErrorCode

The request did not include an Authorization header. Pairs with HTTP 401 Unauthorized.

TokenInvalid <: ErrorCode

The bearer token failed signature validation. Pairs with HTTP 401 Unauthorized.

TokenExpired <: ErrorCode

The bearer token's exp claim is in the past. Pairs with HTTP 401 Unauthorized.

TokenPayloadInvalid <: ErrorCode

The bearer token decoded but its claims are missing or malformed. Pairs with HTTP 401.

UserNotFound <: ErrorCode

The user identified by the credentials or token does not exist. Pairs with HTTP 401/404 depending on context.

AdminRequired <: ErrorCode

The route requires administrative privileges. Pairs with HTTP 403 Forbidden.

SameUserRequired <: ErrorCode

The route can only be accessed by the targeted user (or an admin). Pairs with HTTP 403.

ProjectPermissionRequired <: ErrorCode

The user lacks the required CRUD permission on the project that scopes the route. Pairs with HTTP 403 Forbidden.

Conflict <: ErrorCode

A unique-constraint violation: the resource already exists. Pairs with HTTP 409 Conflict.

InvalidPayload <: ErrorCode

The request payload violates a constraint (foreign key, check, missing field). Pairs with HTTP 422 Unprocessable Entity.

ServerError <: ErrorCode

Generic catch-all for unexpected failures. Pairs with HTTP 500 Internal Server Error.

Pagination

Cursor for windowing a collection of records.

Fields

• limit::Int64: Maximum number of records to return (capped at the route boundary).
• offset::Int64: Number of records to skip before the page starts.

PaginatedResponse{T} <: ResultType

Envelope returned by paginated list endpoints.

Fields

• data::Array{T,1}: The records in this page.
• total::Int64: Total number of matching records (across all pages).
• limit::Int64: The page size used.
• offset::Int64: The offset used.