Using Object Storage in your backend application

Object Storage is a simple and scalable solution to store files and unstructured data in your backend application.

The most common implementation is Amazon S3 ("Simple Storage Service") and its semantics are universally supported by every major cloud provider.

Encore.go provides a cloud-agnostic API for working with Object Storage, allowing you to store and retrieve files with ease. It has support for Amazon S3, Google Cloud Storage, as well as any other S3-compatible implementation (such as DigitalOcean Spaces, MinIO, etc.).

Additionally, when you use Encore's Object Storage API you also automatically get:

Automatic tracing and instrumentation of all Object Storage operations
Built-in local development support, storing objects on the local filesystem
Support for integration testing, using a local, in-memory storage backend

Creating a Bucket

The core of Object Storage is the Bucket, which represents a collection of files. In Encore, buckets must be declared as package level variables, and cannot be created inside functions. Regardless of where you create a bucket, it can be accessed from any service by referencing the variable it's assigned to.

When creating a bucket you can configure additional properties, like whether the objects in the bucket should be versioned.

See the complete specification in the package documentation.

For example, to create a bucket for storing profile pictures:

package user

import "encore.dev/storage/objects"

var ProfilePictures = objects.NewBucket("profile-pictures", objects.BucketConfig{
	Versioned: false,
})

Uploading files

To upload a file to a bucket, use the Upload method on the bucket variable. It returns a writer that you can use to write the contents of the file.

To complete the upload, call the Close method on the writer. To abort the upload, either cancel the context or call the Abort method on the writer.

The Upload method additionally takes a set of options to configure the upload, like setting attributes (objects.WithUploadAttrs) or to reject the upload if the object already exists (objects.WithPreconditions). See the package documentation for more details.

package user

import (
		"context"
		"io"
		"net/http"

		"encore.dev/beta/auth"
		"encore.dev/beta/errs"
		"encore.dev/storage/objects"
)

var ProfilePictures = objects.NewBucket("profile-pictures", objects.BucketConfig{})

//encore:api auth raw method=POST path=/upload-profile-picture
func UploadProfilePicture(w http.ResponseWriter, req *http.Request) {
	// Store the user's profile picture with their user id as the key.
	userID, _ := auth.UserID()
	key := string(userID) // We store the profile

	writer := ProfilePictures.Upload(req.Context(), key)
	_, err := io.Copy(writer, req.Body)
	if err != nil {
		// If something went wrong with copying data, abort the upload and return an error.
		writer.Abort()
		errs.HTTPError(w, err)
		return
	}

	if err := writer.Close(); err != nil {
		errs.HTTPError(w, err)
		return
	}

	// All good! Return a 200 OK.
	w.WriteHeader(http.StatusOK)
}

Downloading files

To download a file from a bucket, use the Download method on the bucket variable. It returns a reader that you can use to read the contents of the file.

The Download method additionally takes a set of options to configure the download, like downloading a specific version if the bucket is versioned (objects.WithVersion). See the package documentation for more details.

For example, to download the user's profile picture and serve it:

package user

import (
		"context"
		"io"
		"net/http"

		"encore.dev"
		"encore.dev/beta/auth"
		"encore.dev/beta/errs"
		"encore.dev/storage/objects"
)

var ProfilePictures = objects.NewBucket("profile-pictures", objects.BucketConfig{})

//encore:api public raw method=GET path=/profile-picture/:userID
func ServeProfilePicture(w http.ResponseWriter, req *http.Request) {
	userID := encore.CurrentRequest().PathParams.Get("userID")
	reader := ProfilePictures.Download(req.Context(), userID)

	// Did we encounter an error?
	if err := reader.Err(); err != nil {
		errs.HTTPError(w, err)
		return
	}

	// Assuming all images are JPEGs.
	w.Header().Set("Content-Type", "image/jpeg")
	io.Copy(w, reader)
}

Listing objects

To list objects in a bucket, use the List method on the bucket variable.

It returns an iterator of (error, *objects.ListEntry) pairs that you can use to easily iterate over the objects in the bucket using a range loop.

For example, to list all profile pictures:

for err, entry := range ProfilePictures.List(ctx, &objects.Query{}) {
	if err != nil {
		// Handle error
	}
	// Do something with entry
}

The *objects.Query type can be used to limit the number of objects returned, or to filter them to a specific key prefix.

See the package documentation for more details.

Deleting objects

To delete an object from a bucket, use the Remove method on the bucket variable.

For example, to delete a profile picture:

err := ProfilePictures.Remove(ctx, "my-user-id")
if err != nil && !errors.Is(err, objects.ErrObjectNotFound) {
	// Handle error
}

Retrieving object attributes

You can retrieve information about an object using the Attrs method on the bucket variable. It returns the attributes of the object, like its size, content type, and ETag.

For example, to get the attributes of a profile picture:

attrs, err := ProfilePictures.Attrs(ctx, "my-user-id")
if errors.Is(err, objects.ErrObjectNotFound) {
	// Object not found
} else if err != nil {
	// Some other error
}
// Do something with attrs

For convenience there is also Exists which returns a boolean indicating whether the object exists.

exists, err := ProfilePictures.Exists(ctx, "my-user-id")
if err != nil {
	// Handle error
} else if !exists {
	// Object does not exist
}

Using bucket references

Encore uses static analysis to determine which services are accessing each bucket, and what operations each service is performing.

That information is used to provision infrastructure correctly, render architecture diagrams, and configure IAM permissions.

This means that *objects.Bucket variables can't be passed around however you'd like, as it makes static analysis impossible in many cases. To work around these restrictions Encore allows you to get a "reference" to a bucket that can be passed around any way you want by calling objects.BucketRef.

To ensure Encore still is aware of which permissions each service needs, the call to objects.BucketRef must be made from within a service. Additionally, it must pre-declare the permissions it needs; those permissions are then assumed to be used by the service.

It looks like this (using the ProfilePictures topic above):

ref := objects.BucketRef[objects.Downloader](ProfilePictures)

// ref is of type objects.Downloader, which allows downloading.

Encore provides permission interfaces for each operation that can be performed on a bucket:

objects.Downloader for downloading objects
objects.Uploader for uploading objects
objects.Lister for listing objects
objects.Attrser for getting object attributes
objects.Remover for removing objects

If you need multiple permissions they can be combined by creating an interface that embeds the permissions you need.

type myPerms interface {
  objects.Downloader
  objects.Uploader
}
ref := objects.BucketRef[myPerms](ProfilePictures)

For convenience Encore provides an objects.ReadWriter interface that gives complete read-write access with all the permissions above.

See the package documentation for more details.