_id
stringlengths
2
7
text
stringlengths
6
2.61k
title
stringclasses
1 value
c177200
// PrintDatumInfo pretty-prints file info. // If recurse is false and directory size is 0, display "-" instead // If fast is true and file size is 0, display "-" instead
c177201
// PrintDetailedDatumInfo pretty-prints detailed info about a datum
c177202
// PrintFile values for a pfs file.
c177203
// ShorthandInput renders a pps.Input as a short, readable string
c177204
// Retrieve returns nil if it successfully retrieved the value. Error is // returned if the value were not obtainable, or empty.
c177205
// IsExpired returns if the credentials are no longer valid, and need to be // retrieved.
c177206
// NewBranch creates a pfs.Branch
c177207
// NewCommit creates a pfs.Commit.
c177208
// NewCommitProvenance creates a pfs.CommitProvenance.
c177209
// NewFile creates a pfs.File.
c177210
// CreateRepo creates a new Repo object in pfs with the given name. Repos are // the top level data object in pfs and should be used to store data of a // similar type. For example rather than having a single Repo for an entire // project you might have separate Repos for logs, metrics, database dumps etc.
c177211
// InspectRepo returns info about a specific Repo.
c177212
// ListRepo returns info about all Repos. // provenance specifies a set of provenance repos, only repos which have ALL of // the specified repos as provenance will be returned unless provenance is nil // in which case it is ignored.
c177213
// DeleteRepo deletes a repo and reclaims the storage space it was using. Note // that as of 1.0 we do not reclaim the blocks that the Repo was referencing, // this is because they may also be referenced by other Repos and deleting them // would make those Repos inaccessible. This will be resolved in later // versions....
c177214
// BuildCommit builds a commit in a single call from an existing HashTree that // has already been written to the object store. Note this is a more advanced // pattern for creating commits that's mostly used internally.
c177215
// StartCommitParent begins the process of committing data to a Repo. Once started // you can write to the Commit with PutFile and when all the data has been // written you must finish the Commit with FinishCommit. NOTE, data is not // persisted until FinishCommit is called. // branch is a more convenient way to build ...
c177216
// FinishCommit ends the process of committing data to a Repo and persists the // Commit. Once a Commit is finished the data becomes immutable and future // attempts to write to it with PutFile will error.
c177217
// InspectCommit returns info about a specific Commit.
c177218
// BlockCommit returns info about a specific Commit, but blocks until that // commit has been finished.
c177219
// ListCommit lists commits. // If only `repo` is given, all commits in the repo are returned. // If `to` is given, only the ancestors of `to`, including `to` itself, // are considered. // If `from` is given, only the descendents of `from`, including `from` // itself, are considered. // `number` determines how many com...
c177220
// ListCommitF lists commits, calling f with each commit. // If only `repo` is given, all commits in the repo are returned. // If `to` is given, only the ancestors of `to`, including `to` itself, // are considered. // If `from` is given, only the descendents of `from`, including `from` // itself, are considered. // `nu...
c177221
// ListCommitByRepo lists all commits in a repo.
c177222
// CreateBranch creates a new branch
c177223
// InspectBranch returns information on a specific PFS branch
c177224
// ListBranch lists the active branches on a Repo.
c177225
// SetBranch sets a commit and its ancestors as a branch. // SetBranch is deprecated in favor of CommitBranch.
c177226
// DeleteBranch deletes a branch, but leaves the commits themselves intact. // In other words, those commits can still be accessed via commit IDs and // other branches they happen to be on.
c177227
// DeleteCommit deletes a commit.
c177228
// FlushCommit returns an iterator that returns commits that have the // specified `commits` as provenance. Note that the iterator can block if // jobs have not successfully completed. This in effect waits for all of the // jobs that are triggered by a set of commits to complete. // // If toRepos is not nil then only ...
c177229
// FlushCommitF calls f with commits that have the specified `commits` as // provenance. Note that it can block if jobs have not successfully // completed. This in effect waits for all of the jobs that are triggered by a // set of commits to complete. // // If toRepos is not nil then only the commits up to and includin...
c177230
// FlushCommitAll returns commits that have the specified `commits` as // provenance. Note that it can block if jobs have not successfully // completed. This in effect waits for all of the jobs that are triggered by a // set of commits to complete. // // If toRepos is not nil then only the commits up to and including t...
c177231
// SubscribeCommit is like ListCommit but it keeps listening for commits as // they come in.
c177232
// SubscribeCommitF is like ListCommit but it calls a callback function with // the results rather than returning an iterator.
c177233
// PutObjectAsync puts a value into the object store asynchronously.
c177234
// PutObject puts a value into the object store and tags it with 0 or more tags.
c177235
// PutObjectSplit is the same as PutObject except that the data is splitted // into several smaller objects. This is primarily useful if you'd like to // be able to resume upload.
c177236
// GetObject gets an object out of the object store by hash.
c177237
// GetObjectReader returns a reader for an object in object store by hash.
c177238
// GetObjects gets several objects out of the object store by hash.
c177239
// TagObject applies a tag to an existing object.
c177240
// ListObject lists objects stored in pfs.
c177241
// InspectObject returns info about an Object.
c177242
// GetTag gets an object out of the object store by tag.
c177243
// GetTagReader returns a reader for an object in object store by tag.
c177244
// ListTag lists tags stored in pfs.
c177245
// Compact forces compaction of objects.
c177246
// NewPutFileClient returns a new client for putting files into pfs in a single request.
c177247
// PutFileOverwrite is like PutFile but it overwrites the file rather than // appending to it. overwriteIndex allows you to specify the index of the // object starting from which you'd like to overwrite. If you want to // overwrite the entire file, specify an index of 0.
c177248
// Close must be called after you're done using a putFileClient. // Further requests will throw errors.
c177249
// CopyFile copys a file from one pfs location to another. It can be used on // directories or regular files.
c177250
// GetFile returns the contents of a file at a specific Commit. // offset specifies a number of bytes that should be skipped in the beginning of the file. // size limits the total amount of data returned, note you will get fewer bytes // than size if you pass a value larger than the size of the file. // If size is set ...
c177251
// GetFileReader returns a reader for the contents of a file at a specific Commit. // offset specifies a number of bytes that should be skipped in the beginning of the file. // size limits the total amount of data returned, note you will get fewer bytes // than size if you pass a value larger than the size of the file....
c177252
// GetFileReadSeeker returns a reader for the contents of a file at a specific // Commit that permits Seeking to different points in the file.
c177253
// InspectFile returns info about a specific file.
c177254
// ListFile returns info about all files in a Commit under path.
c177255
// ListFileHistory returns info about all files and their history in a Commit under path.
c177256
// ListFileF returns info about all files in a Commit under path, calling f with each FileInfo.
c177257
// Walk walks the pfs filesystem rooted at path. walkFn will be called for each // file found under path in lexicographical order. This includes both regular // files and directories.
c177258
// DeleteFile deletes a file from a Commit. // DeleteFile leaves a tombstone in the Commit, assuming the file isn't written // to later attempting to get the file from the finished commit will result in // not found error. // The file will of course remain intact in the Commit's parent.
c177259
// Write performs a write.
c177260
// Close closes the writer.
c177261
// PrettyPrintVersionNoAdditional returns a version string without // version.Additional.
c177262
// Walk the command tree, wrap any examples in a block-quote with shell highlighting
c177263
// errMissingField returns a logical response error that prints a consistent // error message for when a required field is missing.
c177264
// validateFields verifies that no bad arguments were given to the request.
c177265
// putConfig parses and returns the configuration data from the storage backend.
c177266
// getConfig parses and returns the configuration data from the storage backend.
c177267
// NewPuller creates a new Puller struct.
c177268
// PullTree pulls from a raw HashTree rather than a repo.
c177269
// Push puts files under root into an open commit.
c177270
// PushObj pushes data from commit to an object store.
c177271
// PushFile makes sure that pfsFile has the same content as osFile.
c177272
// Dump writes debug information from the server to w.
c177273
// Profile writes a pprof profile for pachd to w.
c177274
// Binary writes the running pachd binary to w.
c177275
// RegisterCacheStats creates a new wrapper for groupcache stats that implements // the prometheus.Collector interface, and registers it
c177276
// wait until more than n bytes have been written
c177277
// RunWorkload runs a test workload against a Pachyderm cluster.
c177278
// createRepo creates a new repo in the cluster
c177279
// advanceCommit either starts or finishes a commit, depending on the state of // the cluster.
c177280
// RandString returns a random alphabetical string of size n
c177281
// NewReader returns a Reader which generates strings of characters.
c177282
// iterDir iterates through the nodes under path, it errors with PathNotFound if path doesn't exist, it errors with PathConflict if path exists but isn't a directory.
c177283
// FSSize gets the size of the hashtree
c177284
// Diff returns the diff of two hashtrees at particular paths.
c177285
// Serialize serializes a binary version of the hashtree.
c177286
// Deserialize deserializes a hashtree.
c177287
// Copy returns a copy of the hashtree.
c177288
// Destroy cleans up the on disk structures for the hashtree.
c177289
// PutFileOverwrite is the same as PutFile, except that instead of // appending the objects to the end of the given file, the objects // are inserted to the given index, and the existing objects starting // from the given index are removed.
c177290
// PutDirHeaderFooter implements the hashtree.PutDirHeaderFooter interface // method
c177291
// PutFileHeaderFooter implements the HashTree PutFileHeaderFooter method
c177292
// deleteDir deletes a directory and all the children under it
c177293
// NewReader creates a new hashtree reader.
c177294
// Read reads the next merge node.
c177295
// NewWriter creates a new hashtree writer.
c177296
// Write writes the next merge node.
c177297
// Copy copies a hashtree reader in a writer.
c177298
// Index returns the index for a hashtree writer.
c177299
// GetRangeFromIndex returns a subtree byte range in a serialized hashtree based on a passed in prefix.