rigsql-rules 0.7.0

Lint rules (sqlfluff-compatible) for the rigsql SQL linter
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

use rigsql_core::SegmentType;

use crate::rule::{CrawlType, Rule, RuleContext, RuleGroup};
use crate::violation::LintViolation;

/// ST11: Unused JOIN (join without reference in SELECT or WHERE).
///
/// This is a stub rule. The full implementation would require complex
/// cross-reference analysis to determine if a joined table is actually
/// used in the query.
#[derive(Debug, Default)]
pub struct RuleST11;

impl Rule for RuleST11 {
    fn code(&self) -> &'static str {
        "ST11"
    }
    fn name(&self) -> &'static str {
        "structure.unused_join"
    }
    fn description(&self) -> &'static str {
        "Joined table is not referenced in the query."
    }
    fn explanation(&self) -> &'static str {
        "A table that is joined but never referenced in the SELECT, WHERE, or other \
         clauses may be unnecessary. Remove unused joins to simplify the query and \
         improve performance. This rule is currently a stub."
    }
    fn groups(&self) -> &[RuleGroup] {
        &[RuleGroup::Structure]
    }
    fn is_fixable(&self) -> bool {
        false
    }

    fn crawl_type(&self) -> CrawlType {
        CrawlType::Segment(vec![SegmentType::SelectStatement])
    }

    fn eval(&self, _ctx: &RuleContext) -> Vec<LintViolation> {
        // Stub: not implemented yet
        vec![]
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_utils::lint_sql;

    #[test]
    fn test_st11_no_false_positives() {
        let violations = lint_sql("SELECT a.id FROM a JOIN b ON a.id = b.id;", RuleST11);
        assert_eq!(violations.len(), 0);
    }
}