selene-db-gql 1.3.0

ISO/IEC 39075:2024 GQL parser, planner, optimizer, and executor for selene-db.
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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
//! Multi-statement parser entry point and statement-boundary scanner.

use crate::{
    ast::{
        DdlStatement, EdgePattern, ExistsBody, GraphPattern, InlineProcedureCall, MatchClause,
        MutationPipeline, MutationStatement, MutationTerminator, NodePattern, PatternElement,
        ProcedureCall, QueryPipeline, ReturnClause, ReturnItem, SetItem, SourceSpan, Statement,
        TypePropertyConstraint, TypePropertyDef, ValueExpr, WithClause,
    },
    error::ParserError,
};

use super::{parse, to_u32};

/// Parse semicolon-separated GQL statements.
///
/// Semicolons inside strings, delimited identifiers, and comments do not split
/// statements. Empty segments are skipped.
///
/// # DoS guards are enforced per-statement, not per-call
///
/// Each non-empty segment is handed to [`parse`], which runs the nesting
/// nesting guard over that segment alone. The syntactic nesting
/// limit therefore applies to each statement's own delimiter depth rather
/// than the summed depth of the whole input. A single segment that exceeds
/// the guard is rejected with that segment's error, span-rebased to the
/// original multi-statement source; preceding statements that already parsed
/// are discarded with it.
///
/// # Errors
///
/// Returns the first [`ParserError`] produced by a non-empty segment, with its
/// source span rebased to the original multi-statement source.
pub fn parse_many(source: &str) -> Result<Vec<Statement>, ParserError> {
    let segments = scan_statement_boundaries(source);
    let mut statements = Vec::with_capacity(segments.len());
    for (start, slice) in segments {
        if slice.trim().is_empty() {
            continue;
        }
        match parse(slice) {
            Ok(mut statement) => {
                rebase_statement_spans(&mut statement, start);
                statements.push(statement);
            }
            Err(mut error) => {
                rebase_parser_error(&mut error, start);
                return Err(error);
            }
        }
    }
    Ok(statements)
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
enum ScanState {
    Normal,
    SingleQuote,
    DoubleQuote,
    NoEscapeSingleQuote,
    NoEscapeDoubleQuote,
    NoEscapeBacktick,
    Backtick,
    LineComment,
    BlockComment,
}

fn scan_statement_boundaries(source: &str) -> Vec<(usize, &str)> {
    let bytes = source.as_bytes();
    let last_single_quote = bytes.iter().rposition(|byte| *byte == b'\'');
    let last_double_quote = bytes.iter().rposition(|byte| *byte == b'"');
    let last_backtick = bytes.iter().rposition(|byte| *byte == b'`');
    let mut segments = Vec::new();
    let mut start = 0;
    let mut index = 0;
    let mut state = ScanState::Normal;
    while index < bytes.len() {
        match state {
            ScanState::Normal => match bytes[index] {
                b';' => {
                    segments.push((start, &source[start..index]));
                    index += 1;
                    start = index;
                }
                b'@' if bytes.get(index + 1) == Some(&b'\'') => {
                    state = ScanState::NoEscapeSingleQuote;
                    index += 2;
                }
                b'@' if bytes.get(index + 1) == Some(&b'"') => {
                    state = ScanState::NoEscapeDoubleQuote;
                    index += 2;
                }
                b'@' if bytes.get(index + 1) == Some(&b'`') => {
                    state = ScanState::NoEscapeBacktick;
                    index += 2;
                }
                b'\'' => {
                    state = ScanState::SingleQuote;
                    index += 1;
                }
                b'"' => {
                    state = ScanState::DoubleQuote;
                    index += 1;
                }
                b'`' => {
                    state = ScanState::Backtick;
                    index += 1;
                }
                b'/' if bytes.get(index + 1) == Some(&b'/') => {
                    state = ScanState::LineComment;
                    index += 2;
                }
                b'-' if bytes.get(index + 1) == Some(&b'-') => {
                    state = ScanState::LineComment;
                    index += 2;
                }
                b'/' if bytes.get(index + 1) == Some(&b'*') => {
                    state = ScanState::BlockComment;
                    index += 2;
                }
                _ => index += 1,
            },
            ScanState::NoEscapeSingleQuote => match bytes[index] {
                b'\'' => {
                    state = ScanState::Normal;
                    index += 1;
                }
                _ => index += 1,
            },
            ScanState::NoEscapeDoubleQuote => match bytes[index] {
                b'"' => {
                    state = ScanState::Normal;
                    index += 1;
                }
                _ => index += 1,
            },
            ScanState::NoEscapeBacktick => match bytes[index] {
                b'`' => {
                    state = ScanState::Normal;
                    index += 1;
                }
                _ => index += 1,
            },
            ScanState::SingleQuote => match bytes[index] {
                b'\\'
                    if bytes.get(index + 1) == Some(&b'\'')
                        && Some(index + 1) == last_single_quote =>
                {
                    state = ScanState::Normal;
                    index += 2;
                }
                b'\\' => index = (index + 2).min(bytes.len()),
                b'\'' if bytes.get(index + 1) == Some(&b'\'') => index += 2,
                b'\'' => {
                    state = ScanState::Normal;
                    index += 1;
                }
                _ => index += 1,
            },
            ScanState::DoubleQuote => match bytes[index] {
                b'\\'
                    if bytes.get(index + 1) == Some(&b'"')
                        && Some(index + 1) == last_double_quote =>
                {
                    state = ScanState::Normal;
                    index += 2;
                }
                b'\\' => index = (index + 2).min(bytes.len()),
                b'"' if bytes.get(index + 1) == Some(&b'"') => index += 2,
                b'"' => {
                    state = ScanState::Normal;
                    index += 1;
                }
                _ => index += 1,
            },
            ScanState::Backtick => match bytes[index] {
                b'\\'
                    if bytes.get(index + 1) == Some(&b'`') && Some(index + 1) == last_backtick =>
                {
                    state = ScanState::Normal;
                    index += 2;
                }
                b'\\' => index = (index + 2).min(bytes.len()),
                b'`' if bytes.get(index + 1) == Some(&b'`') => index += 2,
                b'`' => {
                    state = ScanState::Normal;
                    index += 1;
                }
                _ => index += 1,
            },
            ScanState::LineComment => {
                if bytes[index] == b'\n' {
                    state = ScanState::Normal;
                }
                index += 1;
            }
            ScanState::BlockComment => {
                if bytes[index] == b'*' && bytes.get(index + 1) == Some(&b'/') {
                    state = ScanState::Normal;
                    index += 2;
                } else {
                    index += 1;
                }
            }
        }
    }
    segments.push((start, &source[start..]));
    segments
}

fn rebase_parser_error(error: &mut ParserError, offset: usize) {
    match error {
        ParserError::SyntaxError { span, .. }
        | ParserError::UnsupportedFeature { span, .. }
        | ParserError::NestingLimitExceeded { span, .. }
        | ParserError::ComplexityLimitExceeded { span, .. }
        | ParserError::NotImplemented { span, .. } => rebase_span(span, offset),
    }
}

fn rebase_statement_spans(statement: &mut Statement, offset: usize) {
    match statement {
        Statement::Query(pipeline) => rebase_query_pipeline(pipeline, offset),
        Statement::Composite { first, rest, span } => {
            rebase_span(span, offset);
            rebase_query_pipeline(first, offset);
            for (_, pipeline) in rest {
                rebase_query_pipeline(pipeline, offset);
            }
        }
        Statement::Chained { blocks, span } => {
            rebase_span(span, offset);
            for pipeline in blocks {
                rebase_query_pipeline(pipeline, offset);
            }
        }
        Statement::Mutate(pipeline) => rebase_mutation_pipeline(pipeline, offset),
        Statement::Ddl(statement) => rebase_ddl(statement, offset),
        Statement::Call(call) => rebase_call(call, offset),
        Statement::Explain { inner, span } => {
            rebase_span(span, offset);
            rebase_statement_spans(inner, offset);
        }
        Statement::StartTransaction { span }
        | Statement::Commit { span }
        | Statement::Rollback { span } => rebase_span(span, offset),
        Statement::SessionSetValue { value, span, .. } => {
            rebase_span(span, offset);
            rebase_value(value, offset);
        }
        Statement::SessionSetTimeZone { span, .. }
        | Statement::SessionSetGraph { span, .. }
        | Statement::SessionReset { span, .. }
        | Statement::SessionClose { span } => rebase_span(span, offset),
    }
}

fn rebase_query_pipeline(pipeline: &mut QueryPipeline, offset: usize) {
    rebase_span(&mut pipeline.span, offset);
    for statement in &mut pipeline.statements {
        match statement {
            crate::PipelineStatement::Match(value) => rebase_match(value, offset),
            crate::PipelineStatement::Filter(value) => rebase_value(value, offset),
            crate::PipelineStatement::Let(values) => {
                for value in values {
                    rebase_span(&mut value.span, offset);
                    rebase_value(&mut value.value, offset);
                }
            }
            crate::PipelineStatement::For(value) => {
                rebase_span(&mut value.span, offset);
                rebase_value(&mut value.source, offset);
            }
            crate::PipelineStatement::Sorting(values) => {
                for value in values {
                    rebase_span(&mut value.span, offset);
                    rebase_value(&mut value.expr, offset);
                }
            }
            crate::PipelineStatement::Limit(value) | crate::PipelineStatement::Offset(value) => {
                rebase_limit(value, offset);
            }
            crate::PipelineStatement::Return(value) => rebase_return(value, offset),
            crate::PipelineStatement::With(value) => rebase_with(value, offset),
            crate::PipelineStatement::Call(value) => rebase_call(value, offset),
            crate::PipelineStatement::CallSubquery(value) => rebase_inline_call(value, offset),
        }
    }
}

fn rebase_limit(value: &mut crate::LimitValue, offset: usize) {
    match value {
        crate::LimitValue::Count(_, span) | crate::LimitValue::Parameter { span, .. } => {
            rebase_span(span, offset);
        }
    }
}

fn rebase_return(clause: &mut ReturnClause, offset: usize) {
    rebase_span(&mut clause.span, offset);
    for item in &mut clause.items {
        rebase_return_item(item, offset);
    }
    if let Some(group_by) = &mut clause.group_by {
        for item in group_by {
            rebase_value(item, offset);
        }
    }
    if let Some(having) = &mut clause.having {
        rebase_value(having, offset);
    }
}

fn rebase_return_item(item: &mut ReturnItem, offset: usize) {
    rebase_span(&mut item.span, offset);
    rebase_value(&mut item.expr, offset);
}

fn rebase_with(clause: &mut WithClause, offset: usize) {
    rebase_span(&mut clause.span, offset);
    for item in &mut clause.items {
        rebase_return_item(item, offset);
    }
    if let Some(group_by) = &mut clause.group_by {
        for item in group_by {
            rebase_value(item, offset);
        }
    }
    if let Some(having) = &mut clause.having {
        rebase_value(having, offset);
    }
    if let Some(where_clause) = &mut clause.where_clause {
        rebase_value(where_clause, offset);
    }
}

fn rebase_match(clause: &mut MatchClause, offset: usize) {
    rebase_span(&mut clause.span, offset);
    for pattern in &mut clause.patterns {
        rebase_graph_pattern(pattern, offset);
    }
    if let Some(where_clause) = &mut clause.where_clause {
        rebase_value(where_clause, offset);
    }
}

fn rebase_graph_pattern(pattern: &mut GraphPattern, offset: usize) {
    rebase_span(&mut pattern.span, offset);
    for element in &mut pattern.elements {
        match element {
            PatternElement::Node(node) => rebase_node_pattern(node, offset),
            PatternElement::Edge(edge) => rebase_edge_pattern(edge, offset),
        }
    }
}

fn rebase_node_pattern(pattern: &mut NodePattern, offset: usize) {
    rebase_span(&mut pattern.span, offset);
    for (_, value) in &mut pattern.properties {
        rebase_value(value, offset);
    }
    if let Some(value) = &mut pattern.inline_where {
        rebase_value(value, offset);
    }
}

fn rebase_edge_pattern(pattern: &mut EdgePattern, offset: usize) {
    rebase_span(&mut pattern.span, offset);
    for (_, value) in &mut pattern.properties {
        rebase_value(value, offset);
    }
    if let Some(value) = &mut pattern.inline_where {
        rebase_value(value, offset);
    }
}

fn rebase_value(value: &mut ValueExpr, offset: usize) {
    // Rebase this node's own span, then recurse into direct `ValueExpr` children
    // (which includes `IS [SOURCE|DESTINATION] OF` operands). Subquery bodies
    // are `MatchClause` / `QueryPipeline`, not `ValueExpr` children, so they are
    // descended explicitly below.
    value.for_each_span_mut(&mut |span| rebase_span(span, offset));
    value.for_each_child_mut(&mut |child| rebase_value(child, offset));
    match value {
        ValueExpr::Exists { body, .. } => match body {
            ExistsBody::Match(pattern) => rebase_match(pattern, offset),
            ExistsBody::Query(pipeline) => rebase_query_pipeline(pipeline, offset),
        },
        ValueExpr::ValueSubquery { body, .. } => rebase_query_pipeline(body, offset),
        _ => {}
    }
}

fn rebase_mutation_pipeline(pipeline: &mut MutationPipeline, offset: usize) {
    rebase_span(&mut pipeline.span, offset);
    for statement in &mut pipeline.statements {
        match statement {
            MutationStatement::Match(value) => rebase_match(value, offset),
            MutationStatement::Filter(value) => rebase_value(value, offset),
            MutationStatement::Insert(value) => {
                rebase_span(&mut value.span, offset);
                for pattern in &mut value.patterns {
                    rebase_graph_pattern(pattern, offset);
                }
            }
            MutationStatement::Set(values) => {
                for value in values {
                    match value {
                        SetItem::Property { value, span, .. } => {
                            rebase_span(span, offset);
                            rebase_value(value, offset);
                        }
                        SetItem::PropertyMerge {
                            properties, span, ..
                        } => {
                            rebase_span(span, offset);
                            for (_, value) in properties {
                                rebase_value(value, offset);
                            }
                        }
                        SetItem::Label { span, .. } => rebase_span(span, offset),
                    }
                }
            }
            MutationStatement::Remove(values) => {
                for value in values {
                    match value {
                        crate::RemoveItem::Property { span, .. }
                        | crate::RemoveItem::Label { span, .. } => rebase_span(span, offset),
                    }
                }
            }
            MutationStatement::Delete(value) => rebase_span(&mut value.span, offset),
        }
    }
    if let Some(terminator) = &mut pipeline.terminator {
        match terminator {
            MutationTerminator::Return(value) => rebase_return(value, offset),
            MutationTerminator::Finish(span) => rebase_span(span, offset),
        }
    }
}

fn rebase_ddl(statement: &mut DdlStatement, offset: usize) {
    match statement {
        DdlStatement::CreateGraph { span, .. }
        | DdlStatement::DropGraph { span, .. }
        | DdlStatement::DropNodeType { span, .. }
        | DdlStatement::DropEdgeType { span, .. }
        | DdlStatement::TruncateNodeType { span, .. }
        | DdlStatement::TruncateEdgeType { span, .. }
        | DdlStatement::CreateIndex { span, .. }
        | DdlStatement::DropIndex { span, .. } => rebase_span(span, offset),
        DdlStatement::CreateNodeType {
            properties,
            key_label_set,
            span,
            ..
        }
        | DdlStatement::CreateEdgeType {
            properties,
            key_label_set,
            span,
            ..
        } => {
            rebase_span(span, offset);
            // The explicit GG21 key-label-set span carries the source location
            // the planner uses for the IL003 42012–42015 cardinality diagnostics;
            // rebase it so batch-statement errors point at the original source,
            // not the segment-local offset.
            if let Some(key_label_set) = key_label_set {
                rebase_span(&mut key_label_set.span, offset);
            }
            for property in properties {
                rebase_property_def(property, offset);
            }
        }
        DdlStatement::ShowNodeTypes(span)
        | DdlStatement::ShowEdgeTypes(span)
        | DdlStatement::ShowIndexes(span)
        | DdlStatement::ShowProcedures(span) => {
            rebase_span(span, offset);
        }
    }
}

fn rebase_property_def(property: &mut TypePropertyDef, offset: usize) {
    rebase_span(&mut property.span, offset);
    for constraint in &mut property.constraints {
        match constraint {
            TypePropertyConstraint::NotNull(span)
            | TypePropertyConstraint::Immutable(span)
            | TypePropertyConstraint::Unique(span) => rebase_span(span, offset),
            TypePropertyConstraint::Indexed { span, .. } => rebase_span(span, offset),
            TypePropertyConstraint::Default(value, span) => {
                rebase_span(span, offset);
                rebase_value(value, offset);
            }
        }
    }
}

fn rebase_call(call: &mut ProcedureCall, offset: usize) {
    rebase_span(&mut call.span, offset);
    for arg in &mut call.args {
        rebase_value(arg, offset);
    }
    for item in &mut call.yield_items {
        rebase_span(&mut item.span, offset);
    }
}

fn rebase_inline_call(call: &mut InlineProcedureCall, offset: usize) {
    rebase_span(&mut call.span, offset);
    rebase_query_pipeline(&mut call.body, offset);
    for item in &mut call.yield_items {
        rebase_span(&mut item.span, offset);
    }
}

fn rebase_span(span: &mut SourceSpan, offset: usize) {
    span.byte_offset = span.byte_offset.saturating_add(to_u32(offset));
}