Multipart Upload
Intro
Multipart Upload is a way to upload large files to an S3 compatible Object Storage like Cubbit by splitting them into smaller parts and uploading each part in parallel.
Uploading multiple pieces simultaneously improves upload speed and provides better reliability and resumability in case of network errors or interruptions. In fact, if the upload of a single part fails, the other parts remain unaffected and the process can resume at any time. The parts are then combined into a single object on the server.
This has several advantages:
- Upload speed: uploading more parts in parallel makes the uploading process faster.
- Failure recovery: if the connection is dropped while uploading, the object is still safe. Parts that have previously been uploaded are retained and the upload can resume with the missing parts.
- Pause the upload: The upload of the object can be stopped and resumed as needed, without requiring the entire upload to be restarted.
This feature is ideal for uploading large objects, maximizing network throughput, or for uploading files in an unstable network where failures are common.
Multipart Upload step by step
The multipart upload process involves the following steps:
- Initiate the upload: Start the upload process by sending a CreateMultipartUpload API. This request returns an upload ID, which is used to identify the upload in subsequent API requests.
- Upload parts: Upload parts of the file in parallel by sending UploadPart API requests with the upload ID and a part number. The part number should start at 1 and increment for each part.
- Complete the upload: Once all parts are uploaded, send a CompleteMultipartUpload API request with the upload ID and a list of part numbers and their corresponding ETags (a hash of the data).
- Verify the upload: Confirm the successful completion of the upload by downloading the entire file using GetObject and comparing it to the original file.
In case of failure, it is possible to abort a multipart upload with a AbortMultipartUpload API request, which will discard the uploaded parts and free up storage.
Usage
Let's see how to work with this feature using the AWS s3api CLI commands.
Create a multipart upload
Let's start initializing a multipart upload:
aws s3api create-multipart-upload --endpoint https://s3.cubbit.eu --bucket my-cubbit-bucket --key sergio.jpg
This will print a UploadId in the output, let's take note of that.
No worries, if you forget to write down the UploadId you can perform a ListMultipartUploads, which shows a list of ongoing multipart uploads with their ID.
Show the ongoing multipart uploads
If at any point we need to check which multipart uploads are still ongoing:
aws s3api list-multipart-uploads --endpoint https://s3.cubbit.eu --bucket my-cubbit-bucket --key sergio.jpg
Upload a few parts
Then we can upload a few parts, let's make two:
aws s3api upload-part --endpoint https://s3.cubbit.eu --bucket my-cubbit-bucket --key sergio.log --upload-id <UploadId> --part-number 1 --body ~/sergio-part1.log
aws s3api upload-part --endpoint https://s3.cubbit.eu --bucket my-cubbit-bucket --key sergio.log --upload-id <UploadId> --part-number 2 --body ~/sergio-part2.log
These will print the ETag values in the output, let's take note of them.
No worries, if you forget to write down the ETags you can perform a ListParts, which shows a list of parts with their part number and ETag.
Show the uploaded parts
If at any point we need to check which parts have already been uploaded:
aws s3api list-parts --endpoint https://s3.cubbit.eu --bucket my-cubbit-bucket --key sergio.jpg --upload-id <UploadId>
Complete a multipart upload
Finally, once all the parts have been uploaded we can create the final object out of them, by completing the upload:
aws s3api complete-multipart-upload --endpoint https://s3.cubbit.eu --bucket my-cubbit-bucket --key sergio.jpg --upload-id <UploadId> --multipart-upload "Parts=[{ETag=<ETag first part>,PartNumber=1},{ETag=<ETag second part>,PartNumber=2}]"
Limits
The multipart upload has some size limitations as summarized in the following table:
| Item | Limit |
|---|---|
| Maximum object size | 5 TiB |
| Maximum number of parts per upload | 10,000 |
| Part numbers | 1 to 10,000 (inclusive) |
| Minimum part size | 5 MiB |
| Maximum part size | 5 GiB |
| Maximum number of parts returned for a list parts request | 1000 |
| Maximum number of multipart uploads returned in a list multipart uploads request | 1000 |