share

Documentation

Index

• Constants
• Variables
• func Commit(ctx context.Context, opts Options, message string) (bool, error)
• func CreateImmutableTag(ctx context.Context, opts Options) (string, error)
• func EnsureRepo(ctx context.Context, opts Options) error
• func ManifestAlreadyImported(ctx context.Context, s *store.Store, manifest Manifest) bool
• func MarkImported(ctx context.Context, s *store.Store, manifest Manifest) error
• func NeedsImport(ctx context.Context, s *store.Store, staleAfter time.Duration) bool
• func Pull(ctx context.Context, opts Options) error
• func Push(ctx context.Context, opts Options) error
• func ValidateTag(ctx context.Context, opts Options) error
• type Manifest
  • func Export(ctx context.Context, s *store.Store, opts Options) (Manifest, error)
  • func Import(ctx context.Context, s *store.Store, opts Options) (Manifest, error)
  • func ImportAt(ctx context.Context, s *store.Store, opts Options, ref string) (Manifest, error)
  • func ImportIfChanged(ctx context.Context, s *store.Store, opts Options) (Manifest, bool, error)
  • func ReadManifest(repoPath string) (Manifest, error)
• type MediaFileManifest
• type MediaManifest
• type Options
• type SyncState
  • func ReadSyncState(ctx context.Context, s *store.Store) (SyncState, error)
• type TableManifest

Constants

const (
	ManifestName = "manifest.json"
)

Variables

var ErrNoManifest = errors.New("share manifest not found")

var SnapshotTables = []string{
	"workspaces",
	"channels",
	"users",
	"messages",
	"message_files",
	"message_events",
	"message_mentions",
	"sync_state",
	"embedding_jobs",
}

Functions

func Commit

func Commit(ctx context.Context, opts Options, message string) (bool, error)

func CreateImmutableTag

func CreateImmutableTag(ctx context.Context, opts Options) (string, error)

func EnsureRepo

func EnsureRepo(ctx context.Context, opts Options) error

func ManifestAlreadyImported

func ManifestAlreadyImported(ctx context.Context, s *store.Store, manifest Manifest) bool

func MarkImported

func MarkImported(ctx context.Context, s *store.Store, manifest Manifest) error

func NeedsImport

func NeedsImport(ctx context.Context, s *store.Store, staleAfter time.Duration) bool

func Pull

func Pull(ctx context.Context, opts Options) error

func Push

func Push(ctx context.Context, opts Options) error

func ValidateTag

func ValidateTag(ctx context.Context, opts Options) error

Types

type Manifest

type Manifest struct {
	Version     int               `json:"version"`
	GeneratedAt time.Time         `json:"generated_at"`
	Tables      []TableManifest   `json:"tables"`
	Media       *MediaManifest    `json:"media,omitempty"`
	Files       map[string]string `json:"files,omitempty"`
}

func Export

func Export(ctx context.Context, s *store.Store, opts Options) (Manifest, error)

func Import

func Import(ctx context.Context, s *store.Store, opts Options) (Manifest, error)

func ImportAt

func ImportAt(ctx context.Context, s *store.Store, opts Options, ref string) (Manifest, error)

ImportAt restores a snapshot from a Git ref without changing the share checkout.

func ImportIfChanged

func ImportIfChanged(ctx context.Context, s *store.Store, opts Options) (Manifest, bool, error)

func ReadManifest

func ReadManifest(repoPath string) (Manifest, error)

type MediaFileManifest

type MediaFileManifest struct {
	Path   string `json:"path"`
	Size   int64  `json:"size"`
	SHA256 string `json:"sha256"`
}

type MediaManifest

type MediaManifest struct {
	Files int                 `json:"files"`
	Bytes int64               `json:"bytes"`
	Items []MediaFileManifest `json:"items,omitempty"`
}

type Options

type Options struct {
	RepoPath     string
	Remote       string
	Branch       string
	Tag          string
	CacheDir     string
	IncludeMedia bool
}

type SyncState

type SyncState struct {
	LastImportAt            time.Time `json:"last_import_at"`
	LastManifestGeneratedAt time.Time `json:"last_manifest_generated_at"`
}

func ReadSyncState

func ReadSyncState(ctx context.Context, s *store.Store) (SyncState, error)

type TableManifest

type TableManifest struct {
	Name    string   `json:"name"`
	File    string   `json:"file,omitempty"`
	Files   []string `json:"files,omitempty"`
	Columns []string `json:"columns"`
	Rows    int      `json:"rows"`
}