R2 Fields

You can easily integrate Cloudflare R2 into your application by defining R2 fields in your Models.

Read the R2 Bindings section in the Environment chapter for more information on how to define an R2 binding in your schema.

Defining an R2 Field

Note

R2 is used to store large unstructured data.

Cloesce will not query or buffer the full value of an R2 field into the Worker runtime. Only a HEAD request is made to R2 to check for existence and retrieve metadata.

A field in a Model may reference an R2 bindings template to define an R2 field:

r2 MyBucket {
    image {
        key: string
        "images/{key}"
    }
}

model Image {
    route {
        id: string
    }

    r2 MyBucket::image(id) {
        my_image
    }
}

The above snippet defines a Model Image with an R2 field my_image that is stored in the bucket MyBucket under the key “images/{id}”, where {id} is a placeholder that will be replaced with the actual value of the id route field when accessing R2.