sql-lsp 0.1.3

A high-performance, multi-dialect SQL Language Server Protocol (LSP) implementation in Rust.
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
use crate::dialect::Dialect;
use crate::parser::dsl::DslParser;
use crate::schema::Schema;
use async_trait::async_trait;
use tower_lsp::lsp_types::{
    CompletionItem, CompletionItemKind, Diagnostic, Hover, Location, MarkedString, Position,
};

/// Elasticsearch DSL (Domain Specific Language) 方言
/// 注意:DSL 是基于 JSON 的查询语言,使用 tree-sitter-json 解析
pub struct ElasticsearchDslDialect {
    dsl_parser: std::sync::Mutex<DslParser>,
}

impl Default for ElasticsearchDslDialect {
    fn default() -> Self {
        Self::new()
    }
}

impl ElasticsearchDslDialect {
    pub fn new() -> Self {
        Self {
            dsl_parser: std::sync::Mutex::new(DslParser::new()),
        }
    }

    /// 创建字段补全项
    fn create_field_item(&self, field: &str, detail_prefix: &str) -> CompletionItem {
        CompletionItem {
            label: field.to_string(),
            kind: Some(CompletionItemKind::FIELD),
            detail: Some(format!("{}: {}", detail_prefix, field)),
            documentation: None,
            deprecated: None,
            preselect: None,
            sort_text: Some(format!("1{}", field)),
            filter_text: None,
            insert_text: Some(format!("\"{}\"", field)),
            insert_text_format: None,
            insert_text_mode: None,
            text_edit: None,
            additional_text_edits: None,
            commit_characters: None,
            command: None,
            data: None,
            tags: None,
            label_details: None,
        }
    }

    /// 创建查询类型补全项
    fn create_query_type_item(&self, query_type: &str) -> CompletionItem {
        CompletionItem {
            label: query_type.to_string(),
            kind: Some(CompletionItemKind::KEYWORD),
            detail: Some(format!("Elasticsearch DSL query type: {}", query_type)),
            documentation: None,
            deprecated: None,
            preselect: None,
            sort_text: Some(format!("0{}", query_type)),
            filter_text: None,
            insert_text: Some(format!("\"{}\"", query_type)),
            insert_text_format: None,
            insert_text_mode: None,
            text_edit: None,
            additional_text_edits: None,
            commit_characters: None,
            command: None,
            data: None,
            tags: None,
            label_details: None,
        }
    }

    /// 创建聚合类型补全项
    fn create_agg_type_item(&self, agg_type: &str) -> CompletionItem {
        CompletionItem {
            label: agg_type.to_string(),
            kind: Some(CompletionItemKind::FUNCTION),
            detail: Some(format!("Elasticsearch aggregation: {}", agg_type)),
            documentation: None,
            deprecated: None,
            preselect: None,
            sort_text: Some(format!("2{}", agg_type)),
            filter_text: None,
            insert_text: Some(format!("\"{}\"", agg_type)),
            insert_text_format: None,
            insert_text_mode: None,
            text_edit: None,
            additional_text_edits: None,
            commit_characters: None,
            command: None,
            data: None,
            tags: None,
            label_details: None,
        }
    }

    /// 递归查找字段引用
    #[allow(clippy::only_used_in_recursion)]
    fn find_field_references_recursive(
        &self,
        node: tree_sitter::Node,
        source: &str,
        field_name: &str,
        uri: &tower_lsp::lsp_types::Url,
        locations: &mut Vec<Location>,
        parser: &crate::parser::dsl::DslParser,
    ) {
        if node.kind() == "pair" {
            if let Some(key_node) = node.child(0) {
                if let Ok(key_text) = key_node.utf8_text(source.as_bytes()) {
                    let key = key_text.trim_matches('"').trim_matches('\'');
                    if key == field_name {
                        locations.push(Location {
                            uri: uri.clone(),
                            range: parser.node_range(key_node),
                        });
                    }
                }
            }
        }

        let mut cursor = node.walk();
        for child in node.children(&mut cursor) {
            self.find_field_references_recursive(child, source, field_name, uri, locations, parser);
        }
    }
}

#[async_trait]
impl Dialect for ElasticsearchDslDialect {
    fn name(&self) -> &str {
        "elasticsearch-dsl"
    }

    async fn parse(&self, dsl: &str, _schema: Option<&Schema>) -> Vec<Diagnostic> {
        // 使用 tree-sitter-json 解析 DSL(保持与 SQL 解析器的一致性)
        let mut parser = self.dsl_parser.lock().unwrap();
        parser.parse(dsl)
    }

