db

package
v0.64.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 20, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdminWorkspaceInfo added in v0.18.3 

type AdminWorkspaceInfo struct {
	Workspace
	OwnerID      *string
	OwnerEmail   *string
	OwnerName    *string
	OwnerPicture *string
	SandboxCount int
}

AdminWorkspaceInfo holds enriched workspace data for the admin panel.

type AgentCard added in v0.30.0 

type AgentCard struct {
	SandboxID   string
	WorkspaceID string
	AgentType   string
	DisplayName string
	Description string
	CardJSON    json.RawMessage
	AgentStatus string
	Version     int
	UpdatedAt   time.Time
}

AgentCard stores an agent's capability declaration.

type AgentInfo added in v0.16.0 

type AgentInfo struct {
	SandboxID       string          `json:"sandbox_id"`
	Hostname        string          `json:"hostname"`
	OS              string          `json:"os"`
	Platform        string          `json:"platform"`
	PlatformVersion string          `json:"platform_version"`
	KernelArch      string          `json:"kernel_arch"`
	CPUModelName    string          `json:"cpu_model_name"`
	CPUCountLogical int             `json:"cpu_count_logical"`
	MemoryTotal     int64           `json:"memory_total"`
	DiskTotal       int64           `json:"disk_total"`
	DiskFree        int64           `json:"disk_free"`
	AgentVersion    string          `json:"agent_version"`
	OpencodeVersion string          `json:"opencode_version"`
	Workdir         string          `json:"workdir"`
	HostInfo        json.RawMessage `json:"host_info"`
	CPUInfo         json.RawMessage `json:"cpu_info"`
	MemoryInfo      json.RawMessage `json:"memory_info"`
	DiskInfo        json.RawMessage `json:"disk_info"`
	Capabilities    json.RawMessage `json:"capabilities"`
	UpdatedAt       time.Time       `json:"updated_at"`
}

AgentInfo holds system information reported by a local agent.

type AgentInteraction added in v0.36.0 

type AgentInteraction struct {
	ID          int64
	WorkspaceID string
	ActorID     *string
	Action      string // "task_created", "task_status_changed", "task_cancelled", "message_sent"
	TargetID    string
	TargetType  string // "task" or "message"
	DetailJSON  json.RawMessage
	CreatedAt   time.Time
}

AgentInteraction is an audit trail entry for multi-agent activity.

type AgentMessage added in v0.36.0 

type AgentMessage struct {
	ID          string
	WorkspaceID string
	FromID      string
	ToID        string
	Text        string
	MsgType     string
	CreatedAt   time.Time
	ReadAt      sql.NullTime
}

AgentMessage represents a mailbox message between agents.

type AgentRegistrationCode 

type AgentRegistrationCode struct {
	Code        string
	UserID      string
	WorkspaceID string
	CreatedAt   time.Time
	ExpiresAt   time.Time
	Used        bool
}

type AgentSession added in v0.30.0 

type AgentSession struct {
	ID          string
	SandboxID   *string
	WorkspaceID string
	Title       string
	Status      string
	Epoch       int
	Tags        []string
	IMChannelID *string // set when session is created from an IM inbound message
	CreatedAt   time.Time
	UpdatedAt   time.Time
	ArchivedAt  sql.NullTime
	// TUI fields (added in migration 021)
	ChannelType         string
	CreatorUserID       *string // NULL for legacy IM rows
	PreferredModel      *string
	PermissionMode      string
	PreferredExecutorID *string
	PermissionResponder *string
	ResponderAttachedAt *time.Time
	ActiveTurnID        *string
	CodexThreadID       *string `json:"codex_thread_id,omitempty"`
}

AgentSession represents a bridge session.

type AgentSessionEvent added in v0.30.0 

type AgentSessionEvent struct {
	ID        int64 // sequence_num (BIGSERIAL)
	SessionID string
	EventID   string
	EventType string
	Source    string
	Epoch     int
	Payload   json.RawMessage
	Ephemeral bool
	CreatedAt time.Time
}

AgentSessionEvent is a single event in a session's event log.

type AgentSessionWorker added in v0.30.0 

type AgentSessionWorker struct {
	SessionID             string
	Epoch                 int
	State                 string
	ExternalMetadata      json.RawMessage
	RequiresActionDetails json.RawMessage
	LastHeartbeatAt       time.Time
	RegisteredAt          time.Time
}

AgentSessionWorker tracks worker state per epoch.

type AgentTask added in v0.30.0 

type AgentTask struct {
	ID              string
	WorkspaceID     string
	RequesterID     sql.NullString
	TargetID        string
	SessionID       sql.NullString
	Skill           sql.NullString
	Prompt          string
	SystemContext   sql.NullString
	Status          string
	ResultJSON      *json.RawMessage
	FailureReason   sql.NullString
	TimeoutSeconds  int
	DelegationChain []string
	TotalCostUSD    *float64
	NumTurns        int
	CreatedAt       time.Time
	AcceptedAt      sql.NullTime
	CompletedAt     sql.NullTime
}

AgentTask represents a delegated task.

type AttachResult added in v0.47.0 

type AttachResult struct {
	PreviousResponder string
	PreviousPreferred string
}

AttachResult holds the previous responder/preferred state before an AttachResponder call.

type CodexBrowserSession added in v0.62.3 

type CodexBrowserSession struct {
	ID             string
	TokenID        string
	ClientIP       string
	ClientUA       string
	CodexVersion   string
	OS             string
	ConnectedAt    time.Time
	DisconnectedAt *time.Time
}

CodexBrowserSession is a single live (or historical) `codex --remote` ws connection. The row is inserted by CXG on ws accept and stamped with disconnected_at on ws close. Multiple concurrent rows per token_id are supported — a token can be used from N machines simultaneously.

type CodexToken added in v0.50.7 

type CodexToken struct {
	ID          string
	UserID      string
	WorkspaceID string
	Name        string
	TokenHash   string
	CreatedAt   time.Time
	ExpiresAt   time.Time
	LastUsedAt  *time.Time
	RevokedAt   *time.Time
}

CodexToken is one row from codex_remote_tokens.

type CreateTUISessionParams added in v0.47.0 

