feat(plugins): expose read-only estimated plan host api

This commit is contained in:
jearhe authored and GitHub committed 2026-09-20 17:15:52 +08:00
1 parent ea16af7f28
commit f909f85075
23 files changed
+2059 -17

No files matched your search

+2
View File
@@ -567,6 +567,8 @@ async fn main() {
.route("/query/build-explain-sql", post(routes::query::build_explain_sql))
.route("/query/build-dropped-file-preview-sql", post(routes::query::build_dropped_file_preview_sql))
.route("/query/get-explain-info", post(routes::query::get_explain_info))
.route("/query/plugin-plan-capabilities", post(routes::query::get_plugin_plan_capabilities))
.route("/query/plugin-estimated-plan", post(routes::query::get_plugin_estimated_plan))
.route("/query/build-create-user-sql", post(routes::query::build_create_user_sql))
.route("/query/build-table-select-sql", post(routes::query::build_table_select_sql))
.route("/query/build-database-search-sql", post(routes::query::build_database_search_sql))
+30
View File
@@ -808,6 +808,12 @@ pub struct GetExplainInfoRequest {
pub mode: Option<String>,
}
#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct GetPluginPlanCapabilitiesRequest {
pub connection_id: String,
}
#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct BuildCreateUserSqlRequest {
@@ -827,12 +833,36 @@ pub async fn get_explain_info(
req.schema.as_deref(),
&req.sql,
req.mode.as_deref(),
None,
)
.await
.map_err(AppError::from)?;
Ok(Json(plan))
}
/// Plugin Host API: what the current host and connection can plan, reported
/// without connecting or running any SQL.
pub async fn get_plugin_plan_capabilities(
State(state): State<Arc<WebState>>,
Json(req): Json<GetPluginPlanCapabilitiesRequest>,
) -> Result<Json<dbx_core::query::plugin_plan::PluginPlanCapabilities>, AppError> {
let capabilities = dbx_core::query::plugin_plan::plugin_plan_capabilities(&state.app, &req.connection_id)
.await
.map_err(AppError::from)?;
Ok(Json(capabilities))
}
/// Plugin Host API: read-only estimated plan acquisition. The request carries
/// the original SQL only; the host generates and owns the EXPLAIN.
pub async fn get_plugin_estimated_plan(
State(state): State<Arc<WebState>>,
Json(request): Json<dbx_core::query::plugin_plan::PluginPlanRequest>,
) -> Result<Json<dbx_core::query::plugin_plan::PluginPlanResult>, AppError> {
let result =
dbx_core::query::plugin_plan::explain_estimated_plan(&state.app, request).await.map_err(AppError::from)?;
Ok(Json(result))
}
pub async fn build_create_user_sql(Json(req): Json<BuildCreateUserSqlRequest>) -> Result<Json<String>, AppError> {
Ok(Json(dbx_core::db_admin_sql::build_create_user_sql(&req.username, &req.password, &req.tablespace)))
}