sync

Documentation

Overview

Package sync provides utility functions similar to `git pull/push` for PFS

Index

• func Pull(ctx context.Context, client *pachclient.APIClient, root string, ...) (retErr error)
• func Push(client *pachclient.APIClient, root string, commit *pfs.Commit, overwrite bool) error
• func PushObj(pachClient pachclient.APIClient, commit *pfs.Commit, objClient obj.Client, ...) error

Functions

func Pull

func Pull(ctx context.Context, client *pachclient.APIClient, root string, fileInfo *pfs.FileInfo, pipes bool) (retErr error)

Pull clones an entire repo at a certain commit.

root is the local path you want to clone to. fileInfo is the file/dir we are puuling. pipes causes the function to create named pipes in place of files, thus lazily downloading the data as it's needed.

func Push

func Push(client *pachclient.APIClient, root string, commit *pfs.Commit, overwrite bool) error

Push puts files under root into an open commit.

func PushObj

func PushObj(pachClient pachclient.APIClient, commit *pfs.Commit, objClient obj.Client, root string) error

PushObj pushes data from commit to an object store.