-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(storage/transfermanager): prototype #10045
Merged
+1,540
−0
Merged
Changes from 8 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
bee724f
[WIP] feat(storage/transfermanager): prototype
tritone 189f87b
result iterator
tritone a23db2e
mvp, just missing some tests
BrennaEpp bbdd5a6
wip - callbacks and sliced results
BrennaEpp 9fcaca4
finish tests, some cleanup
BrennaEpp 6353ea3
Merge branch 'main' into tm
BrennaEpp ca52f14
revert go.work.sum
BrennaEpp 1d00ad4
vet fixes
BrennaEpp 79d34f4
Merge branch 'main' into tm
BrennaEpp f5a6b33
add grpc tests and errors.join for waitandclose
BrennaEpp 8956b7b
remove bucket creation for short tests
BrennaEpp ed19c7f
parse flags in test main to allow setup to skip in short mode
BrennaEpp 5afae53
suggestions
BrennaEpp 5e42c62
docs + allow waitandclose to be called more than once
BrennaEpp 623fdd3
Merge branch 'main' into tm
BrennaEpp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| // Copyright 2024 Google LLC | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| /* | ||
| Package transfermanager provides an easy way to parallelize downloads in Google | ||
| Cloud Storage. | ||
|
|
||
| More information about Google Cloud Storage is available at | ||
| https://cloud.google.com/storage/docs. | ||
|
|
||
| See https://pkg.go.dev/cloud.google.com/go for authentication, timeouts, | ||
| connection pooling and similar aspects of this package. | ||
|
|
||
| NOTE: This package is in alpha. It is not stable, and is likely to change. | ||
|
|
||
| # Example usage | ||
|
|
||
| // Pass in any client opts or set retry policy here. | ||
| client, err := storage.NewClient(ctx) // can also use NewGRPCClient | ||
| if err != nil { | ||
| // handle error | ||
| } | ||
|
|
||
| // Create Downloader with desired options, including number of workers, | ||
| // part size, per operation timeout, etc. | ||
| d, err := transfermanager.NewDownloader(client, transfermanager.WithWorkers(16)) | ||
| if err != nil { | ||
| // handle error | ||
| } | ||
|
|
||
| // Create local file writer for output. | ||
| f, err := os.Create("/path/to/localfile") | ||
| if err != nil { | ||
| // handle error | ||
| } | ||
|
|
||
| // Create download input | ||
| in := &transfermanager.DownloadObjectInput{ | ||
| Bucket: "mybucket", | ||
| Object: "myblob", | ||
| Destination: f, | ||
| // Optionally specify params to apply to download. | ||
| EncryptionKey: []byte("mykey"), | ||
| } | ||
|
|
||
| // Can set timeout on this download using context. Note that this download | ||
| // may not start immediately if all workers are busy, so this may time out | ||
| // before the download even starts. To set a timeout that starts with the | ||
| // download, use transfermanager.WithPerOpTimeout(time.Duration). | ||
| ctx, cancel = context.WithTimeout(ctx, 1*time.Minute) | ||
| defer cancel() | ||
|
|
||
| // Add to Downloader. | ||
| d.DownloadObject(ctx, in) | ||
|
|
||
| // Repeat if desired. | ||
|
|
||
| // Wait for all downloads to complete. | ||
| d.WaitAndClose() | ||
|
|
||
| // Iterate through completed downloads and process results. This can | ||
| // also happen async in a go routine as the downloads run. | ||
| results := d.Results() | ||
| for _, out := range results { | ||
| if out.Err != nil { | ||
| log.Printf("download of %v failed with error %v", out.Name, out.Err) | ||
| } else { | ||
| log.Printf("download of %v succeeded", out.Object) | ||
| } | ||
| } | ||
| */ | ||
| package transfermanager // import "cloud.google.com/go/storage/transfermanager" | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's add something like https://github.com/googleapis/google-cloud-go/blob/main/storage/example_test.go instead perhaps so it can be in compiled code?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done