elastic-esql 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7837c640aa915808d6c720d4cd53bdcfe3210fbff0a5e9b900a0c0adcc3ed7a
-  data.tar.gz: 6f3cc673984d2968b098a36137a44780e279be68c3ec04d37737044e29cf1af5
+  metadata.gz: f78cf59762700445a9241150e555c8b77cae9b5f6fde95540a83ef4420cb3f57
+  data.tar.gz: 0bd367ff0a9228bf14284446c6bf0c7013b580b101506e4eeeba5537fbf6acf1
 SHA512:
-  metadata.gz: 90fbc7b576d768c0d2282d87e2ae0bcbd7c8f82ba19a910edfd084fa15cb5ef1b86423fe4eae5ddd07c0910ab0dcde4a6e67516147b54f5102a093c018d26237
-  data.tar.gz: a535a2fa6d19d8a5bb41ac4c70e27f66559699fe07073383ee7a3af295416d0df8a1f47e7a7ff0a1fbe20d0c6dbb315e6842e4fbf111351de2ee54d4bd774a56
+  metadata.gz: ca8b8a9b1d45a7fcf36e7a82232d6d4e56cca5ca268a78da9f97a0077c3f27630644f1e91b4e728a402bd888a184082ea9582adc7bae42c41de10eab46f769e6
+  data.tar.gz: 74911524b52175a7e524b6924a14b1090c3c9ff906ea7e4bd3e0d7c2372fda21abbf31240363c9c8bcae856df31d9b47e12534e0a502fe8b76d26a14e662a44f

data/lib/elastic/esql.rb

@@ -26,15 +26,26 @@ require_relative 'functions'
 require_relative 'fork'
 require_relative 'fuse'
 require_relative 'grok'
+require_relative 'inline_stats'
 require_relative 'keep'
 require_relative 'lookup_join'
 require_relative 'metadata'
+require_relative 'metrics_info'
+require_relative 'mv_expand'
+require_relative 'promql'
 require_relative 'queryable'
+require_relative 'registered_domain'
 require_relative 'rename'
+require_relative 'rerank'
 require_relative 'row'
+require_relative 'sample'
+require_relative 'set'
 require_relative 'show'
 require_relative 'stats'
+require_relative 'stats_mixin'
 require_relative 'ts'
+require_relative 'user_agent'
+require_relative 'uri_parts'
 require_relative 'util'
 
 module Elastic
@@ -43,11 +54,12 @@ module Elastic
   #    # => FROM 'sample_data' | SORT @timestamp desc | LIMIT 3
   class ESQL
     [
-      ChangePoint, Custom, Dissect, Drop, Eval, Fork, Fuse, Grok, Keep, LookupJoin, Metadata,
-      Queryable, Rename, Row, Show, Stats, TS, Util
+      ChangePoint, Custom, Dissect, Drop, Eval, Fork, Fuse, Grok, InlineStats, Keep, LookupJoin,
+      Metadata, MetricsInfo, MvExpand, PromQL, Queryable, RegisteredDomain, Rename, Row, Sample,
+      SetDirective, Show, Stats, StatsMixin, TS, URIParts, Util
     ].each { |m| include m }
 
-    SOURCE_COMMANDS = [:from, :row, :show, :ts].freeze
+    SOURCE_COMMANDS = [:from, :promql, :row, :show, :ts].freeze
 
     def initialize
       @query = {}
@@ -55,14 +67,33 @@ module Elastic
       @metadata = []
     end
 
+    # Dinamically define Class methods to allow static instantiation with Source Commands:
+    # @see ESQL#from
+    # @see PromQL#promql
+    # @see Row#row
+    # @see Show#show
+    # @see TS#ts
+    # @example
+    #   Elastic::ESQL.from('sample_data')
+    #   Elastic::ESQL.row({ a: 1, b: 'two' })
+    class << self
+      SOURCE_COMMANDS.each do |command|
+        define_method(command) do |*params|
+          new.send(command, *params)
+        end
+      end
+    end
+
     # Function to build the ES|QL formatted query and return it as a String.
     # @raise [ArgumentError] if the query has no source command
     # @return [String] The ES|QL query in ES|QL format.
     def query
       raise ArgumentError, 'No source command found' unless source_command_present?
 
+      string_query = @set ? "SET #{@set};\n" : ''
       @query[:enrich] = @enriches.map(&:to_query).join('| ') if @enriches
