opensearch-ruby 2.1.0 → 3.0.0

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

@@ -0,0 +1,58 @@
+# 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 a custom query only for documents in specified indices,
+        # and optionally another query for documents in other indices
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         indices do
+        #           indices        ['audio', 'video']
+        #           query          match: { artist: 'Fugazi' }
+        #           no_match_query match: { label:  'Dischord' }
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-indices-query.html
+        #
+        class Indices
+          include BaseComponent
+
+          option_method :indices
+          option_method :query
+          option_method :no_match_query
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# 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 simple to use, yet sophisticated query which returns documents matching the specified terms,
+        # taking into account field types, analyzers, etc. and allowing to search in phrase, prefix, fuzzy modes
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         match :content do
+        #           query    'how to fix my printer'
+        #           operator 'and'
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class Match
+          include BaseComponent
+
+          option_method :query
+          option_method :operator
+          option_method :minimum_should_match
+          option_method :type
+          option_method :boost
+          option_method :fuzziness
+          option_method :prefix_length
+          option_method :max_expansions
+          option_method :fuzzy_rewrite
+          option_method :analyzer
+          option_method :lenient
+          option_method :zero_terms_query
+          option_method :cutoff_frequency
+          option_method :max_expansions
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,50 @@
+# 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 matches all documents
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         match_all
+        #       end
+        #     end
+        #
+        #
+        class MatchAll
+          include BaseComponent
+
+          option_method :boost
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+# 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 that analyzes the text and creates a phrase query out of the analyzed text
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         match_phrase :content do
+        #           query 'example content'
+        #           analyzer 'standard'
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class MatchPhrase
+          include BaseComponent
+
+          option_method :query
+          option_method :analyzer
+          option_method :boost
+          option_method :slop
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# 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
+        # The same as match_phrase, except that it allows for prefix matches on the last term in the text
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         match_phrase_prefix :content do
+        #           query 'example content'
+        #           max_expansions 10
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class MatchPhrasePrefix
+          include BaseComponent
+
+          option_method :query
+          option_method :boost
+          option_method :max_expansions
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# 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 returns documents which are similar to the specified text or documents
+        #
+        # @example Find documents similar to the provided text
+        #
+        #     search do
+        #       query do
+        #         more_like_this do
+        #           like   ['Eyjafjallajökull']
+        #           fields [:title, :abstract, :content]
+        #         end
+        #       end
+        #     end
+        #
+        #
+        # @example Find documents similar to the specified documents
+        #
+        #     search do
+        #       query do
+        #         more_like_this do
+        #           like   [{_id: 1}, {_id: 2}, {_id: 3}]
+        #           fields [:title, :abstract]
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-mlt-query.html
+        #
+        class MoreLikeThis
+          include BaseComponent
+
+          # like/unlike is since 2.0.0
+          option_method :like
+          option_method :unlike
+
+          # before 2.0.0 the following 3 options were available
+          option_method :like_text
+          option_method :docs
+          option_method :ids
+
+          option_method :fields
+          option_method :min_term_freq
+          option_method :max_query_terms
+          option_method :include
+          option_method :exclude
+          option_method :percent_terms_to_match
+          option_method :stop_words
+          option_method :min_doc_freq
+          option_method :max_doc_freq
+          option_method :min_word_length
+          option_method :max_word_length
+          option_method :boost_terms
+          option_method :boost
+          option_method :analyzer
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# 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 use the `match` query on multiple fields
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         multi_match do
+        #           query    'how to fix my printer'
+        #           fields   [:title, :abstract, :content]
+        #           operator 'and'
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-multi-match-query.html
+        #
+        class MultiMatch
+          include BaseComponent
+
+          option_method :analyzer
+          option_method :boost
+          option_method :cutoff_frequency
+          option_method :fields
+          option_method :fuzziness
+          option_method :max_expansions
+          option_method :minimum_should_match
+          option_method :operator
+          option_method :prefix_length
+          option_method :query
+          option_method :rewrite
+          option_method :slop
+          option_method :type
+          option_method :use_dis_max
+          option_method :zero_terms_query
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,80 @@
+# 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 returns the root documents for nested documents matching the specified query
+        #
+        # @example Return articles where John has commented
+        #
+        #     search do
+        #       query do
+        #         nested do
+        #           path 'comments'
+        #           query do
+        #             match user: 'John'
+        #           end
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-nested-query.html
+        #
+        class Nested
+          include BaseComponent
+
+          option_method :path
+          option_method :score_mode
+          option_method :inner_hits
+
+          # 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
+
+          # 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
+            hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# 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 returns documents matching a specified prefix
+        #
+        # @example
+        #
+        # search do
+        #   query do
+        #     prefix :title do
+        #       value 'dis'
+        #     end
+        #   end
+        # end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-prefix-query.html
+        #
+        class Prefix
+          include BaseComponent
+
+          option_method :value
+          option_method :boost
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# 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 returns documents matching a specified expression in the Lucene Query String syntax
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         query_string do
+        #           query '(mortgage OR (bank AND loan)) AND published_on:[2013-01-01 TO 2013-12-31]'
+        #           fields [:title, :content]
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://lucene.apache.org/core/2_9_4/queryparsersyntax.html
+        #
+        class QueryString
+          include BaseComponent
+
+          option_method :query
+          option_method :fields
+          option_method :type
+          option_method :default_field
+          option_method :default_operator
+          option_method :analyzer
+          option_method :allow_leading_wildcard
+          option_method :lowercase_expanded_terms
+          option_method :enable_position_increments
+          option_method :fuzzy_max_expansions
+          option_method :fuzziness
+          option_method :fuzzy_prefix_length
+          option_method :phrase_slop
+          option_method :boost
+          option_method :analyze_wildcard
+          option_method :auto_generate_phrase_queries
+          option_method :minimum_should_match
+          option_method :lenient
+          option_method :locale
+          option_method :use_dis_max
+          option_method :tie_breaker
+          option_method :time_zone
+        end
+      end
+    end
+  end
+end