    async fn completion(
        &self,
        dsl: &str,
        position: Position,
        schema: Option<&Schema>,
    ) -> Vec<CompletionItem> {
        let mut parser = self.dsl_parser.lock().unwrap();
        let (tree, _) = parser.parse_with_tree(dsl);

        // 分析补全上下文
        let context = if let Some(ref tree) = tree {
            if let Some(node) = parser.get_node_at_position(tree, position) {
                parser.analyze_completion_context(node, dsl)
            } else {
                crate::parser::DslCompletionContext::Default
            }
        } else {
            crate::parser::DslCompletionContext::Default
        };

        let mut items = Vec::new();

        // 根据上下文提供不同的补全
        match context {
            crate::parser::DslCompletionContext::TopLevel => {
                // 顶级字段
                let top_level_fields = vec![
                    "query",
                    "aggs",
                    "aggregations",
                    "sort",
                    "from",
                    "size",
                    "source",
                    "_source",
                    "fields",
                    "highlight",
                    "suggest",
                    "script_fields",
                    "docvalue_fields",
                    "stored_fields",
                    "post_filter",
                    "min_score",
                    "timeout",
                    "terminate_after",
                ];

                for field in top_level_fields {
                    items.push(self.create_field_item(field, "Elasticsearch DSL field"));
                }
            }

            crate::parser::DslCompletionContext::QueryObject => {
                // 查询类型
                let query_types = vec![
                    "match",
                    "match_all",
                    "match_none",
                    "match_phrase",
                    "match_phrase_prefix",
                    "multi_match",
                    "common",
                    "query_string",
                    "simple_query_string",
                    "term",
                    "terms",
                    "range",
                    "exists",
                    "prefix",
                    "wildcard",
                    "regexp",
                    "fuzzy",
                    "type",
                    "ids",
                    "constant_score",
                    "bool",
                    "boosting",
                    "dis_max",
                    "function_score",
                    "script_score",
                    "percolate",
                ];

                for query_type in query_types {
                    items.push(self.create_query_type_item(query_type));
                }
            }

            crate::parser::DslCompletionContext::AggsObject => {
                // 聚合类型
                let agg_types = vec![
                    "terms",
                    "range",
                    "date_range",
                    "ip_range",
                    "histogram",
                    "date_histogram",
                    "geo_distance",
                    "geohash_grid",
                    "geotile_grid",
                    "filters",
                    "adjacency_matrix",
                    "sampler",
                    "diversified_sampler",
                    "global",
                    "filter",
                    "missing",
                    "nested",
                    "reverse_nested",
                    "children",
                    "parent",
                    "cardinality",
                    "avg",
                    "sum",
                    "min",
                    "max",
                    "stats",
                    "extended_stats",
                    "percentiles",
                    "percentile_ranks",
                    "top_hits",
                    "scripted_metric",
                    "matrix_stats",
                    "bucket_script",
                    "bucket_selector",
                    "bucket_sort",
                    "serial_diff",
                    "moving_avg",
                ];

                for agg_type in agg_types {
                    items.push(self.create_agg_type_item(agg_type));
                }
            }

            crate::parser::DslCompletionContext::BoolQuery => {
                // bool 查询的子字段
                let bool_fields = vec!["must", "must_not", "should", "filter"];

                for field in bool_fields {
                    items.push(self.create_field_item(field, "Bool query field"));
                }
            }

            crate::parser::DslCompletionContext::SortObject => {
                // sort 字段(可以是字段名或特殊值)
                if let Some(schema) = schema {
                    for table in &schema.tables {
                        for column in &table.columns {
                            items.push(self.create_field_item(&column.name, "Sort field"));
                        }
                    }
                }

                // 排序方向
                items.push(self.create_field_item("_score", "Sort by score"));
                items.push(self.create_field_item("_doc", "Sort by document order"));
            }

            crate::parser::DslCompletionContext::Default => {
                // 默认:返回所有类型
                let query_types = vec![
                    "match",
                    "match_all",
                    "match_none",
                    "match_phrase",
                    "match_phrase_prefix",
                    "multi_match",
                    "common",
                    "query_string",
                    "simple_query_string",
                    "term",
                    "terms",
                    "range",
                    "exists",
                    "prefix",
                    "wildcard",
                    "regexp",
                    "fuzzy",
                    "type",
                    "ids",
                    "constant_score",
                    "bool",
                    "boosting",
                    "dis_max",
                    "function_score",
                    "script_score",
                    "percolate",
                ];

                for query_type in query_types {
                    items.push(self.create_query_type_item(query_type));
                }

                let top_level_fields = vec![
                    "query",
                    "aggs",
                    "aggregations",
                    "sort",
                    "from",
                    "size",
                    "source",
                    "_source",
                    "fields",
                    "highlight",
                    "suggest",
                ];

                for field in top_level_fields {
                    items.push(self.create_field_item(field, "Elasticsearch DSL field"));
                }
            }
        }

        // 如果提供了 schema,添加索引名补全
        if let Some(schema) = schema {
            for table in &schema.tables {
                items.push(CompletionItem {
                    label: table.name.clone(),
                    kind: Some(CompletionItemKind::CLASS),
                    detail: Some(format!("Elasticsearch Index: {}", table.name)),
                    documentation: table
                        .comment
                        .clone()
                        .map(tower_lsp::lsp_types::Documentation::String),
                    deprecated: None,
                    preselect: None,
                    sort_text: Some(format!("3{}", table.name)),
                    filter_text: None,
                    insert_text: Some(format!("\"{}\"", table.name)),
                    insert_text_format: None,
                    insert_text_mode: None,
                    text_edit: None,
                    additional_text_edits: None,
                    commit_characters: None,
                    command: None,
                    data: None,
                    tags: None,
                    label_details: None,
                });
            }
        }

        items
    }

