rustberg 0.0.5

A production-grade, cross-platform, single-binary Apache Iceberg REST Catalog
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

//! Route definitions for Iceberg REST Catalog v1 API.

use axum::{
    routing::{delete, get, head, post},
    Router,
};

use super::namespace::{
    create_namespace, delete_namespace, get_namespace, list_namespaces, namespace_exists,
    update_namespace_properties,
};
use super::search::search;
use super::table::{
    commit_table, commit_transaction, create_table, drop_table, list_tables, load_table,
    load_table_credentials, register_table, rename_table, report_metrics, table_exists,
};
use super::view::{
    commit_view, create_view, drop_view, list_views, load_view, rename_view, view_exists,
};
use crate::app::AppState;

/// Creates the v1 API routes.
pub fn create_routes(app_state: AppState) -> Router {
    Router::new()
        // ====================================================================
        // Search route (must be before parameterized routes)
        // ====================================================================
        .route("/search", get(search))
        // ====================================================================
        // Namespace routes
        // ====================================================================
        .route("/namespaces", get(list_namespaces))
        .route("/namespaces", post(create_namespace))
        .route("/namespaces/{namespace}", get(get_namespace))
        .route("/namespaces/{namespace}", head(namespace_exists))
        .route("/namespaces/{namespace}", delete(delete_namespace))
        .route(
            "/namespaces/{namespace}/properties",
            post(update_namespace_properties),
        )
        // ====================================================================
        // Table routes
        // ====================================================================
        .route("/namespaces/{namespace}/tables", get(list_tables))
        .route("/namespaces/{namespace}/tables", post(create_table))
        // Register existing table (from external metadata location)
        .route("/namespaces/{namespace}/register", post(register_table))
        // Note: GET and POST on same path handled by different methods
        // GET = load_table, POST = commit_table (update)
        .route(
            "/namespaces/{namespace}/tables/{table}",
            get(load_table).post(commit_table),
        )
        .route("/namespaces/{namespace}/tables/{table}", head(table_exists))
        .route("/namespaces/{namespace}/tables/{table}", delete(drop_table))
        // Credentials endpoint for vending storage access credentials
        .route(
            "/namespaces/{namespace}/tables/{table}/credentials",
            get(load_table_credentials),
        )
        // Metrics reporting endpoint for client telemetry
        .route(
            "/namespaces/{namespace}/tables/{table}/metrics",
            post(report_metrics),
        )
        .route("/tables/rename", post(rename_table))
        // ====================================================================
        // View routes
        // ====================================================================
        .route("/namespaces/{namespace}/views", get(list_views))
        .route("/namespaces/{namespace}/views", post(create_view))
        // GET = load_view, POST = commit_view (update)
        .route(
            "/namespaces/{namespace}/views/{view}",
            get(load_view).post(commit_view),
        )
        .route("/namespaces/{namespace}/views/{view}", head(view_exists))
        .route("/namespaces/{namespace}/views/{view}", delete(drop_view))
        .route("/views/rename", post(rename_view))
        // ====================================================================
        // Transaction routes
        // ====================================================================
        .route("/transactions/commit", post(commit_transaction))
        .with_state(app_state)
}