Skip to content

Commit f67d701

Browse files
penghuopenghuo
authored
Change the default response format to JDBC. (#334)
* change the default response fromat to jdbc * update doc
1 parent 580a5d3 commit f67d701

File tree

15 files changed

+498
-121
lines changed

15 files changed

+498
-121
lines changed

‎build.gradle

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ plugins {
3434
id 'nebula.ospackage' version "5.3.0"
3535
id 'java-library'
3636
id 'checkstyle'
37+
id "io.freefair.lombok" version "4.1.2"
3738
}
3839

3940
/*
@@ -99,6 +100,7 @@ esplugin {
99100
// TODO: fix compiler warnings
100101
compileJava.options.warnings = false
101102
compileJava {
103+
options.compilerArgs.addAll(["-processor", 'lombok.launch.AnnotationProcessorHider$AnnotationProcessor'])
102104
doFirst {
103105
// TODO: do not fail build on warnings, need to fix all compiler warnings
104106
options.compilerArgs.remove('-Werror')

‎docs/user/admin/settings.rst

Lines changed: 110 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ SQL query::
3939

4040
>> curl -H 'Content-Type: application/json' -X PUT localhost:9200/_cluster/settings -d '{
4141
"transient" : {
42-
"opendistro.sql.enabled" : false
42+
"opendistro.sql.enabled" : "false"
4343
}
4444
}'
4545

@@ -101,7 +101,7 @@ SQL query::
101101

102102
>> curl -H 'Content-Type: application/json' -X PUT localhost:9200/_cluster/settings -d '{
103103
"transient" : {
104-
"opendistro.sql.query.slowlog" : 10
104+
"opendistro.sql.query.slowlog" : "10"
105105
}
106106
}'
107107

@@ -143,7 +143,7 @@ SQL query::
143143

144144
>> curl -H 'Content-Type: application/json' -X PUT localhost:9200/_cluster/settings -d '{
145145
"transient" : {
146-
"opendistro.sql.query.analysis.enabled" : false
146+
"opendistro.sql.query.analysis.enabled" : "false"
147147
}
148148
}'
149149

@@ -187,7 +187,7 @@ SQL query::
187187

188188
>> curl -H 'Content-Type: application/json' -X PUT localhost:9200/_cluster/settings -d '{
189189
"transient" : {
190-
"opendistro.sql.query.analysis.semantic.suggestion" : true
190+
"opendistro.sql.query.analysis.semantic.suggestion" : "true"
191191
}
192192
}'
193193

@@ -255,7 +255,7 @@ SQL query::
255255

256256
>> curl -H 'Content-Type: application/json' -X PUT localhost:9200/_cluster/settings -d '{
257257
"transient" : {
258-
"opendistro.sql.query.analysis.semantic.threshold" : 50
258+
"opendistro.sql.query.analysis.semantic.threshold" : "50"
259259
}
260260
}'
261261

@@ -279,3 +279,108 @@ Result set::
279279
}
280280
}
281281

282+
opendistro.sql.query.response.format
283+
====================================
284+
285+
Description
286+
-----------
287+
288+
User can set default response format of the query. The supported format includes: jdbc,json,csv,raw,table.
289+
290+
1. The default value is jdbc.
291+
2. This setting is node scope.
292+
3. This setting can be updated dynamically.
293+
294+
295+
Example 1
296+
---------
297+
298+
You can update the setting with a new value like this.
299+
300+
SQL query::
301+
302+
>> curl -H 'Content-Type: application/json' -X PUT localhost:9200/_cluster/settings -d '{
303+
"transient" : {
304+
"opendistro.sql.query.response.format" : "json"
305+
}
306+
}'
307+
308+
Result set::
309+
310+
{
311+
"acknowledged" : true,
312+
"persistent" : { },
313+
"transient" : {
314+
"opendistro" : {
315+
"sql" : {
316+
"query" : {
317+
"response" : {
318+
"format" : "json"
319+
}
320+
}
321+
}
322+
}
323+
}
324+
}
325+
326+
Example 2
327+
---------
328+
329+
Query result after the setting updated is like:
330+
331+
SQL query::
332+
333+
>> curl -H 'Content-Type: application/json' -X POST localhost:9200/_opendistro/_sql -d '{
334+
"query" : "SELECT firstname, lastname, age FROM accounts ORDER BY age LIMIT 2"
335+
}'
336+
337+
Result set::
338+
339+
{
340+
"_shards" : {
341+
"total" : 5,
342+
"failed" : 0,
343+
"successful" : 5,
344+
"skipped" : 0
345+
},
346+
"hits" : {
347+
"hits" : [
348+
{
349+
"_index" : "accounts",
350+
"_type" : "account",
351+
"_source" : {
352+
"firstname" : "Nanette",
353+
"age" : 28,
354+
"lastname" : "Bates"
355+
},
356+
"_id" : "13",
357+
"sort" : [
358+
28
359+
],
360+
"_score" : null
361+
},
362+
{
363+
"_index" : "accounts",
364+
"_type" : "account",
365+
"_source" : {
366+
"firstname" : "Amber",
367+
"age" : 32,
368+
"lastname" : "Duke"
369+
},
370+
"_id" : "1",
371+
"sort" : [
372+
32
373+
],
374+
"_score" : null
375+
}
376+
],
377+
"total" : {
378+
"value" : 4,
379+
"relation" : "eq"
380+
},
381+
"max_score" : null
382+
},
383+
"took" : 100,
384+
"timed_out" : false
385+
}
386+

‎docs/user/interfaces/protocol.rst

Lines changed: 69 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -133,80 +133,13 @@ Explain::
133133
}
134134
}
135135

136-
Elasticsearch DSL
137-
=================
138-
139-
Description
140-
-----------
141-
142-
By default the plugin returns original response from Elasticsearch in JSON. Because this is the native response from Elasticsearch, extra efforts are needed to parse and interpret it.
143-
144-
Example
145-
-------
146-
147-
SQL query::
148-
149-
>> curl -H 'Content-Type: application/json' -X POST localhost:9200/_opendistro/_sql -d '{
150-
"query" : "SELECT firstname, lastname, age FROM accounts ORDER BY age LIMIT 2"
151-
}'
152-
153-
Result set::
154-
155-
{
156-
"_shards" : {
157-
"total" : 5,
158-
"failed" : 0,
159-
"successful" : 5,
160-
"skipped" : 0
161-
},
162-
"hits" : {
163-
"hits" : [
164-
{
165-
"_index" : "accounts",
166-
"_type" : "account",
167-
"_source" : {
168-
"firstname" : "Nanette",
169-
"age" : 28,
170-
"lastname" : "Bates"
171-
},
172-
"_id" : "13",
173-
"sort" : [
174-
28
175-
],
176-
"_score" : null
177-
},
178-
{
179-
"_index" : "accounts",
180-
"_type" : "account",
181-
"_source" : {
182-
"firstname" : "Amber",
183-
"age" : 32,
184-
"lastname" : "Duke"
185-
},
186-
"_id" : "1",
187-
"sort" : [
188-
32
189-
],
190-
"_score" : null
191-
}
192-
],
193-
"total" : {
194-
"value" : 4,
195-
"relation" : "eq"
196-
},
197-
"max_score" : null
198-
},
199-
"took" : 100,
200-
"timed_out" : false
201-
}
202-
203136
JDBC Format
204137
===========
205138

206139
Description
207140
-----------
208141

209-
JDBC format is provided for JDBC driver and client side that needs both schema and result set well formatted.
142+
By default the plugin return JDBC format. JDBC format is provided for JDBC driver and client side that needs both schema and result set well formatted.
210143

211144
Example 1
212145
---------
@@ -215,7 +148,7 @@ Here is an example for normal response. The `schema` includes field name and its
215148

216149
SQL query::
217150

218-
>> curl -H 'Content-Type: application/json' -X POST localhost:9200/_opendistro/_sql?format=jdbc -d '{
151+
>> curl -H 'Content-Type: application/json' -X POST localhost:9200/_opendistro/_sql -d '{
219152
"query" : "SELECT firstname, lastname, age FROM accounts ORDER BY age LIMIT 2"
220153
}'
221154

@@ -275,6 +208,73 @@ Result set::
275208
"status" : 400
276209
}
277210

211+
Elasticsearch DSL
212+
=================
213+
214+
Description
215+
-----------
216+
217+
The plugin returns original response from Elasticsearch in JSON. Because this is the native response from Elasticsearch, extra efforts are needed to parse and interpret it.
218+
219+
Example
220+
-------
221+
222+
SQL query::
223+
224+
>> curl -H 'Content-Type: application/json' -X POST localhost:9200/_opendistro/_sql?format=json -d '{
225+
"query" : "SELECT firstname, lastname, age FROM accounts ORDER BY age LIMIT 2"
226+
}'
227+
228+
Result set::
229+
230+
{
231+
"_shards" : {
232+
"total" : 5,
233+
"failed" : 0,
234+
"successful" : 5,
235+
"skipped" : 0
236+
},
237+
"hits" : {
238+
"hits" : [
239+
{
240+
"_index" : "accounts",
241+
"_type" : "account",
242+
"_source" : {
243+
"firstname" : "Nanette",
244+
"age" : 28,
245+
"lastname" : "Bates"
246+
},
247+
"_id" : "13",
248+
"sort" : [
249+
28
250+
],
251+
"_score" : null
252+
},
253+
{
254+
"_index" : "accounts",
255+
"_type" : "account",
256+
"_source" : {
257+
"firstname" : "Amber",
258+
"age" : 32,
259+
"lastname" : "Duke"
260+
},
261+
"_id" : "1",
262+
"sort" : [
263+
32
264+
],
265+
"_score" : null
266+
}
267+
],
268+
"total" : {
269+
"value" : 4,
270+
"relation" : "eq"
271+
},
272+
"max_score" : null
273+
},
274+
"took" : 100,
275+
"timed_out" : false
276+
}
277+
278278
CSV Format
279279
==========
280280

‎lombok.config

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# This file is generated by the 'io.freefair.lombok' Gradle plugin
2+
config.stopBubbling = true
3+
lombok.addLombokGeneratedAnnotation = true

‎src/main/java/com/amazon/opendistroforelasticsearch/sql/executor/ActionRequestRestExecutorFactory.java

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,10 @@
2121
import com.amazon.opendistroforelasticsearch.sql.query.join.ESJoinQueryAction;
2222
import com.amazon.opendistroforelasticsearch.sql.query.multi.MultiQueryAction;
2323

24-
import java.util.stream.Stream;
25-
2624
/**
2725
* Created by Eliran on 26/12/2015.
2826
*/
2927
public class ActionRequestRestExecutorFactory {
30-
3128
/**
3229
* Create executor based on the format and wrap with AsyncRestExecutor
3330
* to async blocking execute() call if necessary.
@@ -36,23 +33,21 @@ public class ActionRequestRestExecutorFactory {
3633
* @param queryAction query action
3734
* @return executor
3835
*/
39-
public static RestExecutor createExecutor(String format, QueryAction queryAction) {
40-
if (format == null || format.equals("")) {
41-
return new AsyncRestExecutor(
42-
new ElasticDefaultRestExecutor(queryAction),
43-
action -> isJoin(action) || isUnionMinus(action)
44-
);
45-
}
46-
47-
if (format.equalsIgnoreCase("csv")) {
48-
return new AsyncRestExecutor(new CSVResultRestExecutor());
36+
public static RestExecutor createExecutor(Format format, QueryAction queryAction) {
37+
switch (format) {
38+
case CSV:
39+
return new AsyncRestExecutor(new CSVResultRestExecutor());
40+
case JSON:
41+
return new AsyncRestExecutor(
42+
new ElasticDefaultRestExecutor(queryAction),
43+
action -> isJoin(action) || isUnionMinus(action)
44+
);
45+
case JDBC:
46+
case RAW:
47+
case TABLE:
48+
default:
49+
return new AsyncRestExecutor(new PrettyFormatRestExecutor(format.getFormatName()));
4950
}
50-
51-
if (Stream.of("jdbc", "table", "raw").anyMatch(format::equalsIgnoreCase)) {
52-
return new AsyncRestExecutor(new PrettyFormatRestExecutor(format));
53-
}
54-
55-
throw new IllegalArgumentException("Failed to create executor due to unknown response format: " + format);
5651
}
5752

5853
private static boolean isJoin(QueryAction queryAction) {

0 commit comments

Comments
 (0)