Class: WebApiActivequerybuilder::ActiveQueryBuilderApi
- Inherits:
-
Object
- Object
- WebApiActivequerybuilder::ActiveQueryBuilderApi
- Defined in:
- lib/webapi-active-query-builder/api/active_query_builder_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_query_columns_post(query, opts = {}) ⇒ Array<QueryColumn>
Returns list of columns for the given SQL query.
-
#get_query_columns_post_with_http_info(query, opts = {}) ⇒ Array<(Array<QueryColumn>, Fixnum, Hash)>
Returns list of columns for the given SQL query.
-
#initialize(api_client = ApiClient.default) ⇒ ActiveQueryBuilderApi
constructor
A new instance of ActiveQueryBuilderApi.
-
#transform_sql_post(transform, opts = {}) ⇒ TransformResult
Transforms the given SQL query according to the commands provided in this request.
-
#transform_sql_post_with_http_info(transform, opts = {}) ⇒ Array<(TransformResult, Fixnum, Hash)>
Transforms the given SQL query according to the commands provided in this request.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ ActiveQueryBuilderApi
Returns a new instance of ActiveQueryBuilderApi.
30 31 32 |
# File 'lib/webapi-active-query-builder/api/active_query_builder_api.rb', line 30 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
28 29 30 |
# File 'lib/webapi-active-query-builder/api/active_query_builder_api.rb', line 28 def api_client @api_client end |
Instance Method Details
#get_query_columns_post(query, opts = {}) ⇒ Array<QueryColumn>
Returns list of columns for the given SQL query.
39 40 41 42 |
# File 'lib/webapi-active-query-builder/api/active_query_builder_api.rb', line 39 def get_query_columns_post(query, opts = {}) data, _status_code, _headers = get_query_columns_post_with_http_info(query, opts) return data end |
#get_query_columns_post_with_http_info(query, opts = {}) ⇒ Array<(Array<QueryColumn>, Fixnum, Hash)>
Returns list of columns for the given SQL query.
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
# File 'lib/webapi-active-query-builder/api/active_query_builder_api.rb', line 49 def get_query_columns_post_with_http_info(query, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ActiveQueryBuilderApi.get_query_columns_post ..." end # verify the required parameter 'query' is set fail ArgumentError, "Missing the required parameter 'query' when calling ActiveQueryBuilderApi.get_query_columns_post" if query.nil? # resource path local_var_path = "/getQueryColumns".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json', 'text/html'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/xml'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(query) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'Array<QueryColumn>') if @api_client.config.debugging @api_client.config.logger.debug "API called: ActiveQueryBuilderApi#get_query_columns_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#transform_sql_post(transform, opts = {}) ⇒ TransformResult
Transforms the given SQL query according to the commands provided in this request. You can add constraints, hide some of the resultset columns, chang sorting or limit rows of resultset. All transformations can only lead to reorganization or limitation of the resultset data. This means that it’s impossible to get transformed SQL that reveals any other data than the data retutned by original query.
96 97 98 99 |
# File 'lib/webapi-active-query-builder/api/active_query_builder_api.rb', line 96 def transform_sql_post(transform, opts = {}) data, _status_code, _headers = transform_sql_post_with_http_info(transform, opts) return data end |
#transform_sql_post_with_http_info(transform, opts = {}) ⇒ Array<(TransformResult, Fixnum, Hash)>
Transforms the given SQL query according to the commands provided in this request. You can add constraints, hide some of the resultset columns, chang sorting or limit rows of resultset. All transformations can only lead to reorganization or limitation of the resultset data. This means that it's impossible to get transformed SQL that reveals any other data than the data retutned by original query.
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 |
# File 'lib/webapi-active-query-builder/api/active_query_builder_api.rb', line 106 def transform_sql_post_with_http_info(transform, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: ActiveQueryBuilderApi.transform_sql_post ..." end # verify the required parameter 'transform' is set fail ArgumentError, "Missing the required parameter 'transform' when calling ActiveQueryBuilderApi.transform_sql_post" if transform.nil? # resource path local_var_path = "/transformSQL".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json', 'text/html'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json', 'text/xml'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(transform) auth_names = [] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'TransformResult') if @api_client.config.debugging @api_client.config.logger.debug "API called: ActiveQueryBuilderApi#transform_sql_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |