opensearch-ruby 2.0.3 → 3.4.0

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

@@ -0,0 +1,71 @@
+# 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 the specified range
+        #
+        # @example Find documents within a numeric range
+        #
+        #     search do
+        #       query do
+        #         range :age do
+        #           gte 10
+        #           lte 20
+        #         end
+        #       end
+        #     end
+        #
+        # @example Find documents published within a date range
+        #
+        #     search do
+        #       query do
+        #         range :published_on do
+        #           gte '2013-01-01'
+        #           lte 'now'
+        #           time_zone '+1:00'
+        #         end
+        #       end
+        #     end
+        #
+        #
+        class Range
+          include BaseComponent
+
+          option_method :gte
+          option_method :gt
+          option_method :lte
+          option_method :lt
+          option_method :boost
+          option_method :time_zone
+          option_method :format
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/regexp.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
+        # A query which matches documents matching a regular expression
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         regexp :path do
+        #           value '^/usr/?.*/var'
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-regexp-query.html
+        #
+        class Regexp
+          include BaseComponent
+
+          option_method :value
+          option_method :boost
+          option_method :flags
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/script_score.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.
+
+module OpenSearch
+  module DSL
+    module Search
+      module Queries
+        # A query which wraps another query and returns a customized score for matching documents
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         script_score do
+        #           query do
+        #             match content: 'Twitter'
+        #           end
+        #
+        #           script source: "_score * params['multiplier']",
+        #                  params: { multiplier: 2.0 }
+        #         end
+        #       end
+        #     end
+        #
+        # @see https://opensearch.org/docs/latest/query-dsl/specialized/script-score/
+        #
+        class ScriptScore
+          include BaseComponent
+
+          option_method :script
+          option_method :min_score
+          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
+
+          # 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/simple_query_string.rb

@@ -0,0 +1,64 @@
+# 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 simplified query string syntax
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         simple_query_string do
+        #           query  'disaster -health'
+        #           fields ['title^5', 'abstract', 'content']
+        #           default_operator 'and'
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-simple-query-string-query.html
+        #
+        class SimpleQueryString
+          include BaseComponent
+
+          option_method :query
+          option_method :fields
+          option_method :default_operator
+          option_method :analyzer
+          option_method :flags
+          option_method :analyze_wildcard
+          option_method :lenient
+          option_method :minimum_should_match
+          option_method :quote_field_suffix
+          option_method :all_fields
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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 having spans in the beginning of the field
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         span_first match: { span_term: { title: 'disaster' } }, end: 10
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-span-first-query.html
+        # @see https://lucene.apache.org/core/5_0_0/core/org/apache/lucene/search/spans/package-summary.html
+        #
+        class SpanFirst
+          include BaseComponent
+
+          option_method :match
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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 multi-term query as a span query
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         span_multi match: { prefix: { name: 'jo' } }
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-span-multi-term-query.html
+        # @see https://lucene.apache.org/core/5_0_0/core/org/apache/lucene/search/spans/package-summary.html
+        #
+        class SpanMulti
+          include BaseComponent
+
+          option_method :match
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/span_near.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 which returns documents matching spans near each other
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         span_near clauses: [ { span_term: { title: 'disaster' } }, { span_term: { title: 'health' } } ],
+        #                   slop: 10
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-span-near-query.html
+        # @see https://lucene.apache.org/core/5_0_0/core/org/apache/lucene/search/spans/package-summary.html
+        #
+        class SpanNear
+          include BaseComponent
+
+          option_method :span_near
+          option_method :slop
+          option_method :in_order
+          option_method :collect_payloads
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/span_not.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 discards matching documents which overlap with another query
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         span_not include: { span_term: { title: 'disaster' } },
+        #                  exclude: { span_term: { title: 'health' } }
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-span-not-query.html
+        # @see https://lucene.apache.org/core/5_0_0/core/org/apache/lucene/search/spans/package-summary.html
+        #
+        class SpanNot
+          include BaseComponent
+
+          option_method :include
+          option_method :exclude
+          option_method :pre
+          option_method :post
+          option_method :dist
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# 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 the union of provided queries
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         span_or clauses: [ { span_term: { title: 'disaster' } }, { span_term: { title: 'health' } } ]
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-span-or-query.html
+        # @see https://lucene.apache.org/core/5_0_0/core/org/apache/lucene/search/spans/package-summary.html
+        #
+        class SpanOr
+          include BaseComponent
+
+          option_method :clauses
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/span_term.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 returns documents having a span containing a term
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         span_term title: 'disaster'
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-span-term-query.html
+        # @see https://lucene.apache.org/core/5_0_0/core/org/apache/lucene/search/spans/package-summary.html
+        #
+        class SpanTerm
+          include BaseComponent
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/template.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
+        # A query which allows to use Mustache templates for query definitions
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         template do
+        #           query  match: { content: '{query_string}' }
+        #           params query_string: 'twitter'
+        #         end
+        #       end
+        #     end
+        #
+        # @see http://opensearch.org/guide/en/opensearch/reference/current/query-dsl-template-query.html
+        #
+        class Template
+          include BaseComponent
+
+          option_method :query
+          option_method :params
+        end
+      end
+    end
+  end
+end

data/lib/opensearch/dsl/search/queries/term.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 returns documents matching the specified term
+        #
+        # @note The specified term is *not analyzed* (lowercased, stemmed, etc)
+        #
+        # @example
+        #
+        #     search do
+        #       query do
+        #         term category: 'Opinion'
+        #       end
+        #     end
+        #
+        #
+        class Term
+          include BaseComponent
+        end
+      end
+    end
+  end
+end