Versions in this module Expand all Collapse all v0 v0.1.40 Jun 15, 2026 v0.1.39 Jun 14, 2026 Changes in this version + func ConnectToRunningInstance(ctx context.Context, deps *Dependencies, instanceName string, ...) (*pgx.Conn, error) + func GetActiveOffsiteSettingsDecrypted(deps *Dependencies) (*offsite.OffsiteSettings, error) + func OffsiteApply(deps *Dependencies, params *OffsiteApplyParams) error + func OffsiteLogs(deps *Dependencies, params *OffsiteLogsParams) ([]offsite.OffsiteLog, error) + func OffsiteRemove(deps *Dependencies) error + func StreamInstanceLogs(ctx context.Context, deps *Dependencies, params GetLogsParams, w io.Writer) error + func TestPostgreSQLConnectivityWithPassword(ctx context.Context, port int, password string) error + type AddDatabaseUserParams struct + DatabaseName string + InstanceName string + Owner bool + ReadOnly bool + Username string + type AddDatabaseUserResult struct + Database string + Message string + Password string + ReadOnly bool + Username string + func AddDatabaseUser(ctx context.Context, deps *Dependencies, params AddDatabaseUserParams) (*AddDatabaseUserResult, error) + type BackupRDBMSParams struct + BackupDir string + Comment string + Name string + type BackupRDBMSResult struct + BackupID int + BackupPath string + Size int64 + Timestamp time.Time + func BackupRDBMS(ctx context.Context, deps *Dependencies, params *BackupRDBMSParams) (*BackupRDBMSResult, error) + type ConnectOptions struct + Database string + type ConsistencyCheckOp struct + func NewConsistencyCheckOp(deps *Dependencies, instance *instances.RDBMSInstance) *ConsistencyCheckOp + func (op *ConsistencyCheckOp) Execute(ctx context.Context) error + func (op *ConsistencyCheckOp) GetInstance() *instances.RDBMSInstance + func (op *ConsistencyCheckOp) GetStatus() *ConsistencyStatus + func (op *ConsistencyCheckOp) Name() string + func (op *ConsistencyCheckOp) Type() OpType + type ConsistencyStatus struct + ContainerExists bool + ContainerRunning bool + Issues []string + OverallHealthy bool + PostgreSQLReady bool + type CreateDatabaseParams struct + DatabaseName string + InstanceName string + type CreateDatabaseResult struct + DatabaseName string + Message string + func CreateDatabase(ctx context.Context, deps *Dependencies, params CreateDatabaseParams) (*CreateDatabaseResult, error) + type CreateRDBMSOp struct + func NewCreateRDBMSOp(deps *Dependencies, params CreateRDBMSParams) *CreateRDBMSOp + func (op *CreateRDBMSOp) Execute(ctx context.Context) error + func (op *CreateRDBMSOp) GetResult() *CreateRDBMSResult + func (op *CreateRDBMSOp) Name() string + func (op *CreateRDBMSOp) Type() OpType + type CreateRDBMSParams struct + CPUCores int + Image string + Name string + ParameterGroup string + Port int + RAMMB int + Version string + type CreateRDBMSResult struct + Instance *instances.RDBMSInstance + Password string + type CronBackupCreateOp struct + func NewCronBackupCreateOp(deps *Dependencies, instanceName string, ...) *CronBackupCreateOp + func (op *CronBackupCreateOp) Execute(ctx context.Context) error + func (op *CronBackupCreateOp) GetResult() *cron.CronPlan + func (op *CronBackupCreateOp) Name() string + func (op *CronBackupCreateOp) Type() OpType + type CronBackupDeleteOp struct + func NewCronBackupDeleteOp(deps *Dependencies, instanceName string) *CronBackupDeleteOp + func (op *CronBackupDeleteOp) Execute(ctx context.Context) error + func (op *CronBackupDeleteOp) Name() string + func (op *CronBackupDeleteOp) Type() OpType + type CronBackupListOp struct + func NewCronBackupListOp(deps *Dependencies) *CronBackupListOp + func (op *CronBackupListOp) Execute(ctx context.Context) error + func (op *CronBackupListOp) GetResult() []*cron.CronPlan + func (op *CronBackupListOp) Name() string + func (op *CronBackupListOp) Type() OpType + type CronTaskOp struct + func NewCronTaskOp(deps *Dependencies, instanceName string) *CronTaskOp + func (op *CronTaskOp) Execute(ctx context.Context) error + func (op *CronTaskOp) Name() string + func (op *CronTaskOp) Type() OpType + type DatabaseInfo struct + CreatedAt time.Time + Encoding string + Name string + Owner string + Size string + type DatabaseMeta struct + Collate string + Ctype string + Encoding string + LocProvider string + Name string + Owner string + type DeleteDatabaseUserParams struct + InstanceName string + Username string + type DeleteDatabaseUserResult struct + Message string + Username string + func DeleteDatabaseUser(ctx context.Context, deps *Dependencies, params DeleteDatabaseUserParams) (*DeleteDatabaseUserResult, error) + type DeleteRDBMSOp struct + func NewDeleteRDBMSOp(deps *Dependencies, params DeleteRDBMSParams) *DeleteRDBMSOp + func (op *DeleteRDBMSOp) Execute(ctx context.Context) error + func (op *DeleteRDBMSOp) Name() string + func (op *DeleteRDBMSOp) Type() OpType + type DeleteRDBMSParams struct + Name string + type Dependencies struct + BackupDir string + DataDir string + Docker *docker.Client + Logger *log.Logger + MasterKey []byte + Store *store.Store + type DownloadBackupParams struct + BackupID int + InstanceName string + type DownloadBackupResult struct + Location string + Message string + Size int64 + func DownloadBackup(ctx context.Context, deps *Dependencies, params DownloadBackupParams) (*DownloadBackupResult, error) + type Executor struct + func NewExecutor() *Executor + func (e *Executor) AddDatabaseUserOp(ctx context.Context, deps *Dependencies, params AddDatabaseUserParams) (*AddDatabaseUserResult, error) + func (e *Executor) CreateDatabaseOp(ctx context.Context, deps *Dependencies, params CreateDatabaseParams) (*CreateDatabaseResult, error) + func (e *Executor) DeleteDatabaseUserOp(ctx context.Context, deps *Dependencies, params DeleteDatabaseUserParams) (*DeleteDatabaseUserResult, error) + func (e *Executor) Execute(ctx context.Context, op Operation) error + func (e *Executor) ExecuteAsync(ctx context.Context, op Operation) <-chan error + func (e *Executor) ListDatabasesOp(ctx context.Context, deps *Dependencies, params ListDatabasesParams) (*ListDatabasesResult, error) + func (e *Executor) ResetDatabaseUserPasswordOp(ctx context.Context, deps *Dependencies, ...) (*ResetDatabaseUserPasswordResult, error) + type GetLogsParams struct + InstanceName string + Tail string + type GetLogsResult struct + Logs string + func GetInstanceLogs(ctx context.Context, deps *Dependencies, params GetLogsParams) (*GetLogsResult, error) + type GetPasswordOp struct + func NewGetPasswordOp(deps *Dependencies, name string) *GetPasswordOp + func (op *GetPasswordOp) Execute(ctx context.Context) error + func (op *GetPasswordOp) GetResult() *GetPasswordResult + func (op *GetPasswordOp) Name() string + func (op *GetPasswordOp) Type() OpType + type GetPasswordResult struct + Password string + type GetRDBMSOp struct + func NewGetRDBMSOp(deps *Dependencies, name string) *GetRDBMSOp + func (op *GetRDBMSOp) Execute(ctx context.Context) error + func (op *GetRDBMSOp) GetResult() *instances.RDBMSInstance + func (op *GetRDBMSOp) Name() string + func (op *GetRDBMSOp) Type() OpType + type ListBackupsParams struct + InstanceName string + type ListBackupsResult struct + Backups []backup.BackupRecord + func ListBackups(ctx context.Context, deps *Dependencies, params ListBackupsParams) (*ListBackupsResult, error) + type ListDatabasesParams struct + InstanceName string + type ListDatabasesResult struct + Databases []DatabaseInfo + func ListDatabases(ctx context.Context, deps *Dependencies, params ListDatabasesParams) (*ListDatabasesResult, error) + type ListRDBMSOp struct + func NewListRDBMSOp(deps *Dependencies) *ListRDBMSOp + func (op *ListRDBMSOp) Execute(ctx context.Context) error + func (op *ListRDBMSOp) GetResult() []instances.RDBMSInstance + func (op *ListRDBMSOp) Name() string + func (op *ListRDBMSOp) Type() OpType + type NotificationAddParams struct + Config json.RawMessage + Name string + Type notifications.NotificationType + type NotificationAddResult struct + Notification *notifications.Notification + func NotificationAdd(ctx context.Context, deps *Dependencies, params NotificationAddParams) (*NotificationAddResult, error) + type NotificationEditParams struct + Config json.RawMessage + Name string + Type string + type NotificationEditResult struct + Notification *notifications.Notification + func NotificationEdit(ctx context.Context, deps *Dependencies, params NotificationEditParams) (*NotificationEditResult, error) + type NotificationGetParams struct + Name string + type NotificationGetResult struct + Notification *notifications.Notification + func NotificationGet(ctx context.Context, deps *Dependencies, params NotificationGetParams) (*NotificationGetResult, error) + type NotificationListParams struct + type NotificationListResult struct + Notifications []notifications.Notification + func NotificationList(ctx context.Context, deps *Dependencies, params NotificationListParams) (*NotificationListResult, error) + type NotificationLogsParams struct + Limit int + type NotificationLogsResult struct + Logs []notifications.NotificationLog + func NotificationLogs(ctx context.Context, deps *Dependencies, params NotificationLogsParams) (*NotificationLogsResult, error) + type NotificationRemoveParams struct + Name string + type NotificationRemoveResult struct + Message string + func NotificationRemove(ctx context.Context, deps *Dependencies, params NotificationRemoveParams) (*NotificationRemoveResult, error) + type NotificationTestParams struct + type NotificationTestResult struct + Message string + func NotificationTest(ctx context.Context, deps *Dependencies, params NotificationTestParams) (*NotificationTestResult, error) + type OffsiteApplyParams struct + ConfigJSON []byte + type OffsiteGetResult struct + Config offsite.OffsiteSettingsJSON + func OffsiteGet(deps *Dependencies) (*OffsiteGetResult, error) + type OffsiteInfoResult struct + Active bool + Config *offsite.OffsiteSettings + func OffsiteInfo(deps *Dependencies) (*OffsiteInfoResult, error) + type OffsiteLogsParams struct + Limit int + type OffsiteTestResult struct + Error string + Message string + Success bool + func OffsiteTest(deps *Dependencies) (*OffsiteTestResult, error) + type OpType int + const OpTypeRead + const OpTypeWrite + type Operation interface + Execute func(ctx context.Context) error + Name func() string + Type func() OpType + type ParameterGroupDeleteParams struct + Name string + type ParameterGroupDeleteResult struct + Message string + func ParameterGroupDelete(ctx context.Context, deps *Dependencies, params ParameterGroupDeleteParams) (*ParameterGroupDeleteResult, error) + type ParameterGroupGetParams struct + Name string + type ParameterGroupGetResult struct + GroupName string + Parameters []parameters.ResolvedParameter + func ParameterGroupGet(ctx context.Context, deps *Dependencies, params ParameterGroupGetParams) (*ParameterGroupGetResult, error) + type ParameterGroupInfo struct + Name string + Parameters []parameters.ResolvedParameter + type ParameterGroupListParams struct + type ParameterGroupListResult struct + Groups []ParameterGroupInfo + func ParameterGroupList(ctx context.Context, deps *Dependencies, params ParameterGroupListParams) (*ParameterGroupListResult, error) + type ParameterGroupPutParams struct + Name string + Parameters []byte + type ParameterGroupPutResult struct + Message string + func ParameterGroupPut(ctx context.Context, deps *Dependencies, params ParameterGroupPutParams) (*ParameterGroupPutResult, error) + type PostgreSQLStatus int + const PostgreSQLStatusBrokenAuth + const PostgreSQLStatusBrokenPort + const PostgreSQLStatusOK + const PostgreSQLStatusOther + func TestPostgreSQLConnectivity(ctx context.Context, deps *Dependencies, instanceName string) PostgreSQLStatus + type PullImageOp struct + func NewPullImageOp(deps *Dependencies, params PullImageParams) *PullImageOp + func (op *PullImageOp) Execute(ctx context.Context) error + func (op *PullImageOp) GetResult() *PullImageResult + func (op *PullImageOp) Name() string + func (op *PullImageOp) Type() OpType + type PullImageParams struct + Image string + Version string + type PullImageResult struct + Message string + Tags []string + Version string + type ReconfigureRDBMSOp struct + func NewReconfigureRDBMSOp(deps *Dependencies, params ReconfigureRDBMSParams) *ReconfigureRDBMSOp + func (op *ReconfigureRDBMSOp) Execute(ctx context.Context) error + func (op *ReconfigureRDBMSOp) GetResult() *ReconfigureRDBMSResult + func (op *ReconfigureRDBMSOp) Name() string + func (op *ReconfigureRDBMSOp) Type() OpType + type ReconfigureRDBMSParams struct + Name string + ParameterGroup string + type ReconfigureRDBMSResult struct + Instance *instances.RDBMSInstance + type RemoveLocalBackupParams struct + BackupID int + InstanceName string + type RemoveLocalBackupResult struct + Message string + func RemoveLocalBackup(ctx context.Context, deps *Dependencies, params RemoveLocalBackupParams) (*RemoveLocalBackupResult, error) + type RemoveRemoteBackupParams struct + BackupID int + InstanceName string + type RemoveRemoteBackupResult struct + Message string + func RemoveRemoteBackup(ctx context.Context, deps *Dependencies, params RemoveRemoteBackupParams) (*RemoveRemoteBackupResult, error) + type ResetDatabaseUserPasswordParams struct + InstanceName string + Username string + type ResetDatabaseUserPasswordResult struct + Message string + Password string + Username string + func ResetDatabaseUserPassword(ctx context.Context, deps *Dependencies, ...) (*ResetDatabaseUserPasswordResult, error) + type RestoreRDBMSParams struct + BackupDir string + BackupID int + DatabaseName string + FilePath string + InstanceName string + RestoreAs string + type RestoreRDBMSResult struct + Message string + SourceBackup string + TargetDatabase string + func RestoreRDBMS(ctx context.Context, deps *Dependencies, params *RestoreRDBMSParams) (*RestoreRDBMSResult, error) + type SetPasswordOp struct + func NewSetPasswordOp(deps *Dependencies, name, password string) *SetPasswordOp + func (op *SetPasswordOp) Execute(ctx context.Context) error + func (op *SetPasswordOp) GetResult() *SetPasswordResult + func (op *SetPasswordOp) Name() string + func (op *SetPasswordOp) Type() OpType + type SetPasswordResult struct + Message string + Success bool + type SwitchRDBMSOp struct + func NewSwitchRDBMSOp(deps *Dependencies, params SwitchRDBMSParams) *SwitchRDBMSOp + func (op *SwitchRDBMSOp) Execute(ctx context.Context) error + func (op *SwitchRDBMSOp) GetResult() *SwitchRDBMSResult + func (op *SwitchRDBMSOp) Name() string + func (op *SwitchRDBMSOp) Type() OpType + type SwitchRDBMSParams struct + Image string + Name string + Version string + type SwitchRDBMSResult struct + Instance *instances.RDBMSInstance + type UpdateStateOp struct + func NewUpdateStateOp(deps *Dependencies, params UpdateStateParams) *UpdateStateOp + func (op *UpdateStateOp) Execute(ctx context.Context) error + func (op *UpdateStateOp) Name() string + func (op *UpdateStateOp) Type() OpType + type UpdateStateParams struct + Name string + State string + type UpgradeRDBMSOp struct + func NewUpgradeRDBMSOp(deps *Dependencies, params UpgradeRDBMSParams) *UpgradeRDBMSOp + func (op *UpgradeRDBMSOp) Execute(ctx context.Context) error + func (op *UpgradeRDBMSOp) GetResult() *UpgradeRDBMSResult + func (op *UpgradeRDBMSOp) Name() string + func (op *UpgradeRDBMSOp) Type() OpType + type UpgradeRDBMSParams struct + Image string + Name string + TargetVersion string + type UpgradeRDBMSResult struct + BackupID int + DatabasesRestored int + FromVersion string + Instance *instances.RDBMSInstance + ToVersion string + type UploadBackupParams struct + BackupID int + InstanceName string + type UploadBackupResult struct + Location string + Message string + Size int64 + func UploadBackup(ctx context.Context, deps *Dependencies, params UploadBackupParams) (*UploadBackupResult, error)
Go to main page