fix(influxdb): gate quick-open rolling time window behind opt-in
This commit is contained in:
1 parent
945285ef09
commit
84669b0d1a
6 files changed
+127
-12
No files matched your search
@@ -93,6 +93,7 @@ export function useDataGridActions(activeTab: ComputedRef<QueryTab | undefined>)
|
|||||||
includeDatabaseName: settingsStore.editorSettings.generateSqlIncludeDatabaseName,
|
includeDatabaseName: settingsStore.editorSettings.generateSqlIncludeDatabaseName,
|
||||||
includeRowId: useRowId,
|
includeRowId: useRowId,
|
||||||
limit,
|
limit,
|
||||||
|
injectDefaultTimeSeriesWhere: true,
|
||||||
...options,
|
...options,
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -147,6 +147,7 @@ async function openTableTarget(target: NavigationTarget, options: { tableInfoTab
|
|||||||
database: target.database,
|
database: target.database,
|
||||||
tableName: target.tableName,
|
tableName: target.tableName,
|
||||||
includeDatabaseName: settingsStore.editorSettings.generateSqlIncludeDatabaseName,
|
includeDatabaseName: settingsStore.editorSettings.generateSqlIncludeDatabaseName,
|
||||||
|
injectDefaultTimeSeriesWhere: true,
|
||||||
tableType: targetTableType,
|
tableType: targetTableType,
|
||||||
columns: columns.map((column) => column.name),
|
columns: columns.map((column) => column.name),
|
||||||
primaryKeys,
|
primaryKeys,
|
||||||
@@ -240,6 +241,7 @@ async function openTableTarget(target: NavigationTarget, options: { tableInfoTab
|
|||||||
database: target.database,
|
database: target.database,
|
||||||
tableName: target.tableName,
|
tableName: target.tableName,
|
||||||
includeDatabaseName: settingsStore.editorSettings.generateSqlIncludeDatabaseName,
|
includeDatabaseName: settingsStore.editorSettings.generateSqlIncludeDatabaseName,
|
||||||
|
injectDefaultTimeSeriesWhere: true,
|
||||||
tableType: targetTableType,
|
tableType: targetTableType,
|
||||||
whereInput: target.whereInput,
|
whereInput: target.whereInput,
|
||||||
limit: 0,
|
limit: 0,
|
||||||
@@ -286,6 +288,7 @@ async function openTableTarget(target: NavigationTarget, options: { tableInfoTab
|
|||||||
database: target.database,
|
database: target.database,
|
||||||
tableName: target.tableName,
|
tableName: target.tableName,
|
||||||
includeDatabaseName: settingsStore.editorSettings.generateSqlIncludeDatabaseName,
|
includeDatabaseName: settingsStore.editorSettings.generateSqlIncludeDatabaseName,
|
||||||
|
injectDefaultTimeSeriesWhere: true,
|
||||||
tableType: targetTableType,
|
tableType: targetTableType,
|
||||||
whereInput: target.whereInput,
|
whereInput: target.whereInput,
|
||||||
primaryKeys,
|
primaryKeys,
|
||||||
|
|||||||
@@ -350,6 +350,7 @@ export function useSidebarDataOpenRuntime() {
|
|||||||
includeDatabaseName: settingsStore.editorSettings.generateSqlIncludeDatabaseName,
|
includeDatabaseName: settingsStore.editorSettings.generateSqlIncludeDatabaseName,
|
||||||
limit,
|
limit,
|
||||||
includeRowId,
|
includeRowId,
|
||||||
|
injectDefaultTimeSeriesWhere: true,
|
||||||
});
|
});
|
||||||
// SQL 构建是异步后端调用:期间更晚的导航(openData/openTableTarget)
|
// SQL 构建是异步后端调用:期间更晚的导航(openData/openTableTarget)
|
||||||
// 接管会替换 executionId,旧流程不得再覆盖 SQL/启动查询
|
// 接管会替换 executionId,旧流程不得再覆盖 SQL/启动查询
|
||||||
|
|||||||
@@ -26,6 +26,8 @@ export interface BuildTableSelectSqlOptions {
|
|||||||
offset?: number;
|
offset?: number;
|
||||||
useDriverRowOffset?: boolean;
|
useDriverRowOffset?: boolean;
|
||||||
whereInput?: string;
|
whereInput?: string;
|
||||||
|
/** Time-series quick-open: inject a rolling `time` window when no WHERE is supplied. */
|
||||||
|
injectDefaultTimeSeriesWhere?: boolean;
|
||||||
includeRowId?: boolean;
|
includeRowId?: boolean;
|
||||||
catalog?: string;
|
catalog?: string;
|
||||||
database?: string;
|
database?: string;
|
||||||
|
|||||||
@@ -239,7 +239,20 @@ pub fn build_table_data_select_sql_with_database(
|
|||||||
)
|
)
|
||||||
};
|
};
|
||||||
let predicate = normalize_where_input(options.where_input.as_deref());
|
let predicate = normalize_where_input(options.where_input.as_deref());
|
||||||
let where_clause = if predicate.is_empty() { String::new() } else { format!(" WHERE ({predicate})") };
|
// Time-series engines like InfluxDB scan every shard when no time
|
||||||
|
// predicate is given, which turns the sidebar quick-open ("show me
|
||||||
|
// the latest rows") into a full-shard scan on any non-trivial
|
||||||
|
// dataset. Data-tab callers opt in to a rolling 5-minute window when
|
||||||
|
// the user has not provided their own WHERE; sampling and export
|
||||||
|
// callers keep the historical unfiltered behavior, and users can
|
||||||
|
// broaden the window by editing the SQL.
|
||||||
|
let effective_predicate = if predicate.is_empty() && options.inject_default_time_series_where {
|
||||||
|
default_time_series_predicate(database_type).unwrap_or_default()
|
||||||
|
} else {
|
||||||
|
predicate
|
||||||
|
};
|
||||||
|
let where_clause =
|
||||||
|
if effective_predicate.is_empty() { String::new() } else { format!(" WHERE ({effective_predicate})") };
|
||||||
let default_order_by = if matches!(database_type, Some(DatabaseType::InfluxDb) | Some(DatabaseType::InfluxDb3)) {
|
let default_order_by = if matches!(database_type, Some(DatabaseType::InfluxDb) | Some(DatabaseType::InfluxDb3)) {
|
||||||
// InfluxQL only allows sorting of the timestamp column; SQL-mode
|
// InfluxQL only allows sorting of the timestamp column; SQL-mode
|
||||||
// InfluxDB 3 tables also key naturally on `time`.
|
// InfluxDB 3 tables also key naturally on `time`.
|
||||||
@@ -389,6 +402,32 @@ pub fn build_table_data_select_sql_with_database(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Default WHERE predicate for time-series engines whose data model
|
||||||
|
/// makes an unbounded `SELECT *` an accidental full-shard scan. When a
|
||||||
|
/// data-tab caller opts in and the user has not supplied their own
|
||||||
|
/// WHERE, we inject a rolling five-minute window on the mandatory
|
||||||
|
/// `time` column so that sidebar quick-open queries stay cheap on
|
||||||
|
/// production-sized tables. Users can broaden or drop the filter by
|
||||||
|
/// editing the generated SQL.
|
||||||
|
///
|
||||||
|
/// Syntax is per-engine and cannot be shared:
|
||||||
|
///
|
||||||
|
/// * **InfluxDB 1.x / 2.x** — sidebar SELECTs go to the `/query`
|
||||||
|
/// endpoint and are parsed as InfluxQL. InfluxQL accepts Go-style
|
||||||
|
/// duration literals directly (`5m`, `1h`, `30s`).
|
||||||
|
/// * **InfluxDB 3.x** — queries go through DataFusion SQL and require
|
||||||
|
/// ANSI interval literals (`INTERVAL '5 minutes'`).
|
||||||
|
///
|
||||||
|
/// Returns `None` for engines where no default is appropriate — the
|
||||||
|
/// caller then falls through to the historical unfiltered behavior.
|
||||||
|
fn default_time_series_predicate(database_type: Option<DatabaseType>) -> Option<String> {
|
||||||
|
match database_type? {
|
||||||
|
DatabaseType::InfluxDb => Some("time > now() - 5m".to_string()),
|
||||||
|
DatabaseType::InfluxDb3 => Some("time > now() - INTERVAL '5 minutes'".to_string()),
|
||||||
|
_ => None,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
/// Returns a `database.table` reference for engines whose active database is
|
/// Returns a `database.table` reference for engines whose active database is
|
||||||
/// normally omitted from table-data SQL. Doris and StarRocks retain an external
|
/// normally omitted from table-data SQL. Doris and StarRocks retain an external
|
||||||
/// catalog prefix when one is selected.
|
/// catalog prefix when one is selected.
|
||||||
@@ -633,15 +672,14 @@ pub(super) fn build_select_columns(
|
|||||||
.collect::<Vec<_>>()
|
.collect::<Vec<_>>()
|
||||||
.join(", ");
|
.join(", ");
|
||||||
}
|
}
|
||||||
|
// Everything outside the Hive-family identifier projection reads
|
||||||
|
// `SELECT *`. That includes InfluxDB (v1 / v2 / 3.x), whose tables
|
||||||
|
// can carry dozens of tags and fields — a full column list turns the
|
||||||
|
// generated SQL into a wall of names, while InfluxQL supports `*`
|
||||||
|
// natively and users can narrow the projection by editing the SQL.
|
||||||
if !matches!(
|
if !matches!(
|
||||||
database_type,
|
database_type,
|
||||||
Some(
|
Some(DatabaseType::Hive | DatabaseType::Kyuubi | DatabaseType::Impala | DatabaseType::Argo)
|
||||||
DatabaseType::Hive
|
|
||||||
| DatabaseType::Kyuubi
|
|
||||||
| DatabaseType::Impala
|
|
||||||
| DatabaseType::Argo
|
|
||||||
| DatabaseType::InfluxDb
|
|
||||||
)
|
|
||||||
) {
|
) {
|
||||||
return "*".to_string();
|
return "*".to_string();
|
||||||
}
|
}
|
||||||
@@ -808,26 +846,91 @@ mod tests {
|
|||||||
offset: None,
|
offset: None,
|
||||||
use_driver_row_offset: false,
|
use_driver_row_offset: false,
|
||||||
where_input: None,
|
where_input: None,
|
||||||
|
inject_default_time_series_where: false,
|
||||||
include_row_id: false,
|
include_row_id: false,
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn influxdb_table_select_quotes_explicit_columns() {
|
fn influxdb_table_select_uses_star_and_rolling_window() {
|
||||||
// InfluxQL needs double-quoted identifiers and only permits ORDER BY on
|
// InfluxDB tables can carry dozens of tags/fields; enumerating them
|
||||||
// the time column; explicit column lists must not fall back to "*".
|
// all in the SELECT list produces an unreadable wall of names.
|
||||||
|
// Emit `SELECT *` (InfluxQL supports it natively) and inject a
|
||||||
|
// rolling five-minute WHERE so the query stays cheap on production
|
||||||
|
// data. Users can narrow the projection or widen the window by
|
||||||
|
// editing the generated SQL.
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
build_table_data_select_sql(TableDataSelectSqlOptions {
|
build_table_data_select_sql(TableDataSelectSqlOptions {
|
||||||
database_type: Some(DatabaseType::InfluxDb),
|
database_type: Some(DatabaseType::InfluxDb),
|
||||||
database: Some("monitor".to_string()),
|
database: Some("monitor".to_string()),
|
||||||
table_name: "cpu".to_string(),
|
table_name: "cpu".to_string(),
|
||||||
columns: vec!["time".to_string(), "host".to_string(), "value".to_string()],
|
columns: vec!["time".to_string(), "host".to_string(), "value".to_string()],
|
||||||
|
inject_default_time_series_where: true,
|
||||||
..Default::default()
|
..Default::default()
|
||||||
}),
|
}),
|
||||||
"SELECT \"time\", \"host\", \"value\" FROM \"cpu\" ORDER BY time DESC LIMIT 100;"
|
"SELECT * FROM \"cpu\" WHERE (time > now() - 5m) ORDER BY time DESC LIMIT 100;"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn influxdb3_table_select_injects_datafusion_interval() {
|
||||||
|
// InfluxDB 3.x runs DataFusion SQL, which needs ANSI INTERVAL
|
||||||
|
// literals rather than InfluxQL's Go-style duration form.
|
||||||
|
assert_eq!(
|
||||||
|
build_table_data_select_sql(TableDataSelectSqlOptions {
|
||||||
|
database_type: Some(DatabaseType::InfluxDb3),
|
||||||
|
database: Some("monitor".to_string()),
|
||||||
|
table_name: "cpu".to_string(),
|
||||||
|
inject_default_time_series_where: true,
|
||||||
|
..Default::default()
|
||||||
|
}),
|
||||||
|
"SELECT * FROM \"cpu\" WHERE (time > now() - INTERVAL '5 minutes') ORDER BY time DESC LIMIT 100;"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn influxdb_table_select_without_opt_in_stays_unfiltered() {
|
||||||
|
// Sampling (agent_tools) and whole-table export (csv_export) build
|
||||||
|
// SQL without the opt-in flag and must keep the historical
|
||||||
|
// unbounded scan semantics.
|
||||||
|
let sql = build_table_data_select_sql(TableDataSelectSqlOptions {
|
||||||
|
database_type: Some(DatabaseType::InfluxDb),
|
||||||
|
database: Some("monitor".to_string()),
|
||||||
|
table_name: "cpu".to_string(),
|
||||||
|
..Default::default()
|
||||||
|
});
|
||||||
|
assert!(!sql.contains("WHERE"), "unexpected default WHERE in non-opt-in SQL: {sql}");
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn influxdb_table_select_honors_user_supplied_where() {
|
||||||
|
// When the caller passes their own predicate the default window is
|
||||||
|
// dropped — otherwise widening the range would require a new option.
|
||||||
|
assert_eq!(
|
||||||
|
build_table_data_select_sql(TableDataSelectSqlOptions {
|
||||||
|
database_type: Some(DatabaseType::InfluxDb),
|
||||||
|
database: Some("monitor".to_string()),
|
||||||
|
table_name: "cpu".to_string(),
|
||||||
|
where_input: Some("host = 'web-01'".to_string()),
|
||||||
|
..Default::default()
|
||||||
|
}),
|
||||||
|
"SELECT * FROM \"cpu\" WHERE (host = 'web-01') ORDER BY time DESC LIMIT 100;"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn non_time_series_engines_get_no_default_where() {
|
||||||
|
// The rolling-window default is scoped to time-series engines; other
|
||||||
|
// dialects keep their historical unfiltered behavior.
|
||||||
|
let sql = build_table_data_select_sql(TableDataSelectSqlOptions {
|
||||||
|
database_type: Some(DatabaseType::Postgres),
|
||||||
|
schema: Some("public".to_string()),
|
||||||
|
table_name: "orders".to_string(),
|
||||||
|
..Default::default()
|
||||||
|
});
|
||||||
|
assert!(!sql.contains("WHERE"), "unexpected WHERE in non-time-series SQL: {sql}");
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn databricks_table_select_uses_backtick_identifiers() {
|
fn databricks_table_select_uses_backtick_identifiers() {
|
||||||
assert_eq!(
|
assert_eq!(
|
||||||
|
|||||||
@@ -68,6 +68,11 @@ pub struct TableDataSelectSqlOptions {
|
|||||||
pub use_driver_row_offset: bool,
|
pub use_driver_row_offset: bool,
|
||||||
#[serde(default, skip_serializing_if = "Option::is_none")]
|
#[serde(default, skip_serializing_if = "Option::is_none")]
|
||||||
pub where_input: Option<String>,
|
pub where_input: Option<String>,
|
||||||
|
/// Time-series quick-open ergonomics: inject a rolling `time` window
|
||||||
|
/// when no WHERE was supplied. Opt-in so sampling and export callers
|
||||||
|
/// keep the historical unbounded scan semantics.
|
||||||
|
#[serde(default)]
|
||||||
|
pub inject_default_time_series_where: bool,
|
||||||
#[serde(default)]
|
#[serde(default)]
|
||||||
pub include_row_id: bool,
|
pub include_row_id: bool,
|
||||||
}
|
}
|
||||||
Reference in new issue
Block a user