feat(oracle): support explain plans
This commit is contained in:
13 files changed
+605
-117
No files matched your search
@@ -292,7 +292,7 @@
|
||||
"sqlFileExecution": true,
|
||||
"databaseCreate": false,
|
||||
"fieldLineage": true,
|
||||
"sqlExplain": false,
|
||||
"sqlExplain": true,
|
||||
"userAdmin": false,
|
||||
"driverManagement": true
|
||||
}
|
||||
|
||||
@@ -0,0 +1,75 @@
|
||||
use serde_json::Value;
|
||||
|
||||
use crate::connection::{AppState, PoolKind};
|
||||
use crate::query_execution_sql::{is_safe_dameng_autotrace_sql, is_safe_explain_sql};
|
||||
|
||||
pub async fn get_agent_explain_info_core(
|
||||
state: &AppState,
|
||||
connection_id: &str,
|
||||
database: Option<&str>,
|
||||
schema: Option<&str>,
|
||||
sql: &str,
|
||||
mode: Option<&str>,
|
||||
) -> Result<String, String> {
|
||||
let mode = mode.unwrap_or("explain");
|
||||
let safe = if mode.eq_ignore_ascii_case("autotrace") {
|
||||
is_safe_dameng_autotrace_sql(sql)
|
||||
} else {
|
||||
is_safe_explain_sql(sql)
|
||||
};
|
||||
if !safe {
|
||||
return Err("unsafe".to_string());
|
||||
}
|
||||
|
||||
let database_for_pool = database.filter(|value| !value.trim().is_empty());
|
||||
state.get_or_create_pool(connection_id, database_for_pool).await?;
|
||||
|
||||
let client = {
|
||||
let connections = state.connections.read().await;
|
||||
let pool = connections.get(connection_id).ok_or_else(|| "Connection not found".to_string())?;
|
||||
match pool {
|
||||
PoolKind::Agent(client) => client.clone(),
|
||||
_ => return Err("Connection is not an agent-based connection".to_string()),
|
||||
}
|
||||
};
|
||||
|
||||
let timeout_secs = {
|
||||
let configs = state.configs.read().await;
|
||||
configs.get(connection_id).ok_or_else(|| "Connection config not found".to_string())?.query_timeout_secs
|
||||
};
|
||||
|
||||
let params = serde_json::json!({
|
||||
"sql": sql,
|
||||
"database": database.unwrap_or_default(),
|
||||
"schema": schema.unwrap_or_default(),
|
||||
"timeoutSecs": timeout_secs as i64,
|
||||
"mode": mode,
|
||||
});
|
||||
let mut client = client.lock().await;
|
||||
let result: Value = client.get_explain_info(params).await?;
|
||||
decode_agent_explain_result(result)
|
||||
}
|
||||
|
||||
fn decode_agent_explain_result(result: Value) -> Result<String, String> {
|
||||
match result {
|
||||
Value::String(plan) => Ok(plan),
|
||||
Value::Object(object) => Ok(object.get("plan").and_then(Value::as_str).unwrap_or_default().to_string()),
|
||||
value => Err(format!("Unexpected result type from getExplainInfo: {value:?}")),
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn decodes_string_and_object_agent_explain_results() {
|
||||
assert_eq!(decode_agent_explain_result(Value::String("plan text".to_string())).unwrap(), "plan text");
|
||||
assert_eq!(
|
||||
decode_agent_explain_result(serde_json::json!({ "plan": "object plan", "has_actual_stats": false }))
|
||||
.unwrap(),
|
||||
"object plan"
|
||||
);
|
||||
assert!(decode_agent_explain_result(serde_json::json!(["unexpected"])).is_err());
|
||||
}
|
||||
}
|
||||
@@ -598,6 +598,22 @@ async fn execute_explain_query(
|
||||
}
|
||||
}
|
||||
|
||||
if *db_type == DatabaseType::Oracle {
|
||||
return match crate::agent_explain::get_agent_explain_info_core(
|
||||
state,
|
||||
connection_id,
|
||||
Some(database),
|
||||
None,
|
||||
sql,
|
||||
Some("explain"),
|
||||
)
|
||||
.await
|
||||
{
|
||||
Ok(plan) => (Ok(plan.clone()), Some(serde_json::Value::String(plan))),
|
||||
Err(error) => (Err(error), None),
|
||||
};
|
||||
}
|
||||
|
||||
// Build the database-specific EXPLAIN SQL
|
||||
let explain_result = build_explain_sql(ExplainSqlOptions { database_type: Some(*db_type), sql: sql.to_string() });
|
||||
|
||||
@@ -823,6 +839,14 @@ mod tests {
|
||||
));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn oracle_agent_tools_include_explain_query() {
|
||||
let tools = all_tools(DatabaseType::Oracle, AgentSqlPermissions::default());
|
||||
let names: Vec<&str> = tools.iter().map(|tool| tool.name).collect();
|
||||
|
||||
assert!(names.contains(&"explain_query"));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn build_browse_query_qdrant() {
|
||||
let q = build_browse_query(&DatabaseType::Qdrant, "articles", "", 10).unwrap();
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
pub mod agent_catalog;
|
||||
pub mod agent_connection;
|
||||
pub mod agent_events;
|
||||
pub mod agent_explain;
|
||||
pub mod agent_kv;
|
||||
pub mod agent_loop;
|
||||
pub mod agent_manager;
|
||||
|
||||
@@ -37,7 +37,7 @@ pub fn build_explain_sql(options: ExplainSqlOptions) -> ExplainSqlBuildResult {
|
||||
if source.is_empty() {
|
||||
return explain_err("empty");
|
||||
}
|
||||
if !is_safe_explain_source(&source) {
|
||||
if !is_safe_explain_sql(&source) {
|
||||
return explain_err("unsafe");
|
||||
}
|
||||
|
||||
@@ -48,6 +48,7 @@ pub fn build_explain_sql(options: ExplainSqlOptions) -> ExplainSqlBuildResult {
|
||||
Some(DatabaseType::Dameng | DatabaseType::Questdb) => {
|
||||
format!("EXPLAIN {source}")
|
||||
}
|
||||
Some(DatabaseType::Oracle) => format!("EXPLAIN PLAN FOR {source}"),
|
||||
_ => format!("EXPLAIN FORMAT=JSON {source}"),
|
||||
};
|
||||
ExplainSqlBuildResult { ok: true, sql: Some(sql), reason: None }
|
||||
@@ -75,10 +76,24 @@ pub fn build_dropped_file_preview_sql(options: DroppedFilePreviewSqlOptions) ->
|
||||
pub fn supports_explain_plan(database_type: Option<DatabaseType>) -> bool {
|
||||
matches!(
|
||||
database_type,
|
||||
Some(DatabaseType::Mysql | DatabaseType::Postgres | DatabaseType::Questdb | DatabaseType::Dameng)
|
||||
Some(
|
||||
DatabaseType::Mysql
|
||||
| DatabaseType::Postgres
|
||||
| DatabaseType::Questdb
|
||||
| DatabaseType::Dameng
|
||||
| DatabaseType::Oracle
|
||||
)
|
||||
)
|
||||
}
|
||||
|
||||
pub fn is_safe_explain_sql(sql: &str) -> bool {
|
||||
let source = strip_trailing_semicolons(sql.trim());
|
||||
!source.is_empty()
|
||||
&& !has_extra_statement_after_semicolon(&source)
|
||||
&& is_safe_explain_source(&source)
|
||||
&& !contains_dangerous_sql_keyword(&source)
|
||||
}
|
||||
|
||||
/// Returns true for databases that support SQL query execution (execute_query / get_sample_data).
|
||||
/// Non-SQL databases (Redis, MongoDB, Elasticsearch, InfluxDB, Neo4j, etcd) are excluded.
|
||||
pub fn supports_sql_query(database_type: DatabaseType) -> bool {
|
||||
@@ -420,6 +435,23 @@ mod tests {
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn builds_oracle_explain_plan_sql() {
|
||||
let result = build_explain_sql(ExplainSqlOptions {
|
||||
database_type: Some(DatabaseType::Oracle),
|
||||
sql: "WITH rows AS (SELECT 1 AS id FROM dual) SELECT * FROM rows;".to_string(),
|
||||
});
|
||||
|
||||
assert_eq!(
|
||||
result,
|
||||
ExplainSqlBuildResult {
|
||||
ok: true,
|
||||
sql: Some("EXPLAIN PLAN FOR WITH rows AS (SELECT 1 AS id FROM dual) SELECT * FROM rows".to_string()),
|
||||
reason: None,
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn validates_dameng_autotrace_sql_safety() {
|
||||
assert!(is_safe_dameng_autotrace_sql("SELECT * FROM t WHERE name = 'delete';"));
|
||||
@@ -451,6 +483,14 @@ mod tests {
|
||||
}),
|
||||
ExplainSqlBuildResult { ok: false, sql: None, reason: Some("unsafe".to_string()) }
|
||||
);
|
||||
|
||||
assert_eq!(
|
||||
build_explain_sql(ExplainSqlOptions {
|
||||
database_type: Some(DatabaseType::Mysql),
|
||||
sql: "SELECT * FROM users; DELETE FROM users".to_string(),
|
||||
}),
|
||||
ExplainSqlBuildResult { ok: false, sql: None, reason: Some("unsafe".to_string()) }
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
|
||||
Reference in new issue
Block a user