elastic-esql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d509f46ee96d9ce934b04bdf01c14589e77a0e7130bbf86386e3050668865f10
+  data.tar.gz: 1631dc08bc5cb8a83175a1e3ab226d27093906751babf9fe220f0d61b54e669b
+SHA512:
+  metadata.gz: fd106b0e92d4e951b3b6f685e926f538e79d727634e3f805554cbf021b8c4e92c8eb12ae2be25372e0fcfaf669ef11d372ba6c2bc53a253c2fe177e33adf14e9
+  data.tar.gz: 490df5f4fc2fae7d0505ce7a411db8a85fa32f93e6609844bbe6c0270638e7c17e58c0ba815549de28acb6fbc09cbe07fd5bc47c4604ca68408ff778a4b6594e

data/lib/elastic/esql.rb

@@ -0,0 +1,161 @@
+# Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+# or more contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+require_relative 'change_point'
+require_relative 'custom'
+require_relative 'dissect'
+require_relative 'drop'
+require_relative 'enrich'
+require_relative 'eval'
+require_relative 'grok'
+require_relative 'limit'
+require_relative 'keep'
+require_relative 'rename'
+require_relative 'row'
+require_relative 'show'
+require_relative 'sort'
+require_relative 'where'
+
+module Elastic
+  # @example
+  #    Elastic::ESQL.from('sample_data').sort_descending('@timestamp').limit(3).to_s
+  #    # => FROM 'sample_data' | SORT @timestamp desc | LIMIT 3
+  class ESQL
+    include ChangePoint
+    include Custom
+    include Dissect
+    include Drop
+    include Eval
+    include Grok
+    include Keep
+    include Limit
+    include Rename
+    include Row
+    include Show
+    include Sort
+    include Where
+    SOURCE_COMMANDS = [:from, :row, :show].freeze
+
+    def initialize
+      @query = {}
+      @custom = []
+    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?
+
+      @query[:enrich] = @enriches.join('| ') if @enriches
+      string_query = @query.map do |k, v|
+        "#{k.upcase} #{v}"
+      end.join(' | ')
+
+      string_query.concat(" #{@custom.join(' ')}") unless @custom.empty?
+      string_query
+    end
+
+    # Creates a new Enrich object to chain with +on+ and +with+. If other methods are chained to the
+    # Enrich object, it returns calls it upon the ESQL object that instantiated it, and returns it.
+    # @return [Elastic::Enrich]
+    def enrich(policy)
+      @enriches ||= []
+      enrich = Enrich.new(policy, self)
+      @enriches << enrich
+      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
+
+    # Instance method to allow to update +from+ with +esql.from('different_source')+.
+    # @param [String] index_pattern A list of indices, data streams or aliases. Supports wildcards and date math.
+    def from(index_pattern)
+      @query = { from: index_pattern }
+      self
+    end
+
+    # Defining to_s so the ES|QL formatted query is returned. This way the query will be serialized
+    # when passing an Elastic::ESQL object to the Elasticsearch client and other libraries.
+    def to_s
+      query
+    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.'
+    end
+
+    # Used when building the query from hash params function
+    def symbolize(name)
+      name.is_a?(Symbol) ? name : name.to_sym
+    end
+
+    # Check if we have a source command
+    def source_command_present?
+      SOURCE_COMMANDS.map { |c| @query.each_key { |k| return true if k == c } }
+
+      false
+    end
+
+    # Helper method to return a copy of the object when functions are called without `!`, so the
+    # object is not mutated.
+    def method_copy(name, *params)
+      esql = clone
+      esql.instance_variable_set('@query', esql.instance_variable_get('@query').clone)
+      esql.send("#{name}!", *params)
+      esql
+    end
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: elastic-esql
+version: !ruby/object:Gem::Version
+  version: 0.1.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'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/elastic/esql.rb
+licenses:
+- Apache-2.0
+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
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Elastic ES|QL Query builder
+test_files: []