Struct SqlViewerLayer 

pub struct SqlViewerLayer<DB: DatabaseProvider> { /* private fields */ }

Main layer for integrating SQL viewer into an Axum application

Example

use axum::Router;
use axum_sql_viewer::SqlViewerLayer;
use sqlx::SqlitePool;

let pool = SqlitePool::connect("sqlite::memory:").await.unwrap();
let viewer = SqlViewerLayer::sqlite("/sql-viewer", pool);
let app = Router::new().merge(viewer.into_router());

Implementations

impl<DB: DatabaseProvider> SqlViewerLayer<DB>

pub fn new(base_path: impl Into<String>, database: DB) -> Self

Create a new SQL viewer at the given base path

Arguments

• base_path - The URL path where the viewer will be mounted (e.g., “/sql-viewer”)
• database - The database provider implementation

pub fn into_router(self) -> Router

Convert into an Axum Router that can be merged

This method consumes the layer and returns a Router that can be merged into your main application router.

The returned router includes:

• Frontend serving at {base_path}/
• API endpoints at {base_path}/api/*
• Permissive CORS middleware for development

impl SqlViewerLayer<SqliteProvider>

pub fn sqlite(base_path: impl Into<String>, pool: SqlitePool) -> Self

Create a new SQL viewer for SQLite

Arguments

• base_path - The URL path where the viewer will be mounted
• pool - The SQLite connection pool

impl SqlViewerLayer<PostgresProvider>

pub fn postgres(base_path: impl Into<String>, pool: PgPool) -> Self

Create a new SQL viewer for PostgreSQL

Arguments

• base_path - The URL path where the viewer will be mounted
• pool - The PostgreSQL connection pool