Class: Norikra::Query

Inherits:
Object
  • Object
show all
Defined in:
lib/norikra/query.rb,
lib/norikra/query/ast.rb

Direct Known Subclasses

SubQuery

Defined Under Namespace

Classes: ASTEventPropNode, ASTExpression, ASTLibFunctionArgItemNode, ASTLibFunctionNode, ASTNode, ASTPatternNode, ASTSelectionElementNode, ASTStreamEventNode, ASTStreamNode, ASTStreamPatternNode, ASTSubSelectNode, ParseRuleSelectorImpl

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(param = {}) ⇒ Query

Returns a new instance of Query.



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# File 'lib/norikra/query.rb', line 15

def initialize(param={})
  @name = param[:name]
  raise Norikra::ArgumentError, "Query name MUST NOT be blank" if @name.nil? || @name.empty?
  @group = param[:group] # default nil
  #TODO: ad-hoc query rewriting for https://jira.codehaus.org/browse/ESPER-788
  @expression = param[:expression].gsub(/([ ,])(MIN|MAX)\(/){ $1 + $2.downcase + '(' }
  raise Norikra::ArgumentError, "Query expression MUST NOT be blank" if @expression.nil? || @expression.empty?

  @statement_name = nil
  @fieldsets = {} # { target => fieldset }
  @ast = nil
  @targets = nil
  @aliases = nil
  @subqueries = nil
  @fields = nil
  @nullable_fields = nil
end

Instance Attribute Details

#expressionObject

Returns the value of attribute expression.



13
14
15
# File 'lib/norikra/query.rb', line 13

def expression
  @expression
end

#fieldsetsObject

Returns the value of attribute fieldsets.



13
14
15
# File 'lib/norikra/query.rb', line 13

def fieldsets
  @fieldsets
end

#groupObject

Returns the value of attribute group.



13
14
15
# File 'lib/norikra/query.rb', line 13

def group
  @group
end

#nameObject

Returns the value of attribute name.



13
14
15
# File 'lib/norikra/query.rb', line 13

def name
  @name
end

#statement_nameObject

Returns the value of attribute statement_name.



13
14
15
# File 'lib/norikra/query.rb', line 13

def statement_name
  @statement_name
end

Class Method Details

.imported_java_class?(name) ⇒ Boolean

Returns:

  • (Boolean)


1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
# File 'lib/norikra/query/ast.rb', line 1575

def self.imported_java_class?(name)
  return false unless name =~ /^[A-Z]/
  # Esper auto-imports the following Java library packages:
  # java.lang.* -> Java::JavaLang::*
  # java.math.* -> Java::JavaMath::*
  # java.text.* -> Java::JavaText::*
  # java.util.* -> Java::JavaUtil::*
  java_class('Java::JavaLang::'+name) || java_class('Java::JavaMath::'+name) ||
    java_class('Java::JavaText::'+name) || java_class('Java::JavaUtil::'+name) || false
end

.java_class(const_name) ⇒ Object



1586
1587
1588
1589
1590
1591
1592
1593
# File 'lib/norikra/query/ast.rb', line 1586

def self.java_class(const_name)
  begin
    c = eval(const_name)
    c.class == Kernel ? nil : c
  rescue NameError
    return nil
  end
end

.rewrite_event_field_name(statement_model, mapping, fqfs_prefixes = nil) ⇒ Object



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
# File 'lib/norikra/query.rb', line 306

def self.rewrite_event_field_name(statement_model, mapping, fqfs_prefixes=nil)
  # mapping: {target_name => query_event_type_name}
  #  mapping is for target name rewriting of fully qualified field name access


  # model.getFromClause.getStreams[0].getViews[0].getParameters[0].getPropertyName

  # model.getSelectClause.getSelectList[0].getExpression.getPropertyName
  # model.getSelectClause.getSelectList[0].getExpression.getChildren[0].getPropertyName #=> 'field.key1.$0'

  # model.getWhereClause.getChildren[1].getChildren[0].getPropertyName #=> 'field.key1.$1'
  # model.getWhereClause.getChildren[2].getChildren[0].getChain[0].getName #=> 'opts.num.$0' from opts.num.$0.length()

  query = Norikra::Query.new(name: 'dummy name by .rewrite_event_field_name', expression: statement_model.toEPL)
  targets = query.targets
  fqfs_prefixes ||= (targets + query.aliases)

  default_target = (targets.size == 1 ? targets.first : nil)

  rewrite_name = lambda {|node,getter,setter|
    name = node.send(getter)
    if name && name.index('.')
      prefix = nil
      body = nil
      first_part = name.split('.').first
      if fqfs_prefixes.include?(first_part) or mapping.has_key?(first_part) # fully qualified field specification
        prefix = first_part
        if mapping[prefix]
          prefix = mapping[prefix]
        end
        body = name.split('.')[1..-1].join('.')
      elsif default_target # default target field (outside of join context)
        body = name
      else
        raise Norikra::QueryError, "target cannot be determined for field '#{name}'"
      end
      #### 'field.javaMethod("args")' MUST NOT be escaped....
      # 'getPropertyName' returns a String "path.index(\".\")" for java method calling,
      #  and other optional informations are not provided.
      # We seems that '.camelCase(ANYTHING)' should be a method calling, not nested field accesses.
      # This is ugly, but works.
      #
      # 'path.substring(0, path.indexOf(path.substring(1,1)))' is parsed as 3-times-nested LIB_FUNCTION_CHAIN,
      #  so does not make errors.
      #
      method_chains = []
      body_chains = body.split('.')
      while body_chains.size > 0
        break unless body_chains.last =~ /^[a-z][a-zA-Z]*\(.*\)$/
        method_chains.unshift body_chains.pop
      end

      escaped_body = Norikra::Field.escape_name(body_chains.join('.'))
      encoded = (prefix ? "#{prefix}." : "") + escaped_body + (method_chains.size > 0 ? '.' + method_chains.join('.') : '' )
      node.send(setter, encoded)
    end
  }

  rewriter = lambda {|node|
    if node.respond_to?(:getPropertyName)
      rewrite_name.call(node, :getPropertyName, :setPropertyName)
    elsif node.respond_to?(:getChain)
      node.getChain.each do |chain|
        rewrite_name.call(chain, :getName, :setName)
      end
    end
  }
  recaller = lambda {|node|
    Norikra::Query.rewrite_event_field_name(node.getModel, mapping, fqfs_prefixes)
  }

  traverse_fields(rewriter, recaller, statement_model)
end

.rewrite_event_type_name(statement_model, mapping) ⇒ Object



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
# File 'lib/norikra/query.rb', line 380

def self.rewrite_event_type_name(statement_model, mapping)
  # mapping: {target_name => query_event_type_name}

  ### esper-4.9.0/esper/doc/reference/html/epl_clauses.html#epl-subqueries
  # Subqueries can only consist of a select clause, a from clause and a where clause.
  # The group by and having clauses, as well as joins, outer-joins and output rate limiting are not permitted within subqueries.

  # model.getFromClause.getStreams[0].getFilter.setEventTypeName("hoge") # normal Stream
  # model.getFromClause.getStreams[1].getExpression.getChildren[0].getChildren[0].getFilter.getEventTypeName # pattern

  # model.getSelectClause.getSelectList[1].getExpression => #<Java::ComEspertechEsperClientSoda::SubqueryExpression:0x3344c133>
  # model.getSelectClause.getSelectList[1].getExpression.getModel.getFromClause.getStreams[0].getFilter.getEventTypeName
  # model.getWhereClause.getChildren[1]                 .getModel.getFromClause.getStreams[0].getFilter.getEventTypeName

  rewriter = lambda {|node|
    if node.respond_to?(:getEventTypeName)
      target_name = node.getEventTypeName
      rewrite_name = mapping[ target_name ]
      unless rewrite_name
        raise RuntimeError, "target missing in mapping, maybe BUG: #{target_name}"
      end
      node.setEventTypeName(rewrite_name)
    end
  }
  recaller = lambda {|node|
    Norikra::Query.rewrite_event_type_name(node.getModel, mapping)
  }
  traverse_fields(rewriter, recaller, statement_model)
end

.rewrite_nullable_fields(statement_model) ⇒ Object



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
# File 'lib/norikra/query.rb', line 262

def self.rewrite_nullable_fields(statement_model)
  # NULLABLE(field) -> field
  ## NOTICE: NULLABLE(...) cannot be used in view parameters. ex: target.std:unique(NULLABLE(a)) -> x
  check_nullable = lambda {|exp|
    # top-level lib function
    # exp.getChain[0] #=> Java::ComEspertechEsperClientSoda::DotExpressionItem
    exp &&
    exp.is_a?(Java::ComEspertechEsperClientSoda::DotExpression) &&
    exp.getChain.size == 1 &&
    exp.getChain[0].name.upcase == 'NULLABLE'
  }
  fetch_field = lambda {|exp| exp.getChain[0].getParameters[0] }

  rewriter = lambda {|node|
    # without loop of parameters because this code shows which parameter cause errors in user's environment
    if node.respond_to?(:getExpression) && check_nullable.(node.getExpression)
      node.setExpression(fetch_field.(node.getExpression))
    end

    if node.respond_to?(:getFilter) && check_nullable.(node.getFilter)
      node.setFilter(fetch_field.(node.getFilter))
    end

    if node.respond_to?(:getChildren) && node.getChildren.any?{|exp| check_nullable.(exp) }
      node.setChildren(node.getChildren.map{|e| check_nullable.(e) ? fetch_field.(e) : e })
    end

    if node.respond_to?(:getParameters) && node.getParameters.any?{|exp| check_nullable.(exp) }
      node.setParameters(node.getParameters.map{|e| check_nullable.(e) ? fetch_field.(e) : e })
    end
    if node.respond_to?(:getChain) && node.getChain.any?{|exp| check_nullable.(exp) }
      node.setChain(node.getChain.map{|e| check_nullable.(e) ? fetch_field.(e) : e })
    end

    if node.respond_to?(:getExpressions) && node.getExpressions.any?{|exp| check_nullable.(exp) }
      node.setExpressions(node.getExpressions.map{|e| check_nullable.(e) ? fetch_field.(e) : e })
    end
  }
  recaller = lambda {|node|
    Norikra::Query.rewrite_nullable_fields(node.getModel)
  }
  traverse_fields(rewriter, recaller, statement_model)
end

.rewrite_query(statement_model, mapping) ⇒ Object



256
257
258
259
260
# File 'lib/norikra/query.rb', line 256

def self.rewrite_query(statement_model, mapping)
  rewrite_nullable_fields(statement_model)
  rewrite_event_type_name(statement_model, mapping)
  rewrite_event_field_name(statement_model, mapping)
end

.traverse_fields(rewriter, recaller, statement_model) ⇒ Object

:getAnnotations, :getClass, :getContextName, :getCreateContext, :getCreateDataFlow, :getCreateExpression, :getCreateIndex, :getCreateSchema, :getCreateVariable, :getCreateWindow, :getExpressionDeclarations, :getFireAndForgetClause, :getForClause, (*) :getFromClause, (*) :getGroupByClause, (*) :getHavingClause, :getInsertInto, :getMatchRecognizeClause, :getOnExpr, (*) :getOrderByClause, :getOutputLimitClause, :getRowLimitClause, :getScriptExpressions, (*) :getSelectClause, :getTreeObjectName, :getUpdateClause, (*) :getWhereClause,



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
524
525
526
# File 'lib/norikra/query.rb', line 441

def self.traverse_fields(rewriter, recaller, statement_model)
  #NOTICE: SQLStream is not supported yet.
  dig = lambda {|node|
    return unless node
    rewriter.call(node)

    if node.is_a?(Java::ComEspertechEsperClientSoda::SubqueryExpression)
      recaller.call(node)
    end
    if node.respond_to?(:getFilter)
      dig.call(node.getFilter)
    end
    if node.respond_to?(:getChildren)
      node.getChildren.each do |c|
        dig.call(c)
      end
    end
    if node.respond_to?(:getParameters)
      node.getParameters.each do |p|
        dig.call(p)
      end
    end
    if node.respond_to?(:getChain)
      node.getChain.each do |c|
        dig.call(c)
      end
    end
    if node.respond_to?(:getExpression)
      dig.call(node.getExpression)
    end
    if node.respond_to?(:getExpressions)
      node.getExpressions.each do |e|
        dig.call(e)
      end
    end
  }

  statement_model.getFromClause.getStreams.each do |stream|
    if stream.respond_to?(:getExpression) # PatternStream < ProjectedStream
      dig.call(stream.getExpression)
    end
    if stream.respond_to?(:getFilter) # Filter < ProjectedStream
      dig.call(stream.getFilter)
    end
    if stream.respond_to?(:getParameterExpressions) # MethodInvocationStream
      dig.call(stream.getParameterExpressions)
    end
    if stream.respond_to?(:getViews) # ProjectedStream
      stream.getViews.each do |view|
        view.getParameters.each do |parameter|
          dig.call(parameter)
        end
      end
    end
  end

  if statement_model.getSelectClause
    statement_model.getSelectClause.getSelectList.each do |item|
      dig.call(item)
    end
  end

  if statement_model.getWhereClause
    statement_model.getWhereClause.getChildren.each do |child|
      dig.call(child)
    end
  end

  if statement_model.getGroupByClause
    statement_model.getGroupByClause.getGroupByExpressions.each do |item|
      dig.call(item)
    end
  end

  if statement_model.getOrderByClause
    statement_model.getOrderByClause.getOrderByExpressions.each do |item|
      dig.call(item)
    end
  end

  if statement_model.getHavingClause
    dig.call(statement_model.getHavingClause)
  end

  statement_model
end

Instance Method Details

#<=>(other) ⇒ Object



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
# File 'lib/norikra/query.rb', line 38

def <=>(other)
  if @group.nil? || other.group.nil?
    if @group.nil? && other.group.nil?
      @name <=> other.name
    else
      @group.to_s <=> other.group.to_s
    end
  else
    if @group == other.group
      self.name <=> other.name
    else
      self.group <=> other.group
    end
  end
end

#aliasesObject



99
100
101
102
103
# File 'lib/norikra/query.rb', line 99

def aliases
  return @aliases if @aliases
  @aliases = (self.ast.listup(:stream).map{|s| s.aliases.map(&:first) }.flatten + self.subqueries.map(&:aliases).flatten).sort.uniq
  @aliases
end

#astObject



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
# File 'lib/norikra/query.rb', line 217

def ast
  return @ast if @ast
  rule = ParseRuleSelectorImpl.new
  target = @expression.dup
  forerrmsg = @expression.dup
  result = Java::ComEspertechEsperEplParse::ParseHelper.parse(target, forerrmsg, true, rule, false)

  # walk through AST and check syntax errors/semantic errors
  ast = result.tree

  services = Java::ComEspertechEsperClient::EPServiceProviderManager.getDefaultProvider.getServicesContext

  walker = Java::ComEspertechEsperEplParse::EPLTreeWalkerListener.new(
    result.getTokenStream,
    services.getEngineImportService,
    services.getVariableService,
    services.getSchedulingService,
    Java::ComEspertechEsperEplSpec::SelectClauseStreamSelectorEnum.mapFromSODA(
      services.getConfigSnapshot.getEngineDefaults.getStreamSelection.getDefaultStreamSelector
    ),
    services.getEngineURI,
    services.getConfigSnapshot,
    services.getPatternNodeFactory,
    services.getContextManagementService,
    result.getScripts,
    services.getExprDeclaredService,
    services.getTableService
  )

  Java::ComEspertechEsperEplParse::ParseHelper.walk(ast, walker, target, forerrmsg)

  @ast = astnode(ast)
  @ast
rescue Java::ComEspertechEsperEplParse::ASTWalkException => e
  raise Norikra::QueryError, e.message
rescue Java::ComEspertechEsperClient::EPStatementSyntaxException => e
  raise Norikra::QueryError, e.message
end

#astnode(tree) ⇒ Object

[“startEPLExpressionRule”,

["eplExpression",
  ["selectExpr",
    "SELECT",
    ["selectClause",
      ["selectionList",
        ["selectionListElement",
          ["selectionListElementExpr",
            ["expression",
              ["caseExpression",["evalOrExpression",["evalAndExpression",["bitWiseExpression",["negatedExpression",
                ["evalEqualsExpression",["evalRelationalExpression",["concatenationExpr",["additiveExpression",
                  ["multiplyExpression",["unaryExpression",
                    ["eventPropertyOrLibFunction",
                      ["eventProperty",
                        ["eventPropertyAtomic", ["eventPropertyIdent", ["keywordAllowedIdent", "a"]]]]]]]]]]]]]]]]]]],
        ",",
        ["selectionListElement",
          ["selectionListElementExpr",
            ["expression",
              ["caseExpression",["evalOrExpression",["evalAndExpression",["bitWiseExpression",["negatedExpression",
                ["evalEqualsExpression",["evalRelationalExpression",["concatenationExpr",["additiveExpression",
                  ["multiplyExpression",["unaryExpression",
                    ["eventPropertyOrLibFunction",
                      ["libFunction",
                        ["libFunctionWithClass",
                          ["funcIdentTop", ["escapableIdent", "NULLABLE"]],
                            "(",
                            ["libFunctionArgs",
                              ["libFunctionArgItem",
                                ["expressionWithTime",
                                  ["expressionQualifyable",
                                    ["expression",
                                      ["caseExpression",["evalOrExpression",["evalAndExpression",["bitWiseExpression",
                                        ["negatedExpression",["evalEqualsExpression",["evalRelationalExpression",
                                          ["concatenationExpr",["additiveExpression",["multiplyExpression",["unaryExpression",
                                            ["eventPropertyOrLibFunction",
                                              ["eventProperty",
                                                ["eventPropertyAtomic",
                                                  ["eventPropertyIdent", ["keywordAllowedIdent", "b"]]]]]]]]]]]]]]]]]]]]],
                            ")"]]]]]]]]]]]]]]]]],
        ",",
        ["selectionListElement",
          ["selectionListElementExpr",
            ["expression",
              ["caseExpression",["evalOrExpression",["evalAndExpression",["bitWiseExpression",["negatedExpression",
                ["evalEqualsExpression",["evalRelationalExpression",["concatenationExpr",["additiveExpression",
                  ["multiplyExpression",["unaryExpression",
                    ["builtinFunc",
                      "COUNT",
                      "(",
                      "DISTINCT",
                      ["expression",
                        ["caseExpression",["evalOrExpression",["evalAndExpression",["bitWiseExpression",
                          ["negatedExpression",["evalEqualsExpression",["evalRelationalExpression",
                            ["concatenationExpr",["additiveExpression",["multiplyExpression",["unaryExpression",
                              ["eventPropertyOrLibFunction",
                                ["libFunction",
                                  ["libFunctionWithClass",
                                    ["funcIdentTop", ["escapableIdent", "NULLABLE"]],
                                      "(",
                                      ["libFunctionArgs",
                                        ["libFunctionArgItem",
                                          ["expressionWithTime",
                                            ["expressionQualifyable",
                                              ["expression",
                                                ["caseExpression",["evalOrExpression",["evalAndExpression",["bitWiseExpression",
                                                  ["negatedExpression",["evalEqualsExpression",["evalRelationalExpression",
                                                    ["concatenationExpr",["additiveExpression",["multiplyExpression",
                                                      ["unaryExpression",
                                                        ["eventPropertyOrLibFunction",
                                                          ["eventProperty",
                                                            ["eventPropertyAtomic",
                                                              ["eventPropertyIdent",
                                                                ["keywordAllowedIdent", "c"]]]]]]]]]]]]]]]]]]]]],
                                                                    ")"]]]]]]]]]]]]]]],
                                      ")"]]]]]]]]]]]]]]]]],
    "FROM",
    ["fromClause",
      ["streamExpression", ["eventFilterExpression", ["classIdentifier", ["escapableStr", "t"]]]],
      "regularJoin"],
    "GROUP",
    "BY",
    ["groupByListExpr",
      ["groupByListChoice",
        ["expression",
          ["caseExpression",["evalOrExpression",["evalAndExpression",["bitWiseExpression",["negatedExpression",
            ["evalEqualsExpression",["evalRelationalExpression",["concatenationExpr",["additiveExpression",
              ["multiplyExpression",["unaryExpression",
                ["eventPropertyOrLibFunction",
                  ["eventProperty",
                    ["eventPropertyAtomic", ["eventPropertyIdent", ["keywordAllowedIdent", "a"]]]]]]]]]]]]]]]]]],
      ",",
      ["groupByListChoice",
        ["expression",
          ["caseExpression",["evalOrExpression",["evalAndExpression",["bitWiseExpression",["negatedExpression",
            ["evalEqualsExpression",["evalRelationalExpression",["concatenationExpr",["additiveExpression",
              ["multiplyExpression",["unaryExpression",
                ["eventPropertyOrLibFunction",
                  ["libFunction",
                    ["libFunctionWithClass",
                      ["funcIdentTop", ["escapableIdent", "NULLABLE"]],
                      "(",
                      ["libFunctionArgs",
                        ["libFunctionArgItem",
                          ["expressionWithTime",
                            ["expressionQualifyable",
                              ["expression",
                                ["caseExpression",["evalOrExpression",["evalAndExpression",["bitWiseExpression",
                                  ["negatedExpression",["evalEqualsExpression",["evalRelationalExpression",
                                    ["concatenationExpr",["additiveExpression",["multiplyExpression",["unaryExpression",
                                      ["eventPropertyOrLibFunction",
                                        ["eventProperty",
                                          ["eventPropertyAtomic",
                                            ["eventPropertyIdent", ["keywordAllowedIdent", "b"]]]]]]]]]]]]]]]]]]]]],
                                      ")"]]]]]]]]]]]]]]]]]]],
"<EOF>"]


839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
# File 'lib/norikra/query/ast.rb', line 839

def astnode(tree)
  # com.espertech.esper.epl.generated.EsperEPL2GrammarParser.ruleNames[ast.ruleIndex] #=> "startEPLExpressionRule"
  # com.espertech.esper.epl.generated.EsperEPL2GrammarParser.ruleNames[ast.getChild(0).ruleIndex] #=> "eplExpression"

  # ast.getChild(0).getChild(0).ruleIndex #=> 15
  # com.espertech.esper.epl.generated.EsperEPL2GrammarParser.ruleNames[ast.getChild(0).getChild(0).ruleIndex] #=> "selectExpr"
  # ast.getChild(0).getChild(0).getChild(0).symbol.text #=> 'select'
  # ast.getChild(0).getChild(0).getChild(0).symbol.type #=> 24

  # [23] pry(main)> ast.getChild(0).getChild(1)
  # => nil
  # [24] pry(main)> ast.getChild(0).getChild(0).getChild(1)
  # => #<Java::ComEspertechEsperEplGenerated::EsperEPL2GrammarParser::SelectClauseContext:0x6437693>
  # [25] pry(main)> ast.getChild(0).getChild(0).getChild(1).getChild(0)
  # => #<Java::ComEspertechEsperEplGenerated::EsperEPL2GrammarParser::SelectionListContext:0x5de28c04>

  name = if tree.respond_to?(:getRuleIndex)
           Java::ComEspertechEsperEplGenerated::EsperEPL2GrammarParser.ruleNames[tree.getRuleIndex]
         else
           tree.symbol.text
         end
  children = []
  tree.childCount.times do |i|
    child = tree.getChild(i)
    children << astnode(child) if child
  end

  cls = case name
        when 'expression' then ASTExpression
        when 'eventProperty' then ASTEventPropNode
        when 'selectionListElementExpr' then ASTSelectionElementNode
        when 'libFunction' then ASTLibFunctionNode
        when 'libFunctionArgItem' then ASTLibFunctionArgItemNode
        when 'streamExpression', 'subSelectFilterExpr' then ASTStreamNode
        when 'patternFilterExpression' then ASTPatternNode
        when 'subQueryExpr' then ASTSubSelectNode
        else ASTNode
        end
  if cls.respond_to?(:generate)
    cls.generate(name, children, tree)
  else
    cls.new(name, children, tree)
  end
end

#dumpObject



62
63
64
# File 'lib/norikra/query.rb', line 62

def dump
  {name: @name, group: @group, expression: @expression}
end

#dupObject



54
55
56
# File 'lib/norikra/query.rb', line 54

def dup
  self.class.new(name: @name, group: @group, expression: @expression.dup)
end

#explore(outer_targets = [], alias_overridden = {}) ⇒ Object



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
# File 'lib/norikra/query.rb', line 111

def explore(outer_targets=[], alias_overridden={})
  fields = {
    defs: { all: [], unknown: [], target: {} },
    nullables: { all: [], unknown: [], target: {} },
  }

  alias_map = alias_overridden.dup

  self.ast.listup(:stream).each do |node|
    node.aliases.each do |alias_name, target|
      alias_map[alias_name] = target
    end
    node.targets.each do |target|
      fields[:defs][:target][target] = []
      fields[:nullables][:target][target] = []
    end
  end

  # default target should be out of effect of outer_targets
  default_target = fields[:defs][:target].keys.size == 1 ? fields[:defs][:target].keys.first : nil

  outer_targets.each do |t|
    fields[:defs][:target][t] ||= []
    fields[:nullables][:target][t] ||= []
  end

  dup_aliases = (alias_map.keys & fields[:defs][:target].keys)
  unless dup_aliases.empty?
    raise Norikra::ClientError, "Invalid alias '#{dup_aliases.join(',')}', same with target name"
  end

  # names of 'AS'
  field_aliases = self.ast.listup(:selection).map(&:alias).compact

  known_targets_aliases = fields[:defs][:target].keys + alias_map.keys
  self.ast.fields(default_target, known_targets_aliases).each do |field_def|
    f = field_def[:f]
    next if field_aliases.include?(f)

    fields[:defs][:all].push(f)
    fields[:nullables][:all].push(f) if field_def[:n]

    if field_def[:t]
      t = alias_map[field_def[:t]] || field_def[:t]
      unless fields[:defs][:target][t]
        raise Norikra::ClientError, "unknown target alias name for: #{field_def[:t]}.#{field_def[:f]}"
      end
      fields[:defs][:target][t].push(f)
      fields[:nullables][:target][t].push(f) if field_def[:n]
    else
      fields[:defs][:unknown].push(f)
      fields[:nullables][:unknown].push(f) if field_def[:n]
    end
  end

  self.subqueries.each do |subquery|
    sub = {}
    sub[:defs], sub[:nullables] = subquery.explore(fields[:defs][:target].keys, alias_map)

    [:defs, :nullables].each do |group|
      fields[group][:all] += sub[group].delete('')
      fields[group][:unknown] += sub[group].delete(nil)
      sub[group].keys.each do |t|
        fields[group][:target][t] ||= []
        fields[group][:target][t] += sub[group][t]
      end
    end
  end

  compact = ->(data){
    r = {}
    data[:target].keys.each do |t|
      r[t] = data[:target][t].sort.uniq
    end
    r[''] = data[:all].sort.uniq
    r[nil] = data[:unknown].sort.uniq
    r
  }

  [ compact.(fields[:defs]), compact.(fields[:nullables]) ]
end

#fields(target = '') ⇒ Object



193
194
195
196
197
198
199
200
# File 'lib/norikra/query.rb', line 193

def fields(target='')
  # target '': fields for all targets (without target name)
  # target nil: fields for unknown targets
  return @fields[target] if @fields

  @fields, @nullable_fields = explore()
  @fields[target]
end

#inspectObject



33
34
35
36
# File 'lib/norikra/query.rb', line 33

def inspect
  internal = ['name', 'group', 'expression', 'statement_name', 'targets', 'aliases', 'fields', 'nullable_fields', 'subqueries', 'fieldsets'].map{|x| "@#{x}=" + self.send(x.to_sym).inspect }.join(", ")
  "<#Norikra::Query:#{self.object_id} #{internal}>"
end

#invalid?Boolean

Returns:

  • (Boolean)


70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'lib/norikra/query.rb', line 70

def invalid?
  # check query is invalid as Norikra query or not, and return invalid reason (or nil for valid queries)

  # "SELECT *" is prohibited because each Norikra targets does not have all fields users expect
  if self.ast.listup('selectionListElement').any?{|node| node.children.map(&:name).any?{|name| name == '*' } }
    # '*' is a direct child of selectionListElement, not selectionListElementExpr
    return "'SELECT *' is prohibited in query"
  end

  # NULLABLE(...) can have "a" single field reference only
  nullables = self.ast.listup(:libfunc).select{|node| node.function_name.upcase == "NULLABLE" }
  if nullables.size > 0
    unless nullables.all?{|node| args = node.find("libFunctionArgs"); args && args.has_a?(:libarg) }
      return "NULLABLE(...) must have a field argument"
    end
    unless nullables.all?{|node| exp = node.find(:libarg).expression; exp && exp.propertyReference? }
      return "NULLABLE(...) can get a field, not expression"
    end
  end

  nil
end

#nullable_fields(target = '') ⇒ Object



202
203
204
205
206
207
208
# File 'lib/norikra/query.rb', line 202

def nullable_fields(target='')
  # argument target is same with #fields
  return @nullable_fields[target] if @nullable_fields

  @fields, @nullable_fields = explore()
  @nullable_fields[target]
end

#subqueriesObject



105
106
107
108
109
# File 'lib/norikra/query.rb', line 105

def subqueries
  return @subqueries if @subqueries
  @subqueries = self.ast.listup(:subquery).map{|n| Norikra::SubQuery.new(n)}
  @subqueries
end

#suspended?Boolean

Returns:

  • (Boolean)


66
67
68
# File 'lib/norikra/query.rb', line 66

def suspended?
  false
end

#targetsObject



93
94
95
96
97
# File 'lib/norikra/query.rb', line 93

def targets
  return @targets if @targets
  @targets = (self.ast.listup(:stream).map(&:targets).flatten + self.subqueries.map(&:targets).flatten).sort.uniq
  @targets
end

#to_hashObject



58
59
60
# File 'lib/norikra/query.rb', line 58

def to_hash
  {'name' => @name, 'group' => @group, 'expression' => @expression, 'targets' => self.targets, 'suspended' => false}
end