@computesdk/tigris
v1.1.2
Published
Tigris storage provider for ComputeSDK - S3-compatible object storage
Maintainers
Readme
@computesdk/tigris
Tigris storage provider for ComputeSDK using the official Tigris Storage SDK.
Installation
npm install @computesdk/tigrisUsage
import { tigris } from '@computesdk/tigris';
// Create storage instance
const storage = tigris({
accessKeyId: process.env.TIGRIS_STORAGE_ACCESS_KEY_ID,
secretAccessKey: process.env.TIGRIS_STORAGE_SECRET_ACCESS_KEY,
bucket: process.env.TIGRIS_STORAGE_BUCKET
});
// Upload a file
await storage.upload('my-bucket', 'path/to/file.txt', 'Hello, World!');
// Download a file
const result = await storage.download('my-bucket', 'path/to/file.txt');
console.log(result.data.toString());
// Delete a file
await storage.delete('my-bucket', 'path/to/file.txt');
// List objects
const list = await storage.list('my-bucket', { prefix: 'path/to/' });
for (const obj of list.objects) {
console.log(`${obj.key}: ${obj.size} bytes`);
}Configuration
| Option | Type | Required | Default | Description |
|--------|------|----------|---------|-------------|
| accessKeyId | string | No* | TIGRIS_STORAGE_ACCESS_KEY_ID env | Tigris access key ID |
| secretAccessKey | string | No* | TIGRIS_STORAGE_SECRET_ACCESS_KEY env | Tigris secret access key |
*Either provide in config or set environment variables.
Environment Variables
export TIGRIS_STORAGE_ACCESS_KEY_ID=your-access-key-id
export TIGRIS_STORAGE_SECRET_ACCESS_KEY=your-secret-access-key
export TIGRIS_STORAGE_BUCKET=your-bucket-nameAPI
See the @computesdk/s3 documentation for full API details.
Getting Tigris Credentials
- Go to Tigris Dashboard
- Create a new bucket or use an existing one
- Generate access keys with appropriate permissions
- Note the Access Key ID and Secret Access Key
License
MIT