-      string_query = build_string_query
+      @query[:rerank] = @rerank.to_query if @rerank
+      string_query.concat(build_string_query)
       string_query.concat(" #{@custom.join(' ')}") unless @custom.empty?
       string_query
     end
@@ -77,33 +108,12 @@ module Elastic
       enrich
     end
 
-    # Class method to allow static instantiation.
-    # @param [String] index_pattern A list of indices, data streams or aliases. Supports wildcards and date math.
-    # @example
-    #   Elastic::ESQL.from('sample_data')
-    # @see https://www.elastic.co/docs/reference/query-languages/esql/commands/source-commands#esql-from
-    def self.from(index_pattern)
-      new.from(index_pattern)
-    end
-
-    # The SHOW source command returns information about the deployment and its capabilities.
-    # @return [String] 'SHOW INFO'
-    # @see https://www.elastic.co/docs/reference/query-languages/esql/commands/source-commands#esql-show
-    def self.show
-      new.show
-    end
-
-    # Class method to allow static instantiation.
-    # @param [Hash] params Receives a Hash<column, value>
-    # @option params [String] column_name The column name. In case of duplicate column names, only the
-    #                                rightmost duplicate creates a column.
-    # @option params [String] value The value for the column. Can be a literal, an expression, or a function.
-    def self.row(*params)
-      new.row(*params)
-    end
-
-    def self.ts(*params)
-      new.ts(*params)
+    # Creates a new Rerank object to chain with +on+ and +with+. If other method is chained to the
+    # Rerank object, it calls it upon the ESQL object that instantiated it, and returns it.
+    # @return [Elastic::Rerank]
+    def rerank(column: nil, query: '')
+      @rerank = Rerank.new(self, column: column, query: query)
+      @rerank
     end
 
     # Instance method to allow to update +from+ with +esql.from('different_source')+.
@@ -120,50 +130,33 @@ module Elastic
     end
 
     # rubocop:disable Naming/MethodName, Naming/BinaryOperatorParameterName
-    def self.🐔(message)
-      "ROW CHICKEN(\"#{message}\")"
+    class << self
+      def 🐔(message)
+        "ROW CHICKEN(\"#{message}\")"
+      end
+      alias chicken 🐔
     end
 
     def 🐔(message)
       self.class.🐔(message)
     end
-
     alias chicken 🐔
-
-    class << self
-      alias chicken 🐔
-    end
     # rubocop:enable Naming/MethodName, Naming/BinaryOperatorParameterName
 
     def self.branch
       Branch.new
     end
 
-    private
-
-    # Function for eval, row, and other functions that have one or more columns with values specified
-    # as parameters. The hash_or_string function is called with the caller name since it's the same
-    # logic to use these parameters.
-    # TODO: Refactor to accept other types when not a Hash
-    def hash_param(name, params)
-      raise_hash_error(name) unless params.is_a?(Hash)
-
-      @query[symbolize(name)] = params.map { |k, v| "#{k} = #{v}" }.join(', ')
-      self
-    end
-
-    # Error raised when a function expects a Hash and something else is passed in, with explanation
-    def raise_hash_error(name)
-      raise ArgumentError, "#{name.to_s.upcase} needs a Hash as a parameter where the keys are the " \
-                           'column names and the value is the function or expression to calculate.'
+    # Creates a new UserAgent object to chain with +with+. If other method is chained to the
+    # UserAgent object, it calls it upon the ESQL object that instantiated it, and returns it.
+    # @return [Elastic::UserAgent]
+    def user_agent(params)
+      UserAgent.new(params, self)
     end
 
-    # Used when building the query from hash params function
-    def symbolize(name)
-      name.is_a?(Symbol) ? name : name.to_sym
-    end
+    private
 
-    # Check if we have a source command
+    # Check if there's a source command present in the query
     def source_command_present?
       SOURCE_COMMANDS.map { |c| @query.each_key { |k| return true if k == c } }
 

metadata

@@ -1,84 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: elastic-esql
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Fernando Briano
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: debug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.75'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.75'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.9'
+dependencies: []
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -90,6 +20,7 @@ metadata:
   changelog_uri: https://github.com/elastic/esql-ruby/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/elastic/esql-ruby/tree/main
   bug_tracker_uri: https://github.com/elastic/esql-ruby/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -104,7 +35,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.3
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Elastic ES|QL Query builder
 test_files: []