opensearch-ruby 1.0.0 → 3.1.0

data/lib/opensearch/dsl/search/queries/bool.rb

@@ -0,0 +1,110 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A compound query which matches documents based on combinations of queries
+        #
+        # @example Defining a bool query with multiple conditions
+        #
+        #     search do
+        #       query do
+        #         bool do
+        #           must do
+        #             term category: 'men'
+        #           end
+        #
+        #           must do
+        #             term size:  'xxl'
+        #           end
+        #
+        #           should do
+        #             term color: 'red'
+        #           end
+        #
+        #           must_not do
+        #             term manufacturer: 'evil'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # See the integration test for a working example.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-bool-query.html
+        #
+        class Bool
+          include BaseComponent
+
+          option_method :minimum_should_match
+          option_method :boost
+
+          def must(*args, &block)
+            @hash[name][:must] ||= []
+            value = args.empty? ? Query.new(*args, &block).to_hash : args.first.to_hash
+            @hash[name][:must].push(value).flatten! unless @hash[name][:must].include?(value)
+            self
+          end
+
+          def must_not(*args, &block)
+            @hash[name][:must_not] ||= []
+            value = args.empty? ? Query.new(*args, &block).to_hash : args.first.to_hash
+            @hash[name][:must_not].push(value).flatten! unless @hash[name][:must_not].include?(value)
+            self
+          end
+
+          def should(*args, &block)
+            @hash[name][:should] ||= []
+            value = args.empty? ? Query.new(*args, &block).to_hash : args.first.to_hash
+            @hash[name][:should].push(value).flatten! unless @hash[name][:should].include?(value)
+            self
+          end
+
+          def filter(*args, &block)
+            @hash[name][:filter] ||= []
+            if (filter = block ? Filter.new(*args, &block) : args.first)
+              @hash[name][:filter] << filter.to_hash
+            end
+            self
+          end
+
+          def to_hash
+            @hash[name].update(@args.to_hash) if @args.respond_to?(:to_hash)
+
+            if @block
+              call
+            else
+              @hash[name] = @args unless @args.nil? || @args.empty?
+            end
+            @hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/boosting.rb

@@ -0,0 +1,57 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A query which will decrease the score of documents matching the `negative` query
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         boosting do
+        #           positive terms: { amenities: ['wifi', 'pets'] }
+        #           negative terms: { amenities: ['pool'] }
+        #           negative_boost 0.5
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-boosting-query.html
+        #
+        class Boosting
+          include BaseComponent
+
+          option_method :positive
+          option_method :negative
+          option_method :negative_boost
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/common.rb

@@ -0,0 +1,62 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A query which executes the search for low frequency terms first, and high frequency ("common")
+        # terms second
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         common :body do
+        #           query 'shakespeare to be or not to be'
+        #         end
+        #       end
+        #     end
+        #
+        # This query is frequently used when a stopwords-based approach loses too much recall and/or precision.
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-common-terms-query.html
+        #
+        class Common
+          include BaseComponent
+
+          option_method :query
+          option_method :cutoff_frequency
+          option_method :low_freq_operator
+          option_method :minimum_should_match
+          option_method :boost
+          option_method :analyzer
+          option_method :disable_coord
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/constant_score.rb

@@ -0,0 +1,90 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A query which wraps another query or filter and returns a constant score for matching documents
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         constant_score do
+        #           query do
+        #             match content: 'Twitter'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/ignoring-tfidf.html
+        #
+        class ConstantScore
+          include BaseComponent
+
+          option_method :boost
+
+          # DSL method for building the `query` part of the query definition
+          #
+          # @return [self]
+          #
+          def query(*args, &block)
+            @query = block ? @query = Query.new(*args, &block) : args.first
+            self
+          end
+
+          # DSL method for building the `filter` part of the query definition
+          #
+          # @return [self]
+          #
+          def filter(*args, &block)
+            @filter = block ? Filter.new(*args, &block) : args.first
+            self
+          end
+
+          # Converts the query definition to a Hash
+          #
+          # @return [Hash]
+          #
+          def to_hash
+            hash = super
+            if @query
+              _query = @query.respond_to?(:to_hash) ? @query.to_hash : @query
+              hash[name].update(query: _query)
+            end
+            if @filter
+              _filter = @filter.respond_to?(:to_hash) ? @filter.to_hash : @filter
+              hash[name].update(filter: _filter)
+            end
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/dis_max.rb

@@ -0,0 +1,59 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A query which will score the documents based on the highest score of any individual specified query,
+        # not by summing the scores (as eg. a `bool` query would)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         dis_max do
+        #           queries [
+        #            { match: { title:   'albino' } },
+        #            { match: { content: 'elephant' } }
+        #           ]
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/_best_fields.html
+        #
+        class DisMax
+          include BaseComponent
+
+          option_method :queries
+          option_method :boost
+          option_method :tie_breaker
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/exists.rb