    async fn hover(
        &self,
        sql: &str,
        _position: Position,
        schema: Option<&Schema>,
    ) -> Option<Hover> {
        if let Some(schema) = schema {
            for table in &schema.tables {
                if sql.contains(&table.name) {
                    return Some(Hover {
                        contents: tower_lsp::lsp_types::HoverContents::Scalar(
                            MarkedString::String(format!(
                                "Elasticsearch DSL Index: {}\n{}",
                                table.name,
                                table.comment.as_deref().unwrap_or("No description")
                            )),
                        ),
                        range: None,
                    });
                }
            }
        }
        None
    }

    async fn goto_definition(
        &self,
        dsl: &str,
        position: Position,
        schema: Option<&Schema>,
    ) -> Option<Location> {
        let mut parser = self.dsl_parser.lock().unwrap();
        let (tree, _) = parser.parse_with_tree(dsl);

        if let Some(ref tree) = tree {
            if let Some(node) = parser.get_node_at_position(tree, position) {
                // 提取字段名
                if let Some(field_name) = parser.extract_field_name(node, dsl) {
                    // 如果是索引名,在 schema 中查找
                    if let Some(schema) = schema {
                        if schema.tables.iter().any(|t| t.name == field_name) {
                            return Some(Location {
                                uri: tower_lsp::lsp_types::Url::parse("file:///schema.json")
                                    .unwrap_or_else(|_| {
                                        tower_lsp::lsp_types::Url::parse("file:///").unwrap()
                                    }),
                                range: parser.node_range(node),
                            });
                        }
                    }
                }
            }
        }

        None
    }

    async fn references(
        &self,
        dsl: &str,
        position: Position,
        _schema: Option<&Schema>,
    ) -> Vec<Location> {
        let mut parser = self.dsl_parser.lock().unwrap();
        let (tree, _) = parser.parse_with_tree(dsl);
        let mut locations = Vec::new();

        if let Some(ref tree) = tree {
            if let Some(node) = parser.get_node_at_position(tree, position) {
                // 提取字段名
                if let Some(field_name) = parser.extract_field_name(node, dsl) {
                    // 在当前文档中查找所有引用
                    let current_uri = tower_lsp::lsp_types::Url::parse("file:///current.json")
                        .unwrap_or_else(|_| tower_lsp::lsp_types::Url::parse("file:///").unwrap());

                    // 遍历所有字段,查找匹配的
                    let root = tree.root_node();
                    let mut cursor = root.walk();
                    for child in root.children(&mut cursor) {
                        self.find_field_references_recursive(
                            child,
                            dsl,
                            &field_name,
                            &current_uri,
                            &mut locations,
                            &parser,
                        );
                    }
                }
            }
        }

        locations
    }

    async fn format(&self, sql: &str) -> String {
        // DSL 格式化:尝试美化 JSON
        // 这里简化处理,实际应该使用 JSON 格式化库
        sql.split_whitespace().collect::<Vec<_>>().join(" ")
    }

    async fn validate(&self, sql: &str, schema: Option<&Schema>) -> Vec<Diagnostic> {
        self.parse(sql, schema).await
    }
}