[API] Adds sql async APIs

Author: picandocodigo

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/sql/delete_async.rb

@@ -0,0 +1,50 @@
+# 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 Elasticsearch
+  module XPack
+    module API
+      module SQL
+        module Actions
+          # Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
+          #
+          # @option arguments [String] :id The async search ID
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/delete-async-sql-search-api.html
+          #
+          def delete_async(arguments = {})
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_DELETE
+            path   = "_sql/async/delete/#{Elasticsearch::API::Utils.__listify(_id)}"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/sql/get_async.rb

@@ -0,0 +1,64 @@
+# 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 Elasticsearch
+  module XPack
+    module API
+      module SQL
+        module Actions
+          # Returns the current status and available results for an async SQL search or stored synchronous SQL search
+          #
+          # @option arguments [String] :id The async search ID
+          # @option arguments [String] :delimiter Separator for CSV results
+          # @option arguments [String] :format Short version of the Accept header, e.g. json, yaml
+          # @option arguments [Time] :keep_alive Retention period for the search and its results
+          # @option arguments [Time] :wait_for_completion_timeout Duration to wait for complete results
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/get-async-sql-search-api.html
+          #
+          def get_async(arguments = {})
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_sql/async/#{Elasticsearch::API::Utils.__listify(_id)}"
+            params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+
+          # Register this action with its valid params when the module is loaded.
+          #
+          # @since 6.2.0
+          ParamsRegistry.register(:get_async, [
+            :delimiter,
+            :format,
+            :keep_alive,
+            :wait_for_completion_timeout
+          ].freeze)
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/sql/get_async_status.rb

@@ -0,0 +1,50 @@
+# 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 Elasticsearch
+  module XPack
+    module API
+      module SQL
+        module Actions
+          # Returns the current status of an async SQL search or a stored synchronous SQL search
+          #
+          # @option arguments [String] :id The async search ID
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.14/get-async-sql-search-status-api.html
+          #
+          def get_async_status(arguments = {})
+            raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _id = arguments.delete(:id)
+
+            method = Elasticsearch::API::HTTP_GET
+            path   = "_sql/async/status/#{Elasticsearch::API::Utils.__listify(_id)}"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

elasticsearch-xpack/spec/xpack/sql/delete_async_spec.rb

@@ -0,0 +1,48 @@
+# 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 'spec_helper'
+
+describe 'client.sql#delete_async' do
+  let(:expected_args) do
+    [
+      'DELETE',
+      '_sql/async/delete/foo',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  context 'when there is no id specified' do
+    let(:client) do
+      Class.new { include Elasticsearch::XPack::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.sql.delete_async
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index is specified' do
+    it 'performs the request' do
+      expect(client_double.sql.delete_async(id: 'foo')).to eq({})
+    end
+  end
+end

elasticsearch-xpack/spec/xpack/sql/get_async_spec.rb

@@ -0,0 +1,48 @@
+# 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 'spec_helper'
+
+describe 'client.sql#get_async' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_sql/async/foo',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  context 'when there is no id specified' do
+    let(:client) do
+      Class.new { include Elasticsearch::XPack::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.sql.get_async
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index is specified' do
+    it 'performs the request' do
+      expect(client_double.sql.get_async(id: 'foo')).to eq({})
+    end
+  end
+end

elasticsearch-xpack/spec/xpack/sql/get_async_status_spec.rb

@@ -0,0 +1,48 @@
+# 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 'spec_helper'
+
+describe 'client.sql#get_async_status' do
+  let(:expected_args) do
+    [
+      'GET',
+      '_sql/async/status/foo',
+      {},
+      nil,
+      {}
+    ]
+  end
+
+  context 'when there is no id specified' do
+    let(:client) do
+      Class.new { include Elasticsearch::XPack::API }.new
+    end
+
+    it 'raises an exception' do
+      expect {
+        client.sql.get_async_status
+      }.to raise_exception(ArgumentError)
+    end
+  end
+
+  context 'when an index is specified' do
+    it 'performs the request' do
+      expect(client_double.sql.get_async_status(id: 'foo')).to eq({})
+    end
+  end
+end