Struct ApiStorageBackend 

pub struct ApiStorageBackend { /* private fields */ }

API storage backend that communicates with HTTP API

Implementations

impl ApiStorageBackend

pub fn new(base_url: impl Into<String>, auth_token: Option<String>) -> Self

Create a new API storage backend

Arguments

• base_url - Base URL of the API server (e.g., “https://api.example.com/api/v1”)
• auth_token - Optional bearer token for authentication

Example

use data_modelling_sdk::storage::api::ApiStorageBackend;

let backend = ApiStorageBackend::new(
    "https://api.example.com/api/v1",
    Some("bearer_token_here".to_string()),
);

pub async fn get_workspace_info(&self) -> Result<WorkspaceInfo, StorageError>

Get workspace info to check if workspace exists

Returns

WorkspaceInfo if the workspace exists, or an error if not found or network error occurs.

Example

pub async fn load_tables( &self, domain: &str, ) -> Result<Vec<Value>, StorageError>

Load tables from API

Security

The domain parameter is validated to prevent injection attacks.

pub async fn load_relationships( &self, domain: &str, ) -> Result<Vec<Value>, StorageError>

Load relationships from API

Security

The domain parameter is validated to prevent injection attacks.

Trait Implementations

impl StorageBackend for ApiStorageBackend

fn list_files<'life0, 'life1, 'async_trait>( &'life0 self, _dir: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>, StorageError>> + 'async_trait>>

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

List files in a directory.

Note

This method is intentionally not supported in the API backend. The API uses a model-based approach where tables and relationships are accessed via dedicated endpoints rather than as files.

Use load_tables() and load_relationships() instead.

fn file_exists<'life0, 'life1, 'async_trait>( &'life0 self, _path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, StorageError>> + 'async_trait>>

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

Check if a file exists.

Note

File existence checks are not meaningful in the API backend. The API uses model endpoints - use load_tables() to check for tables.

fn delete_file<'life0, 'life1, 'async_trait>( &'life0 self, _path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + 'async_trait>>

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

Delete a file.

Note

This method is intentionally not supported in the API backend. Use the API’s table/relationship DELETE endpoints directly.

fn create_dir<'life0, 'life1, 'async_trait>( &'life0 self, _path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + 'async_trait>>

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

Create a directory.

Note

Directory creation is not supported in the API backend. Workspaces and domains are created via dedicated API endpoints.

fn read_file<'life0, 'life1, 'async_trait>( &'life0 self, _path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, StorageError>> + 'async_trait>>

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

Read a file from storage

fn write_file<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, _path: &'life1 str, _content: &'life2 [u8], ) -> Pin<Box<dyn Future<Output = Result<(), StorageError>> + 'async_trait>>

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

Write a file to storage

fn dir_exists<'life0, 'life1, 'async_trait>( &'life0 self, _path: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool, StorageError>> + 'async_trait>>

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

Check if a directory exists