Buckets

​

What is a Bucket?

• Stores files - Any file type, any size
• Configurable access - Set read, write, delete permissions
• Scales automatically - No capacity planning needed
• Works everywhere - Same interface locally and in production

buckets:
  uploads:
    subtype: # your choice, from target platform
    access:
      api: [read, write, delete]
  profile-images:
    subtype: # your choice, from target platform
    access:
      api: [read, write]
      frontend: [read]

​

Bucket Configuration

​

Access Control

buckets:
  uploads:
    subtype: # your choice, from target platform
    access:
      api: [read, write, delete]   # Full access
      worker: [read, delete]       # Read and delete only
      frontend: [read]             # Read-only

• read - Download/read files
• write - Upload/write files
• delete - Delete files
• all - Shorthand for read, write, delete

​

Content Path (Static Files)

buckets:
  frontend:
    subtype: # your choice, from target platform
    content_path: ./build  # Deploy React/Vue/Angular build

entrypoints:
  web:
    subtype: # your choice, from target platform
    routes:
      /: frontend  # Serve static files from bucket

​

Using Buckets in Code

import { SugaClient } from './suga/client';

const suga = new SugaClient();

// Write file
await suga.uploads.write('path/to/file.txt', Buffer.from('data'));

// Read file
const data = await suga.uploads.read('path/to/file.txt');

// Delete file
await suga.uploads.delete('path/to/file.txt');

​

Local Development

.suga/
└── buckets/
    └── uploads/
        └── file.txt

• View files in .suga/buckets/{bucket-name}/
• Seed buckets by placing files there
• Test bucket operations without cloud access

​

Learn More