type CreateTUISessionParams struct {
	ID                  string
	WorkspaceID         string
	ExternalID          string
	Title               string
	CreatorUserID       string
	PermissionMode      string
	PreferredExecutorID string
	PreferredModel      string
}

CreateTUISessionParams holds parameters for creating a TUI-originated session.

type CredentialBinding added in v0.36.0 

type CredentialBinding struct {
	ID          string
	WorkspaceID string
	Kind        string
	DisplayName string
	ServerURL   string
	PublicMeta  json.RawMessage
	AuthType    string
	AuthBlob    []byte
	IsDefault   bool
	CreatedAt   time.Time
	UpdatedAt   time.Time
}

CredentialBinding represents a row in the credential_bindings table.

type CredentialBindingMeta added in v0.36.0 

type CredentialBindingMeta struct {
	ID          string
	WorkspaceID string
	Kind        string
	DisplayName string
	ServerURL   string
	PublicMeta  json.RawMessage
	AuthType    string
	IsDefault   bool
	CreatedAt   time.Time
	UpdatedAt   time.Time
}

CredentialBindingMeta is a credential binding without the encrypted auth blob.

type DB 

type DB struct {
	*sql.DB
}

DB wraps a *sql.DB with migration support.

func Open 

func Open(databaseURL string) (*DB, error)

Open connects to PostgreSQL and runs migrations.

func (*DB) AddWorkspaceMember 

func (db *DB) AddWorkspaceMember(workspaceID, userID, role string) error

func (*DB) AddWorkspaceVolume added in v0.9.0 

func (db *DB) AddWorkspaceVolume(id, workspaceID, pvcName, mountPath string) error

func (*DB) ArchiveAgentSession added in v0.30.0 

func (db *DB) ArchiveAgentSession(id string) error

func (*DB) AttachResponder added in v0.47.0 

func (db *DB) AttachResponder(ctx context.Context, sessionID, executorID string, becomePreferred bool) (AttachResult, error)

AttachResponder sets permission_responder (and optionally preferred_executor_id) for a session. Returns the previous values before the update. Uses a single CTE-based statement to avoid a SELECT-then-UPDATE race when two callers attach concurrently.

func (*DB) BindSandboxToChannel added in v0.27.0 

func (db *DB) BindSandboxToChannel(sandboxID, channelID string) error

BindSandboxToChannel binds a sandbox to a workspace IM channel. Any other sandbox previously bound to this channel is unbound first.

func (*DB) BumpAgentSessionEpoch added in v0.30.0 

func (db *DB) BumpAgentSessionEpoch(id string) (int, error)

BumpAgentSessionEpoch atomically increments the epoch and returns the new value.

func (*DB) ClaimActiveTurn added in v0.47.0 

func (db *DB) ClaimActiveTurn(ctx context.Context, sessionID, turnID string) (bool, error)

ClaimActiveTurn atomically sets active_turn_id if no turn is currently active. Returns (true, nil) if the claim succeeded, (false, nil) if another turn is active.

func (*DB) ClearActiveTurn added in v0.47.0 

func (db *DB) ClearActiveTurn(ctx context.Context, sessionID, expectedTurnID string) error

ClearActiveTurn clears active_turn_id only if it matches expectedTurnID (CAS).

func (*DB) ClearResponder added in v0.47.0 

func (db *DB) ClearResponder(ctx context.Context, sessionID string) error

ClearResponder clears permission_responder and responder_attached_at for a session.

func (*DB) CloseCodexBrowserSession added in v0.62.3 

func (db *DB) CloseCodexBrowserSession(ctx context.Context, id string) error

CloseCodexBrowserSession stamps disconnected_at. Idempotent: a missing or already-closed row is a no-op.

func (*DB) ConsumeAgentRegistrationCode 

func (db *DB) ConsumeAgentRegistrationCode(code string) (*AgentRegistrationCode, error)

ConsumeAgentRegistrationCode atomically validates and marks a code as used. Returns the code record if valid, nil if not found/expired/used.

func (*DB) CountCredentialBindings added in v0.36.0 

func (db *DB) CountCredentialBindings(workspaceID, kind string) (int, error)

func (*DB) CountOpenCodexBrowserSessions added in v0.62.3 

func (db *DB) CountOpenCodexBrowserSessions(ctx context.Context, tokenID string) (int, error)

CountOpenCodexBrowserSessions returns the number of open (disconnected_at IS NULL) sessions for a token. Used by the Browsers list endpoint to set is_online without iterating all rows.

func (*DB) CountSandboxesByWorkspace added in v0.7.0 

func (db *DB) CountSandboxesByWorkspace(workspaceID string) (int, error)

func (*DB) CountUsers added in v0.6.1 

func (db *DB) CountUsers() (int, error)

func (*DB) CountWorkspacesOwnedByUser added in v0.7.0 

func (db *DB) CountWorkspacesOwnedByUser(userID string) (int, error)

func (*DB) CreateAgentRegistrationCode 

func (db *DB) CreateAgentRegistrationCode(code, userID, workspaceID string, expiresAt time.Time) error

CreateAgentRegistrationCode inserts a new one-time registration code.

func (*DB) CreateAgentSession added in v0.30.0 

func (db *DB) CreateAgentSession(id string, sandboxID *string, workspaceID, title string, tags []string) error

func (*DB) CreateAgentSessionTUI added in v0.47.0 

func (db *DB) CreateAgentSessionTUI(ctx context.Context, p CreateTUISessionParams) error

CreateAgentSessionTUI creates a new session with channel_type='tui'.

func (*DB) CreateAgentTask added in v0.30.0 

func (db *DB) CreateAgentTask(t *AgentTask) error

func (*DB) CreateCodexBrowserSession added in v0.62.3 

func (db *DB) CreateCodexBrowserSession(ctx context.Context, s CodexBrowserSession) error

