File uploads in Serverpod — upload descriptions, verification, storage backends (database, S3, GCP). Use when implementing file uploads or cloud storage.
Flow: server issues upload description → client uploads → server verifies. Default storage is the database; use S3 or GCP for production.
Future<String?> getUploadDescription(Session session, String path) async {
return await session.storage.createDirectFileUploadDescription(
storageId: 'public',
path: path,
);
}
Restrict paths in production (derive from user/session).
Future<bool> verifyUpload(Session session, String path) async {
return await session.storage.verifyDirectFileUpload(
storageId: 'public', path: path);
}
Always verify after client upload when using S3 or GCP.
var desc = await client.myEndpoint.getUploadDescription('profile/$userId/avatar.png');
if (desc != null) {
var uploader = FileUploader(desc);
await uploader.upload(byteDataOrStream);
await client.myEndpoint.verifyUpload('profile/$userId/avatar.png');
}
Use Stream for large files. Paths: no leading slash, S3/GCP compatible.
session.storage.fileExists(storageId: 'public', path: path)session.storage.getPublicUrl(storageId: 'public', path: path) (public storage only)session.storage.retrieveFile(storageId: 'public', path: path)public and private storages. Fine for dev.serverpod_cloud_storage_gcp, set HMAC keys in passwords.yaml or env. Register: pod.addCloudStorage(GoogleCloudStorage(...)).serverpod_cloud_storage_s3, set AWS keys. Register: pod.addCloudStorage(S3CloudStorage(...)).Use storageId: 'public' or 'private' when replacing defaults.