backup

Documentation

Overview

Package backup implements full content backup for microCMS services.

Index

• func Run(ctx context.Context, client *api.Client, scanResult *scan.Result, opts Options) error
• type Manifest
• type ManifestAPI
• type Options

Functions

func Run

func Run(ctx context.Context, client *api.Client, scanResult *scan.Result, opts Options) error

Run executes a backup.

Types

type Manifest

type Manifest struct {
	ServiceID   string        `json:"serviceId"`
	StartedAt   time.Time     `json:"startedAt"`
	CompletedAt time.Time     `json:"completedAt,omitempty"`
	Status      string        `json:"status"` // "complete", "partial", "failed"
	APIs        []ManifestAPI `json:"apis"`
	TotalItems  int           `json:"totalItems"`
	MediaCount  int           `json:"mediaCount,omitempty"`
	MediaBytes  int64         `json:"mediaBytes,omitempty"`
}

Manifest records backup metadata.

type ManifestAPI

type ManifestAPI struct {
	APIID     string `json:"apiId"`
	APIType   string `json:"apiType"`
	ItemCount int    `json:"itemCount"`
	Status    string `json:"status"` // "complete", "failed", "skipped"
}

ManifestAPI records per-API backup info.

type Options

type Options struct {
	OutDir        string
	ServiceID     string
	Parallelism   int
	SkipSchema    bool
	DownloadMedia bool
	DryRun        bool
	Quiet         bool
	Color         bool
}

Options configures a backup run.