CreateCodexBrowserSession inserts a new session row. The caller supplies the id (cryptographic random, namespaced separately from token ids so a leaked session id can't be confused with a token).

func (*DB) CreateCodexToken added in v0.50.7 

func (db *DB) CreateCodexToken(ctx context.Context, t CodexToken) error

CreateCodexToken inserts a new row. Caller mints the bcrypt hash.

func (*DB) CreateCredentialBinding added in v0.36.0 

func (db *DB) CreateCredentialBinding(b *CredentialBinding) error

func (*DB) CreateIMBinding added in v0.27.0 

func (db *DB) CreateIMBinding(sandboxID, provider, botID, userID string) error

CreateIMBinding inserts or updates an IM binding record. On conflict (same sandbox+provider+bot), updates user_id and bound_at.

func (*DB) CreateIMChannel added in v0.27.0 

func (db *DB) CreateIMChannel(workspaceID, provider, botID, userID string) (string, error)

CreateIMChannel inserts or updates a workspace IM channel record. On conflict (same workspace+provider+bot), updates bound_at. Returns the channel ID.

func (*DB) CreateLocalSandbox 

func (db *DB) CreateLocalSandbox(id, workspaceID, name, sandboxType, opencodeToken, proxyToken, tunnelToken, shortID string) error

CreateLocalSandbox inserts a local agent sandbox with is_local=true.

func (*DB) CreateOIDCIdentity 

func (db *DB) CreateOIDCIdentity(provider, subject, userID string, email *string) error

func (*DB) CreateSandbox 

func (db *DB) CreateSandbox(id, workspaceID, name, sandboxType, sandboxName, opencodeToken, proxyToken, openclawToken, shortID string, cpu int, memory int64, idleTimeout *int, metadata json.RawMessage) error

func (*DB) CreateSandboxProxyToken added in v0.47.0 

func (db *DB) CreateSandboxProxyToken(token, sandboxID, workspaceID string) error

CreateSandboxProxyToken inserts a sandbox-scoped row into proxy_tokens. CreateSandbox / CreateLocalSandbox call this in the same DB session as the sandbox INSERT so the two tables stay in lockstep.

func (*DB) CreateToken 

func (db *DB) CreateToken(token, userID string, expiresAt time.Time) error

func (*DB) CreateUser 

func (db *DB) CreateUser(id, email, passwordHash string) error

func (*DB) CreateUserWithEmail 

func (db *DB) CreateUserWithEmail(id string, passwordHash *string, email string) error

func (*DB) CreateWorkspace 

func (db *DB) CreateWorkspace(id, name string) error

func (*DB) DeleteAgentCard added in v0.30.0 

func (db *DB) DeleteAgentCard(sandboxID string) error

func (*DB) DeleteCredentialBinding added in v0.36.0 

func (db *DB) DeleteCredentialBinding(id string) error

func (*DB) DeleteExpiredTokens 

func (db *DB) DeleteExpiredTokens() error

func (*DB) DeleteIMBinding added in v0.27.0 

func (db *DB) DeleteIMBinding(sandboxID, provider, botID string) error

DeleteIMBinding deletes an IM binding by sandbox, provider, and bot ID.

func (*DB) DeleteIMChannel added in v0.27.0 

func (db *DB) DeleteIMChannel(channelID string) error

DeleteIMChannel deletes a workspace IM channel by ID.

func (*DB) DeleteModelserverConnection added in v0.22.0 

func (db *DB) DeleteModelserverConnection(workspaceID string) error

func (*DB) DeleteSandbox 

func (db *DB) DeleteSandbox(id string) error

func (*DB) DeleteUserQuota added in v0.7.0 

func (db *DB) DeleteUserQuota(userID string) error

func (*DB) DeleteWorkspace 

func (db *DB) DeleteWorkspace(id string) error

func (*DB) DeleteWorkspaceLLMConfig added in v0.22.0 

func (db *DB) DeleteWorkspaceLLMConfig(workspaceID string) error

func (*DB) DeleteWorkspaceQuota added in v0.9.0 

func (db *DB) DeleteWorkspaceQuota(workspaceID string) error

func (*DB) FailAgentTask added in v0.30.0 

func (db *DB) FailAgentTask(id, reason string) error

func (*DB) GetActiveBindings added in v0.27.0 

func (db *DB) GetActiveBindings(provider string) ([]*IMBinding, error)

GetActiveBindings returns all bindings with credentials for a given provider, filtered to sandboxes of type 'nanoclaw' with status 'running'.

func (*DB) GetActiveBindingsForSandbox added in v0.27.0 

func (db *DB) GetActiveBindingsForSandbox(sandboxID string) ([]*IMBinding, error)

GetActiveBindingsForSandbox returns all bindings with credentials for a specific sandbox.

func (*DB) GetActiveTurn added in v0.47.0 

func (db *DB) GetActiveTurn(ctx context.Context, sessionID string) (string, error)

GetActiveTurn returns the current active_turn_id for a session, or "" if none. A missing session is treated the same as no active turn (no error returned).

func (*DB) GetAgentCard added in v0.30.0 

func (db *DB) GetAgentCard(sandboxID string) (*AgentCard, error)

func (*DB) GetAgentInfo added in v0.16.0 

func (db *DB) GetAgentInfo(sandboxID string) (*AgentInfo, error)

GetAgentInfo returns agent info for a sandbox, or nil,nil if not found.

func (*DB) GetAgentSession added in v0.30.0 

func (db *DB) GetAgentSession(id string) (*AgentSession, error)

func (*DB) GetAgentSessionEpoch added in v0.30.0 

func (db *DB) GetAgentSessionEpoch(id string) (int, error)

GetAgentSessionEpoch returns the current epoch for a session.

func (*DB) GetAgentSessionEventsSince added in v0.30.0 

func (db *DB) GetAgentSessionEventsSince(sessionID string, sinceSeqNum int64, limit int) ([]AgentSessionEvent, error)

GetAgentSessionEventsSince returns events with sequence_num > sinceSeqNum.

func (*DB) GetAgentSessionEventsTail added in v0.47.0 

func (db *DB) GetAgentSessionEventsTail(sessionID string, n int) ([]AgentSessionEvent, error)

GetAgentSessionEventsTail returns the most recent N events for the session, in chronological order. Used by the TUI SSE endpoint when ?tail=N is set.

func (*DB) GetAgentSessionInternalEventsSince added in v0.30.0 

func (db *DB) GetAgentSessionInternalEventsSince(sessionID string, sinceID int64, limit int) ([]struct {
	ID           int64
	EventType    string
	Payload      json.RawMessage
	IsCompaction bool
	AgentID      string
	CreatedAt    time.Time
}, error)

GetAgentSessionInternalEventsSince returns internal events with id > sinceID.

func (*DB) GetAgentSessionWorker added in v0.30.0 

func (db *DB) GetAgentSessionWorker(sessionID string, epoch int) (*AgentSessionWorker, error)

func (*DB) GetAgentTask added in v0.30.0 

func (db *DB) GetAgentTask(id string) (*AgentTask, error)

func (*DB) GetAllChannelMeta added in v0.27.0 

func (db *DB) GetAllChannelMeta(channelID, userID string) (map[string]string, error)

GetAllChannelMeta retrieves all metadata entries for a user on a channel.

func (*DB) GetAllProviderMeta added in v0.27.0 

func (db *DB) GetAllProviderMeta(sandboxID, provider, botID, userID string) (map[string]string, error)

GetAllProviderMeta retrieves all metadata entries for a user.

func (*DB) GetAllWorkspaceNamespaces 

func (db *DB) GetAllWorkspaceNamespaces() ([]string, error)

func (*DB) GetChannelMeta added in v0.27.0 

func (db *DB) GetChannelMeta(channelID, userID, key string) (string, error)

GetChannelMeta retrieves a channel-specific metadata value.

func (*DB) GetChannelRequireMention added in v0.27.0 

func (db *DB) GetChannelRequireMention(channelID string) (bool, error)

GetChannelRequireMention returns the require_mention flag for a channel.

func (*DB) GetCodexToken added in v0.50.7 

func (db *DB) GetCodexToken(ctx context.Context, id string) (*CodexToken, error)

GetCodexToken returns the row by id, or (nil, nil) if absent. It includes revoked rows so the verify endpoint can apply its own policy.

func (*DB) GetCredentialBinding added in v0.36.0 

func (db *DB) GetCredentialBinding(id string) (*CredentialBinding, error)

func (*DB) GetIMChannel added in v0.27.0 

func (db *DB) GetIMChannel(channelID string) (*IMChannel, error)

GetIMChannel retrieves a single workspace IM channel by ID.

func (*DB) GetIMChannelForSandbox added in v0.27.0 

func (db *DB) GetIMChannelForSandbox(sandboxID string) (*IMChannel, error)

GetIMChannelForSandbox returns the IM channel bound to a sandbox, if any. Returns sql.ErrNoRows if the sandbox has no channel bound.

func (*DB) GetIMCredentials added in v0.27.0 

func (db *DB) GetIMCredentials(sandboxID, provider, botID string) (botToken, baseURL string, err error)

GetIMCredentials retrieves bot credentials for an IM binding.

func (*DB) GetModelserverConnection added in v0.22.0 

func (db *DB) GetModelserverConnection(workspaceID string) (*ModelserverConnection, error)

func (*DB) GetOIDCIdentity 

func (db *DB) GetOIDCIdentity(provider, subject string) (*OIDCIdentity, error)

func (*DB) GetOrCreateWorkspaceToken added in v0.47.0 

func (db *DB) GetOrCreateWorkspaceToken(workspaceID string) (string, error)

GetOrCreateWorkspaceToken returns the workspace's persistent proxy token, creating one if none exists. Idempotent: concurrent callers race-free thanks to the unique index on (workspace_id) WHERE token_type='workspace'.

func (*DB) GetPasswordHash added in v0.9.0 

func (db *DB) GetPasswordHash(userID string) (*string, error)

GetPasswordHash returns the bcrypt hash for the given user, or nil if no credential exists.

func (*DB) GetProviderMeta added in v0.27.0 

func (db *DB) GetProviderMeta(sandboxID, provider, botID, userID, key string) (string, error)

GetProviderMeta retrieves a provider-specific metadata value.

func (*DB) GetProxyToken added in v0.47.0 

func (db *DB) GetProxyToken(token string) (*ProxyToken, error)

GetProxyToken looks up a token in the unified proxy_tokens table. Returns (nil, nil) if the token is not present. Callers (llmproxy validation) branch on TokenType to decide whether sandbox status checks apply.

func (*DB) GetSandbox 

func (db *DB) GetSandbox(id string) (*Sandbox, error)

func (*DB) GetSandboxByAnyToken added in v0.30.2 

func (db *DB) GetSandboxByAnyToken(token string) (*Sandbox, error)

GetSandboxByAnyToken looks up a sandbox by proxy_token first, then tunnel_token. This allows local agents (which only have tunnel_token) to authenticate against HTTP APIs, mirroring CC's pattern where a single OAuth token is used for both session creation and worker JWT exchange.

func (*DB) GetSandboxByProxyToken 

func (db *DB) GetSandboxByProxyToken(proxyToken string) (*Sandbox, error)

func (*DB) GetSandboxByShortID 

func (db *DB) GetSandboxByShortID(shortID string) (*Sandbox, error)

func (*DB) GetSandboxByTunnelToken 

func (db *DB) GetSandboxByTunnelToken(sandboxID, tunnelToken string) (*Sandbox, error)

GetSandboxByTunnelToken finds a local sandbox by its tunnel token.

func (*DB) GetSandboxForChannel added in v0.27.0 

func (db *DB) GetSandboxForChannel(channelID string) (sandboxID, podIP, bridgeSecret, assistantName string, err error)

GetSandboxForChannel returns the running sandbox bound to a channel. Returns sql.ErrNoRows if no sandbox is bound or none is running.

func (*DB) GetSessionByExternalID added in v0.40.0 

func (db *DB) GetSessionByExternalID(ctx context.Context, workspaceID, externalID string) (*AgentSession, error)

GetSessionByExternalID looks up a session by workspace and external ID.

func (*DB) GetSystemSetting added in v0.7.0 

func (db *DB) GetSystemSetting(key string) (string, error)

func (*DB) GetUserByEmail 

func (db *DB) GetUserByEmail(email string) (*User, error)

func (*DB) GetUserByID 

func (db *DB) GetUserByID(id string) (*User, error)

func (*DB) GetUserQuota added in v0.7.0 

func (db *DB) GetUserQuota(userID string) (*UserQuota, error)

func (*DB) GetWorkspace 

func (db *DB) GetWorkspace(id string) (*Workspace, error)

func (*DB) GetWorkspaceLLMConfig added in v0.22.0 

func (db *DB) GetWorkspaceLLMConfig(workspaceID string) (*WorkspaceLLMConfig, error)

func (*DB) GetWorkspaceMember 

func (db *DB) GetWorkspaceMember(workspaceID, userID string) (*WorkspaceMember, error)

func (*DB) GetWorkspaceMemberRole 

func (db *DB) GetWorkspaceMemberRole(workspaceID, userID string) (string, error)

func (*DB) GetWorkspaceQuota added in v0.9.0 

func (db *DB) GetWorkspaceQuota(workspaceID string) (*WorkspaceQuota, error)

func (*DB) HasModelserverConnection added in v0.22.0 

func (db *DB) HasModelserverConnection(workspaceID string) (bool, error)

func (*DB) InsertAgentSessionEvents added in v0.30.0 

func (db *DB) InsertAgentSessionEvents(sessionID string, events []AgentSessionEvent) ([]InsertedEvent, error)

InsertAgentSessionEvents inserts a batch of events, skipping duplicates. Returns only the successfully inserted events with their sequence numbers.

func (*DB) InsertAgentSessionInternalEvents added in v0.30.0 

func (db *DB) InsertAgentSessionInternalEvents(sessionID string, events []struct {
	EventType    string
	Payload      json.RawMessage
	IsCompaction bool
	AgentID      string
}) error

InsertAgentSessionInternalEvents inserts internal events (transcript).

func (*DB) InsertOperation added in v0.59.1 

func (db *DB) InsertOperation(o Operation) error

func (*DB) IsWorkspaceMember 

func (db *DB) IsWorkspaceMember(workspaceID, userID string) (bool, error)

func (*DB) LatestCodexBrowserSession added in v0.62.3 

func (db *DB) LatestCodexBrowserSession(ctx context.Context, tokenID string) (*CodexBrowserSession, error)

LatestCodexBrowserSession returns the most recent session for a token (open if any, otherwise the latest historical one), or (nil, nil) if the token has never been used.

func (*DB) ListAgentCardsByWorkspace added in v0.30.0 

func (db *DB) ListAgentCardsByWorkspace(workspaceID string) ([]AgentCard, error)

func (*DB) ListAgentTasksByWorkspace added in v0.30.0 

func (db *DB) ListAgentTasksByWorkspace(workspaceID string, limit int) ([]AgentTask, error)

func (*DB) ListAllActiveChannels added in v0.27.0 

func (db *DB) ListAllActiveChannels(provider string) ([]IMChannel, error)

ListAllActiveChannels returns all IM channels with credentials for a given provider. Used by RestoreIMBridgePollers.

func (*DB) ListAllActiveSandboxNames 

func (db *DB) ListAllActiveSandboxNames() ([]string, error)

func (*DB) ListAllSandboxes added in v0.6.1 

func (db *DB) ListAllSandboxes() ([]*Sandbox, error)

func (*DB) ListAllUsers added in v0.6.1 

func (db *DB) ListAllUsers() ([]*User, error)

func (*DB) ListAllWorkspaces added in v0.6.1 

func (db *DB) ListAllWorkspaces() ([]*Workspace, error)

func (*DB) ListAllWorkspacesAdmin added in v0.18.3 

func (db *DB) ListAllWorkspacesAdmin() ([]*AdminWorkspaceInfo, error)

func (*DB) ListCodexTokensForWorkspace added in v0.50.7 

func (db *DB) ListCodexTokensForWorkspace(ctx context.Context, workspaceID string, includeRevoked bool) ([]CodexToken, error)

ListCodexTokensForWorkspace returns tokens for a workspace, ordered by created_at desc. includeRevoked controls whether soft-revoked rows are included.

func (*DB) ListCredentialBindings added in v0.36.0 

func (db *DB) ListCredentialBindings(workspaceID, kind string) ([]*CredentialBinding, error)

func (*DB) ListCredentialBindingsMeta added in v0.36.0 

func (db *DB) ListCredentialBindingsMeta(workspaceID, kind string) ([]*CredentialBindingMeta, error)

ListCredentialBindingsMeta returns bindings without the encrypted auth blob.

func (*DB) ListIMBindings added in v0.27.0 

func (db *DB) ListIMBindings(sandboxID, provider string) ([]*IMBinding, error)

ListIMBindings returns all IM bindings for a sandbox, optionally filtered by provider. If provider is empty, all bindings are returned.

func (*DB) ListIMChannels added in v0.27.0 

func (db *DB) ListIMChannels(workspaceID string) ([]IMChannel, error)

ListIMChannels returns all IM channels for a workspace.

func (*DB) ListIdleSandboxes 

func (db *DB) ListIdleSandboxes(defaultTimeoutSeconds int) ([]*Sandbox, error)

func (*DB) ListInteractions added in v0.36.0 

func (db *DB) ListInteractions(workspaceID string, limit, offset int) ([]AgentInteraction, error)

func (*DB) ListOperations added in v0.59.1 

func (db *DB) ListOperations(f OperationFilter) ([]Operation, error)

func (*DB) ListPendingAgentTasksByTarget added in v0.30.0 

func (db *DB) ListPendingAgentTasksByTarget(targetID string, limit int) ([]AgentTask, error)

ListPendingAgentTasksByTarget returns pending tasks assigned to a target sandbox. Also atomically marks them as 'assigned' to prevent double-pickup.

func (*DB) ListSandboxesByWorkspace 

func (db *DB) ListSandboxesByWorkspace(workspaceID string) ([]*Sandbox, error)

func (*DB) ListSessionsByChannel added in v0.47.0 

func (db *DB) ListSessionsByChannel(ctx context.Context, workspaceID, channelType, executorID string, limit int) ([]SessionListItem, error)

ListSessionsByChannel returns sessions for a workspace filtered by channel type and executor. The external_id is expected to follow the pattern "<channelType>:<executorID>:<timestamp>".

func (*DB) ListStaleActiveTurns added in v0.47.0 

func (db *DB) ListStaleActiveTurns(ctx context.Context, cutoff time.Time) ([]StaleActiveTurn, error)

ListStaleActiveTurns returns sessions with an active turn that has not been updated since cutoff.

func (*DB) ListStaleResponders added in v0.47.0 

func (db *DB) ListStaleResponders(ctx context.Context, cutoff time.Time) ([]string, error)

ListStaleResponders returns session IDs whose responder was attached before cutoff.

func (*DB) ListWorkspaceMembers 

func (db *DB) ListWorkspaceMembers(workspaceID string) ([]*WorkspaceMember, error)

func (*DB) ListWorkspaceVolumes added in v0.9.0 

func (db *DB) ListWorkspaceVolumes(workspaceID string) ([]WorkspaceVolume, error)

func (*DB) ListWorkspacesByUser 

func (db *DB) ListWorkspacesByUser(userID string) ([]*Workspace, error)

func (*DB) ListWorkspacesWithoutNamespace 

func (db *DB) ListWorkspacesWithoutNamespace() ([]*Workspace, error)

func (*DB) LogInteraction added in v0.36.0 

func (db *DB) LogInteraction(i *AgentInteraction)

LogInteraction inserts an audit entry. Errors are logged but not returned (fire-and-forget).

func (*DB) MarkStaleAgentCardsOffline added in v0.30.0 

func (db *DB) MarkStaleAgentCardsOffline(threshold time.Duration) (int64, error)

MarkStaleAgentCardsOffline marks agents as offline if their sandbox heartbeat is stale.

func (*DB) PruneOperationsOlderThan added in v0.59.1 

func (db *DB) PruneOperationsOlderThan(cutoff time.Time) (int64, error)

PruneOperationsOlderThan deletes operations whose started_at is strictly before cutoff. Returns the number of rows deleted.

func (*DB) ReadInbox added in v0.36.0 

func (db *DB) ReadInbox(toID string, limit int) ([]AgentMessage, error)

ReadInbox returns unread messages for the given sandbox, atomically marking them as read.

func (*DB) RemoveWorkspaceMember 

func (db *DB) RemoveWorkspaceMember(workspaceID, userID string) error

func (*DB) RevokeCodexToken added in v0.50.7 

func (db *DB) RevokeCodexToken(ctx context.Context, id string) error

RevokeCodexToken soft-revokes a token. Idempotent: re-revoke and missing-id are no-ops.

func (*DB) SaveIMChannelCredentials added in v0.27.0 

func (db *DB) SaveIMChannelCredentials(channelID, botToken, baseURL string) error

SaveIMChannelCredentials stores bot credentials for a workspace IM channel.

func (*DB) SaveIMCredentials added in v0.27.0 

func (db *DB) SaveIMCredentials(sandboxID, provider, botID, botToken, baseURL string) error

SaveIMCredentials stores bot credentials for an IM binding.

func (*DB) SendMessage added in v0.36.0 

func (db *DB) SendMessage(msg *AgentMessage) error

func (*DB) SetCredentialBindingDefault added in v0.36.0 

func (db *DB) SetCredentialBindingDefault(workspaceID, kind, id string) error

SetCredentialBindingDefault atomically switches the default binding for a (workspace, kind) pair.

func (*DB) SetModelserverConnection added in v0.22.0 

func (db *DB) SetModelserverConnection(c *ModelserverConnection) error

func (*DB) SetPasswordHash added in v0.9.0 

func (db *DB) SetPasswordHash(userID, hash string) error

SetPasswordHash upserts a password hash for the given user.

func (*DB) SetSessionCodexThreadID added in v0.60.15 

func (db *DB) SetSessionCodexThreadID(ctx context.Context, sessionID string, threadID *string) error

SetSessionCodexThreadID updates (or clears, when threadID is nil) the codex_thread_id for a session. Used by the codex routing handler to persist the thread id after the first thread/start, and to clear it on thread-not-found / contextWindowExceeded so the next user message opens a fresh thread.

func (*DB) SetSessionExternalID added in v0.40.0 

func (db *DB) SetSessionExternalID(ctx context.Context, sessionID, externalID string) error

SetSessionExternalID sets the external_id for a session.

func (*DB) SetSessionIMChannel added in v0.40.0 

func (db *DB) SetSessionIMChannel(ctx context.Context, sessionID, channelID string) error

SetSessionIMChannel sets the im_channel_id for a session. Called when a session is created from an inbound IM message so that CC's response can later be routed back to the correct channel.

func (*DB) SetSystemSetting added in v0.7.0 

func (db *DB) SetSystemSetting(key, value string) error

func (*DB) SetUserQuota added in v0.7.0 

func (db *DB) SetUserQuota(userID string, maxWorkspaces *int) error

func (*DB) SetWorkspaceLLMConfig added in v0.22.0 

func (db *DB) SetWorkspaceLLMConfig(workspaceID, baseURL, apiKey string, models []LLMModel) error

func (*DB) SetWorkspaceNamespace 

func (db *DB) SetWorkspaceNamespace(id, namespace string) error

func (*DB) SetWorkspaceQuota added in v0.9.0 

func (db *DB) SetWorkspaceQuota(workspaceID string, maxSandboxes *int,
	maxSandboxCPU *int, maxSandboxMemory *int64, maxIdleTimeout *int, maxTotalCPU *int, maxTotalMemory *int64, maxDriveSize *int64) error

func (*DB) SumWorkspaceSandboxResources added in v0.7.0 

func (db *DB) SumWorkspaceSandboxResources(workspaceID string) (cpuMillis int64, memBytes int64, err error)

SumWorkspaceSandboxResources returns the total CPU (millicores) and memory (bytes) allocated by non-offline sandboxes in a workspace.

func (*DB) SweepStaleCodexBrowserSessions added in v0.62.3 

func (db *DB) SweepStaleCodexBrowserSessions(ctx context.Context, olderThan time.Time) (int64, error)

SweepStaleCodexBrowserSessions marks any session connected before olderThan and not yet closed as disconnected. Called from CXG startup so rows from a crashed previous CXG pod don't leak forever as "online".

func (*DB) TouchCodexToken added in v0.50.7 

func (db *DB) TouchCodexToken(ctx context.Context, id string) error

TouchCodexToken sets last_used_at = NOW(). Best-effort use only — caller should fire-and-forget in a goroutine and log warnings, not propagate errors.

func (*DB) UnbindSandboxFromChannel added in v0.27.0 

func (db *DB) UnbindSandboxFromChannel(sandboxID string) error

UnbindSandboxFromChannel removes the IM channel binding from a sandbox.

func (*DB) UpdateAgentCardStatus added in v0.30.0 

func (db *DB) UpdateAgentCardStatus(sandboxID, status string) error

func (*DB) UpdateAgentSessionWorkerHeartbeat added in v0.30.0 

func (db *DB) UpdateAgentSessionWorkerHeartbeat(sessionID string, epoch int) error

func (*DB) UpdateAgentSessionWorkerState added in v0.30.0 

func (db *DB) UpdateAgentSessionWorkerState(sessionID string, epoch int, state string, metadata, requiresActionDetails json.RawMessage) error

func (*DB) UpdateAgentTaskResult added in v0.30.0 

func (db *DB) UpdateAgentTaskResult(id string, resultJSON json.RawMessage, totalCostUSD *float64, numTurns int) error

func (*DB) UpdateAgentTaskStatus added in v0.30.0 

func (db *DB) UpdateAgentTaskStatus(id, status string) error

func (*DB) UpdateCursor added in v0.27.0 

func (db *DB) UpdateCursor(sandboxID, provider, botID, cursor string) error

UpdateCursor persists the long-poll cursor for an IM binding.

func (*DB) UpdateIMChannelCursor added in v0.27.0 

func (db *DB) UpdateIMChannelCursor(channelID, cursor string) error

UpdateIMChannelCursor persists the long-poll cursor for an IM channel.

func (*DB) UpdateIMChannelRoutingMode added in v0.40.1 

func (db *DB) UpdateIMChannelRoutingMode(channelID, mode string) error

UpdateIMChannelRoutingMode updates the routing_mode column for a channel. Caller is expected to validate `mode` before calling (valid values: "nanoclaw", "stateless_cc"). Unknown values are accepted by the DB but will cause forwardMessage to fall through to the default nanoclaw branch.

func (*DB) UpdateIMChannelSettings added in v0.27.0 

func (db *DB) UpdateIMChannelSettings(channelID string, requireMention bool) error

UpdateIMChannelSettings updates channel settings.

func (*DB) UpdateModelserverTokens added in v0.22.0 

func (db *DB) UpdateModelserverTokens(workspaceID, accessToken, refreshToken string, expiresAt time.Time) error

func (*DB) UpdateOIDCIdentityEmail added in v0.9.0 

func (db *DB) UpdateOIDCIdentityEmail(provider, subject, email string) error

func (*DB) UpdateSandboxActivity 

func (db *DB) UpdateSandboxActivity(id string) error

func (*DB) UpdateSandboxHeartbeat 

func (db *DB) UpdateSandboxHeartbeat(id string) error

UpdateSandboxHeartbeat updates the last_heartbeat_at timestamp.

func (*DB) UpdateSandboxName added in v0.16.0 

func (db *DB) UpdateSandboxName(id, name string) error

func (*DB) UpdateSandboxNanoclawBridgeSecret added in v0.26.0 

func (db *DB) UpdateSandboxNanoclawBridgeSecret(id, secret string) error

UpdateSandboxNanoclawBridgeSecret stores the bridge secret for a nanoclaw sandbox.

func (*DB) UpdateSandboxPodIP 

func (db *DB) UpdateSandboxPodIP(id, podIP string) error

func (*DB) UpdateSandboxSandboxName 

func (db *DB) UpdateSandboxSandboxName(id, sandboxName string) error

func (*DB) UpdateSandboxStatus 

func (db *DB) UpdateSandboxStatus(id, status string) error

func (*DB) UpdateUserEmail 

func (db *DB) UpdateUserEmail(userID, email string) error

func (*DB) UpdateUserName added in v0.9.0 

func (db *DB) UpdateUserName(userID, name string) error

func (*DB) UpdateUserPicture added in v0.9.0 

func (db *DB) UpdateUserPicture(userID, picture string) error

func (*DB) UpdateUserRole added in v0.6.1 

func (db *DB) UpdateUserRole(userID, role string) error

func (*DB) UpdateWorkspaceMemberRole 

func (db *DB) UpdateWorkspaceMemberRole(workspaceID, userID, role string) error

func (*DB) UpdateWorkspaceName added in v0.16.0 

func (db *DB) UpdateWorkspaceName(id, name string) error

func (*DB) UpsertAgentCard added in v0.30.0 

func (db *DB) UpsertAgentCard(card *AgentCard) error

func (*DB) UpsertAgentCardFromCapabilities added in v0.37.0 

func (db *DB) UpsertAgentCardFromCapabilities(sandboxID, workspaceID, displayName string, cardJSON json.RawMessage) error

UpsertAgentCardFromCapabilities creates or updates an agent card from capability data.

func (*DB) UpsertAgentInfo added in v0.16.0 

func (db *DB) UpsertAgentInfo(info *AgentInfo) error

UpsertAgentInfo inserts or updates agent info for a sandbox.

func (*DB) UpsertAgentSessionWorker added in v0.30.0 

func (db *DB) UpsertAgentSessionWorker(sessionID string, epoch int) error

func (*DB) UpsertChannelMeta added in v0.27.0 

func (db *DB) UpsertChannelMeta(channelID, userID, key, value string) error

UpsertChannelMeta inserts or updates a channel-specific metadata entry.

func (*DB) UpsertProviderMeta added in v0.27.0 

func (db *DB) UpsertProviderMeta(sandboxID, provider, botID, userID, key, value string) error

UpsertProviderMeta inserts or updates a provider-specific metadata entry.

func (*DB) ValidateToken 

func (db *DB) ValidateToken(token string) (string, error)

type IMBinding added in v0.27.0 

type IMBinding struct {
	ID        int
	SandboxID string
	Provider  string
	BotID     string
	UserID    string
	BotToken  string
	BaseURL   string
	Cursor    string
	BoundAt   time.Time
}

IMBinding represents a row in the sandbox_im_bindings table.

type IMChannel added in v0.27.0 

type IMChannel struct {
	ID             string
	WorkspaceID    string
	Provider       string
	BotID          string
	UserID         string
	BotToken       string
	BaseURL        string
	Cursor         string
	RequireMention bool
	RoutingMode    string
	BoundAt        time.Time
}

IMChannel represents a row in the workspace_im_channels table.

type InsertedEvent added in v0.30.0 

type InsertedEvent struct {
	SeqNum int64
	Event  AgentSessionEvent
}

InsertedEvent pairs an event with its assigned sequence number.

type LLMModel added in v0.22.0 

type LLMModel struct {
	ID   string `json:"id"`
	Name string `json:"name"`
}

type ModelserverConnection added in v0.22.0 

type ModelserverConnection struct {
	WorkspaceID    string     `json:"workspace_id"`
	ProjectID      string     `json:"project_id"`
	ProjectName    string     `json:"project_name"`
	UserID         string     `json:"user_id"`
	AccessToken    string     `json:"-"`
	RefreshToken   string     `json:"-"`
	TokenExpiresAt time.Time  `json:"token_expires_at"`
	Models         []LLMModel `json:"models"`
	CreatedAt      time.Time  `json:"created_at"`
	UpdatedAt      time.Time  `json:"updated_at"`
}

type OIDCIdentity 

type OIDCIdentity struct {
	Provider  string
	Subject   string
	UserID    string
	Email     *string
	CreatedAt time.Time
}

type Operation added in v0.59.1 

type Operation struct {
	ID          string
	WorkspaceID string
	UserID      *string
	Source      string // "sdk" | "tui" | (v1.5) "llm"
	ThreadID    *string
	RequestID   *string

	EnvID         string
	Tool          string
	Arguments     json.RawMessage // nil if truncated
	ArgumentsMeta json.RawMessage // {"truncated":true,"size_bytes":N,"sha256":"..."} if so

	IsError       bool
	ResultSummary *string
	ResultMeta    json.RawMessage

	StartedAt   time.Time
	CompletedAt time.Time
	DurationMs  int32

	NotebookPath *string // v1.5
	CellID       *string // v1.5
}

Operation is one row of the operations table — a single completed mcpServer/tool/call observed by codex-app-gateway.

type OperationFilter added in v0.59.1 

type OperationFilter struct {
	WorkspaceID string // REQUIRED — server-side enforced
	EnvID       string // optional
	Tool        string // optional
	Source      string // optional
	IsError     *bool  // optional
	Since       *time.Time
	ID          string // optional: exact match (returns 0 or 1 rows)
	Limit       int    // default 100, max 1000
}

OperationFilter is the optional filter set for ListOperations.

type ProxyToken added in v0.47.0 

type ProxyToken struct {
	Token       string
	TokenType   ProxyTokenType
	SandboxID   sql.NullString
	WorkspaceID string
}

ProxyToken is a row from the proxy_tokens table.

type ProxyTokenType added in v0.47.0 

type ProxyTokenType string

ProxyTokenType discriminates the two kinds of tokens stored in proxy_tokens. Sandbox tokens are bound to a specific sandbox lifecycle (must be 'running' / 'creating' to authorize requests). Workspace tokens are bound only to a workspace and authorize cc-broker turn workers, which do not have a sandbox identity. 

const (
	ProxyTokenSandbox   ProxyTokenType = "sandbox"
	ProxyTokenWorkspace ProxyTokenType = "workspace"
)

type Sandbox 

type Sandbox struct {
	ID                   string
	WorkspaceID          string
	Name                 string
	Type                 string
	Status               string
	IsLocal              bool
	ShortID              sql.NullString
	SandboxName          sql.NullString
	PodIP                sql.NullString
	ProxyToken           sql.NullString
	OpencodeToken        sql.NullString
	OpenclawToken        sql.NullString
	TunnelToken          sql.NullString
	NanoclawBridgeSecret sql.NullString
	LastActivityAt       sql.NullTime
	CreatedAt            time.Time
	PausedAt             sql.NullTime
	LastHeartbeatAt      sql.NullTime
	CPU                  *int
	Memory               *int64
	IdleTimeout          *int
	Metadata             json.RawMessage
}

type SessionListItem added in v0.47.0 

type SessionListItem struct {
	ID                  string
	ExternalID          string
	Title               string
	LastActivityAt      time.Time
	PermissionResponder *string
}

SessionListItem is a summary row returned by ListSessionsByChannel.

type StaleActiveTurn added in v0.47.0 

type StaleActiveTurn struct{ SessionID, TurnID string }

StaleActiveTurn pairs a session ID with a stuck active turn ID.

type User 

type User struct {
	ID        string
	Email     string
	Name      *string
	Picture   *string
	Role      string
	CreatedAt time.Time
	UpdatedAt time.Time
}

type UserQuota added in v0.7.0 

type UserQuota struct {
	UserID        string
	MaxWorkspaces *int
	UpdatedAt     time.Time
}

type Workspace 

type Workspace struct {
	ID           string
	Name         string
	K8sNamespace sql.NullString
	CreatedAt    time.Time
	UpdatedAt    time.Time
}

type WorkspaceLLMConfig added in v0.22.0 

type WorkspaceLLMConfig struct {
	WorkspaceID string
	BaseURL     string
	APIKey      string
	Models      []LLMModel
	CreatedAt   time.Time
	UpdatedAt   time.Time
}

type WorkspaceMember 

type WorkspaceMember struct {
	WorkspaceID string
	UserID      string
	Role        string
	CreatedAt   time.Time
}

type WorkspaceQuota added in v0.9.0 

type WorkspaceQuota struct {
	WorkspaceID      string
	MaxSandboxes     *int
	MaxSandboxCPU    *int   // millicores
	MaxSandboxMemory *int64 // bytes
	MaxIdleTimeout   *int   // seconds
	MaxTotalCPU      *int   // millicores
	MaxTotalMemory   *int64 // bytes
	MaxDriveSize     *int64 // bytes
	UpdatedAt        time.Time
}

type WorkspaceVolume added in v0.9.0 

type WorkspaceVolume struct {
	ID          string
	WorkspaceID string
	PVCName     string
	MountPath   string
	CreatedAt   time.Time
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.