@@ -0,0 +1,68 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # Returns documents that have at least one non-null value in the field.
+        #
+        # @example Find documents with non-empty "name" property
+        #
+        #     search do
+        #       query do
+        #         exists do
+        #           field 'name'
+        #         end
+        #       end
+        #     end
+        #
+        # @note The "Exists" query can be used as a "Missing" query in a "Bool" query "Must Not" context.
+        #
+        # @example Find documents with an empty "name" property
+        #
+        #     search do
+        #       query do
+        #         bool do
+        #           must_not do
+        #             exists do
+        #               field 'name'
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class Exists
+          include BaseComponent
+
+          option_method :field
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/filtered.rb

@@ -0,0 +1,101 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A query which allows to combine a query with a filter
+        #
+        # @note It's possible and common to define just the `filter` part of the search definition,
+        #       for a structured search use case.
+        #
+        # @example Find documents about Twitter published last month
+        #
+        #     search do
+        #       query do
+        #         filtered do
+        #           query do
+        #             multi_match do
+        #               query 'twitter'
+        #               fields [ :title, :abstract, :content ]
+        #             end
+        #           end
+        #           filter do
+        #             range :published_on do
+        #               gte 'now-1M/M'
+        #             end
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-filtered-query.html
+        #
+        class Filtered
+          include BaseComponent
+
+          option_method :strategy
+
+          # DSL method for building the `query` part of the query definition
+          #
+          # @return [self]
+          #
+          def query(*args, &block)
+            @query = block ? @query = Query.new(*args, &block) : args.first
+            self
+          end
+
+          # DSL method for building the `filter` part of the query definition
+          #
+          # @return [self]
+          #
+          def filter(*args, &block)
+            @filter = block ? Filter.new(*args, &block) : args.first
+            self
+          end
+
+          # Converts the query definition to a Hash
+          #
+          # @return [Hash]
+          #
+          def to_hash
+            hash = super
+            if @query
+              _query = @query.respond_to?(:to_hash) ? @query.to_hash : @query
+              hash[name].update(query: _query)
+            end
+            if @filter
+              _filter = @filter.respond_to?(:to_hash) ? @filter.to_hash : @filter
+              hash[name].update(filter: _filter)
+            end
+            hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/function_score.rb

@@ -0,0 +1,122 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+# The OpenSearch Contributors require contributions made to
+# this file be licensed under the Apache-2.0 license or a
+# compatible open source license.
+#
+# Modifications Copyright OpenSearch Contributors. See
+# GitHub history for details.
+#
+# 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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A query which allows to modify the score of documents matching the query,
+        # either via built-in functions or a custom script
+        #
+        # @example Find documents with specific amenities, boosting documents within a certain
+        #          price range and geogprahical location
+        #
+        #     search do
+        #       query do
+        #         function_score do
+        #           filter do
+        #             terms amenities: ['wifi', 'pets']
+        #           end
+        #           functions << { gauss: { price:    { origin: 100, scale: 200 } } }
+        #           functions << { gauss: { location: { origin: '50.090223,14.399590', scale: '5km' } } }
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/guide/current/function-score-query.html
+        #
+        class FunctionScore
+          include BaseComponent
+
+          option_method :script_score
+          option_method :boost
+          option_method :max_boost
+          option_method :score_mode
+          option_method :boost_mode
+
+          def initialize(*args, &block)
+            super
+            @functions = []
+          end
+
+          # DSL method for building the `query` part of the query definition
+          #
+          # @return [self]
+          #
+          def query(*args, &block)
+            @query = block ? @query = Query.new(*args, &block) : args.first
+            self
+          end
+
+          # DSL method for building the `filter` part of the query definition
+          #
+          # @return [self]
+          #
+          def filter(*args, &block)
+            @filter = block ? Filter.new(*args, &block) : args.first
+            self
+          end
+
+          # DSL method for building the `functions` part of the query definition
+          #
+          # @return [Array]
+          #
+          def functions(value = nil)
+            if value
+              @functions = value
+            else
+              @functions
+            end
+          end
+
+          # Set the `functions` part of the query definition
+          #
+          # @return [Array]
+          #
+          attr_writer :functions
+
+          # Converts the query definition to a Hash
+          #
+          # @return [Hash]
+          #
+          def to_hash
+            hash = super
+            if @query
+              _query = @query.respond_to?(:to_hash) ? @query.to_hash : @query
+              hash[name].update(query: _query)
+            end
+            if @filter
+              _filter = @filter.respond_to?(:to_hash) ? @filter.to_hash : @filter
+              hash[name].update(filter: _filter)
+            end
+            hash[name].update(functions: @functions) unless @functions.empty?
+            hash
+          end
+        end
+      end
+    end
+  end
+end