Struct S3Backend 

pub struct S3Backend { /* private fields */ }

AWS S3 storage backend

This backend uses OpenDAL’s S3 service to list objects from S3 buckets.

Authentication

Requires AWS credentials. Can use:

• Environment variables (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)
• IAM roles (when running on EC2/ECS)
• Explicit credentials passed to constructor

Example

use sqlite_vtable_opendal::backends::s3::S3Backend;
use sqlite_vtable_opendal::types::QueryConfig;

let backend = S3Backend::new("my-bucket", "us-east-1")
    .with_credentials("access_key", "secret_key");
let config = QueryConfig::default();
let files = backend.list_files(&config).await?;

Implementations

impl S3Backend

pub fn new(bucket: impl Into<String>, region: impl Into<String>) -> Self

Create a new S3 backend

Arguments

• bucket - S3 bucket name
• region - AWS region (e.g., “us-east-1”)

Example

use sqlite_vtable_opendal::backends::s3::S3Backend;

let backend = S3Backend::new("my-bucket", "us-east-1");

pub fn with_credentials( self, access_key_id: impl Into<String>, secret_access_key: impl Into<String>, ) -> Self

Set AWS credentials explicitly

Arguments

• access_key_id - AWS access key ID
• secret_access_key - AWS secret access key

Example

use sqlite_vtable_opendal::backends::s3::S3Backend;

let backend = S3Backend::new("my-bucket", "us-east-1")
    .with_credentials("AKIAIOSFODNN7EXAMPLE", "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY");

pub fn with_base_path(self, path: impl Into<String>) -> Self

Set base path/prefix in bucket

Arguments

• path - Base path (e.g., “data/2024/”)

Example

use sqlite_vtable_opendal::backends::s3::S3Backend;

let backend = S3Backend::new("my-bucket", "us-east-1")
    .with_base_path("data/2024/");

Trait Implementations

impl StorageBackend for S3Backend

fn list_files<'life0, 'life1, 'async_trait>( &'life0 self, config: &'life1 QueryConfig, ) -> Pin<Box<dyn Future<Output = Result<Vec<FileMetadata>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List files from the storage backend according to the query configuration

fn backend_name(&self) -> &'static str

Get the name of this backend (for logging/debugging)