├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── pom.xml └── src ├── RedshiftJDBC41-1.1.7.1007.jar └── main ├── java ├── Bootstrap.java ├── config │ └── ReadProperties.java ├── endpoint │ ├── QueryResource.java │ └── SQLApplication.java └── jdbc │ └── Query.java └── resources └── jdbc.config /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | 3 | # Mobile Tools for Java (J2ME) 4 | .mtj.tmp/ 5 | 6 | # Package Files # 7 | *.war 8 | *.ear 9 | .idea/ 10 | target 11 | *.iml 12 | .gradle/ 13 | build/ 14 | 15 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml 16 | hs_err_pid* 17 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM jamesdbloom/docker-java8-maven 2 | MAINTAINER jamescross91 3 | # ENV JAVA_HOME /usr/lib/jvm/java-8-openjdk-amd64 4 | 5 | # # Update 6 | # RUN apt-get update 7 | 8 | # RUN apt-get install -y maven 9 | 10 | RUN mkdir sqlrest 11 | 12 | ADD . /sqlrest 13 | 14 | ENTRYPOINT mvn -f /sqlrest/pom.xml clean compile assembly:single && /usr/lib/jvm/java-1.8.0-openjdk-amd64/jre/bin/java -classpath .:/sqlrest/target/jdbc-sql-rest-1.0-jar-with-dependencies.jar:/sqlrest/src/RedshiftJDBC41-1.1.7.1007.jar Bootstrap 15 | #ENTRYPOINT /bin/sh -c bash -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # jdbc-sql-rest 2 | A primitive REST Api wrapper for SQL calls to a JDBC compliant database. 3 | 4 | ###Configuration & Setup 5 | 1. Fill out the required config details in src/main/resources/jdbc.config - this example is pre-populated for use with redshift 6 | 2. Make sure the JDBC java depedency you require is either in the classpath (mvn dependency or otherwise). 7 | 8 | This example is configured to query an Amazon Redshift cluster. You will notice that the Redshift JDBC driver is included, and referenced in the pom. If you reference a different driver class in your config make sure the driver is included in your classpath otherwise it will stack trace. 9 | 10 | ###Port 11 | The app binds to port 2511 by default. This can be changed in Bootstrap.java, or when im less lazy I will make it configurable. 12 | 13 | ###Docker 14 | If you have docker installed you can launch the application very easily 15 | 16 | 1. docker built -t jamescross91/sql-rest . 17 | 2. docker run -it -p 2511:2511 jamescross91/sql-rest 18 | 19 | ###Endpoints 20 | There is a single REST endpoint: /query. It expects a JSON body like this: 21 | 22 | ``` 23 | { 24 | "sql": "select * from pcap limit 10"; 25 | } 26 | ``` 27 | 28 | ###Example query/response 29 | 30 | ####Query 31 | ``` 32 | curl -H "Content-Type: application/json" -X POST -d '{"sql":"select * from pcap limit 1"}' http://localhost:2511/query 33 | ``` 34 | 35 | ####Response 36 | ``` 37 | [ 38 | { 39 | "field1": "blah", 40 | "field2": "blah", 41 | "field3": "151021-mall", 42 | "field4": 64, 43 | "field5": 1445429544.715729 44 | } 45 | ] 46 | ``` 47 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 4.0.0 6 | 7 | 8 | 9 | maven-restlet 10 | Public online Restlet repository 11 | http://maven.restlet.com 12 | 13 | 14 | 15 | io.jamescross 16 | jdbc-sql-rest 17 | 1.0 18 | jar 19 | JDBC SQL REST 20 | http://maven.apache.org 21 | 22 | 23 | 24 | 1.8 25 | 1.8 26 | 27 | 28 | 29 | 30 | org.restlet.jse 31 | org.restlet 32 | 2.3.0 33 | 34 | 35 | org.restlet.jse 36 | org.restlet.ext.json 37 | 2.3.0 38 | 39 | 40 | org.restlet.jse 41 | org.restlet.ext.jetty 42 | 2.3.0 43 | 44 | 45 | log4j 46 | log4j 47 | 1.2.16 48 | 49 | 50 | org.apache.commons 51 | commons-lang3 52 | 3.0 53 | 54 | 55 | org.projectlombok 56 | lombok 57 | 1.12.6 58 | 59 | 60 | org.slf4j 61 | slf4j-api 62 | 1.7.5 63 | 64 | 65 | org.slf4j 66 | slf4j-log4j12 67 | 1.7.5 68 | 69 | 70 | org.restlet.jse 71 | org.restlet.lib.org.restlet.lib.org.json 72 | 2.0 73 | 74 | 75 | junit 76 | junit 77 | 4.12 78 | 79 | 80 | org.apache.commons 81 | commons-dbcp2 82 | 2.1.1 83 | 84 | 85 | org.springframework 86 | spring-jdbc 87 | 4.2.2.RELEASE 88 | 89 | 90 | com.google.code.gson 91 | gson 92 | 2.3.1 93 | 94 | 95 | redshift 96 | com.amazon 97 | 1.0 98 | system 99 | ${project.basedir}/src/RedshiftJDBC41-1.1.7.1007.jar 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | maven-assembly-plugin 108 | 109 | 110 | 111 | Bootstrap 112 | 113 | 114 | 115 | jar-with-dependencies 116 | 117 | 118 | 119 | 120 | 121 | 122 | -------------------------------------------------------------------------------- /src/RedshiftJDBC41-1.1.7.1007.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/hellofiremind/jdbc-sql-rest/5576d5012ebc84eeab0a40b1e8be05b314aa1be7/src/RedshiftJDBC41-1.1.7.1007.jar -------------------------------------------------------------------------------- /src/main/java/Bootstrap.java: -------------------------------------------------------------------------------- 1 | import endpoint.SQLApplication; 2 | import lombok.SneakyThrows; 3 | import org.restlet.Component; 4 | import org.restlet.Context; 5 | import org.restlet.Server; 6 | import org.restlet.data.Protocol; 7 | 8 | /** 9 | * Created by jamescross91 on 05/11/2015. 10 | */ 11 | 12 | public class Bootstrap { 13 | @SneakyThrows 14 | public static void main(String args[]) { 15 | Component component = new Component(); 16 | component.getLogService().setLoggerName("net.asdf.WebComponent.www"); 17 | component.getDefaultHost().attach("", new SQLApplication()); 18 | 19 | // Attach the server connectors descriptors to the component 20 | component.getServers().add(startHttpServer(component, 2511)); 21 | // Start the component, which will lead to start, at the end, the real connectors. 22 | component.start(); 23 | } 24 | 25 | private static Server startHttpServer(Component component, Integer port) throws Exception { 26 | Server server = new Server(new Context(), Protocol.HTTP, port, component); 27 | 28 | return server; 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /src/main/java/config/ReadProperties.java: -------------------------------------------------------------------------------- 1 | package config; 2 | 3 | import java.io.IOException; 4 | import java.io.InputStream; 5 | import java.util.Properties; 6 | 7 | /** 8 | * Created by jamescross91 on 05/11/2015. 9 | */ 10 | 11 | public class ReadProperties { 12 | private static Properties props = null; 13 | 14 | //Load static properties from the properties file 15 | private static void load() { 16 | try { 17 | InputStream inputStream = ReadProperties.class.getResourceAsStream("/jdbc.config"); 18 | 19 | props = new Properties(); 20 | props.load(inputStream); 21 | 22 | inputStream.close(); 23 | } catch(IOException e) { 24 | e.printStackTrace(); 25 | } 26 | } 27 | 28 | //Go get the property we want 29 | public static String getProperty(String property) { 30 | if(props == null) 31 | load(); 32 | 33 | return(props.getProperty(property)); 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /src/main/java/endpoint/QueryResource.java: -------------------------------------------------------------------------------- 1 | package endpoint; 2 | 3 | import com.google.gson.Gson; 4 | import jdbc.Query; 5 | import org.json.JSONArray; 6 | import org.json.JSONException; 7 | import org.json.JSONObject; 8 | import org.restlet.ext.json.JsonRepresentation; 9 | import org.restlet.representation.Representation; 10 | import org.restlet.resource.Get; 11 | import org.restlet.resource.Post; 12 | import org.restlet.resource.ServerResource; 13 | 14 | import java.io.IOException; 15 | import java.sql.ResultSet; 16 | import java.sql.ResultSetMetaData; 17 | import java.sql.SQLException; 18 | import java.util.ArrayList; 19 | import java.util.List; 20 | 21 | /** 22 | * Created by jamescross91 on 05/11/2015. 23 | */ 24 | public class QueryResource extends ServerResource { 25 | 26 | @Get 27 | public String represent() { 28 | return "Post your SQL queries to this endpoint"; 29 | } 30 | 31 | @Post 32 | public Representation processQuery(Representation entity) throws IOException, JSONException { 33 | JSONObject json = new JsonRepresentation(entity).getJsonObject(); 34 | 35 | if(!json.has("sql")) { 36 | return errorRepresentation("SQL parameter not supplied"); 37 | } 38 | 39 | List list = Query.execute(json.getString("sql"), resultSet -> { 40 | ArrayList objList = new ArrayList(); 41 | ResultSetMetaData metaData = resultSet.getMetaData(); 42 | while (resultSet.next()) { 43 | JSONObject jsonObject = jsonForRow(resultSet, metaData); 44 | objList.add(jsonObject); 45 | } 46 | 47 | return objList; 48 | }); 49 | 50 | JSONArray array = new JSONArray(list); 51 | return new JsonRepresentation(array); 52 | } 53 | 54 | private JSONObject jsonForRow(ResultSet resultSet, ResultSetMetaData metaData) throws SQLException { 55 | JSONObject rowObject = new JSONObject(); 56 | 57 | int columnCount = metaData.getColumnCount(); 58 | for(int i = 1; i <= columnCount; i++) { 59 | try { 60 | rowObject.put(metaData.getColumnName(i), resultSet.getObject(i)); 61 | } catch (JSONException e) { 62 | e.printStackTrace(); 63 | } 64 | } 65 | 66 | return rowObject; 67 | } 68 | 69 | private JsonRepresentation errorRepresentation(String errMessage) { 70 | JSONObject object = new JSONObject(); 71 | try { 72 | object.put("message", errMessage); 73 | object.put("success", false); 74 | } catch (JSONException e) { 75 | e.printStackTrace(); 76 | } 77 | 78 | return new JsonRepresentation(object); 79 | } 80 | } 81 | -------------------------------------------------------------------------------- /src/main/java/endpoint/SQLApplication.java: -------------------------------------------------------------------------------- 1 | package endpoint; 2 | 3 | import org.restlet.Application; 4 | import org.restlet.Restlet; 5 | import org.restlet.engine.application.CorsFilter; 6 | import org.restlet.routing.Router; 7 | 8 | import java.util.HashSet; 9 | 10 | /** 11 | * Created by jamescross91 on 05/11/2015. 12 | */ 13 | public class SQLApplication extends Application { 14 | @Override 15 | public synchronized Restlet createInboundRoot() { 16 | Router router = new Router(getContext()); 17 | 18 | CorsFilter corsFilter = new CorsFilter(getContext(), router); 19 | HashSet allowedOrigins = new HashSet<>(); 20 | allowedOrigins.add("*"); 21 | corsFilter.setAllowedOrigins(allowedOrigins); 22 | 23 | //SQL query endpoint 24 | router.attach("/query", QueryResource.class); 25 | 26 | return corsFilter; 27 | } 28 | } 29 | -------------------------------------------------------------------------------- /src/main/java/jdbc/Query.java: -------------------------------------------------------------------------------- 1 | package jdbc; 2 | 3 | import config.ReadProperties; 4 | import org.apache.commons.dbcp2.BasicDataSource; 5 | import org.springframework.jdbc.core.JdbcTemplate; 6 | import org.springframework.jdbc.core.ResultSetExtractor; 7 | 8 | import javax.sql.DataSource; 9 | 10 | /** 11 | * Created by jamescross91 on 05/11/2015. 12 | */ 13 | 14 | public class Query { 15 | private static JdbcTemplate jdbcTemplate; 16 | 17 | public static T execute(String sql, ResultSetExtractor extractor) { 18 | if(jdbcTemplate == null) { 19 | jdbcTemplate = init(); 20 | } 21 | 22 | return jdbcTemplate.query(sql, extractor); 23 | } 24 | 25 | private static JdbcTemplate init() { 26 | return new JdbcTemplate(getDs()); 27 | } 28 | 29 | private static DataSource getDs(){ 30 | String url = ReadProperties.getProperty("jdbcurl"); 31 | String user = ReadProperties.getProperty("jdbcuser"); 32 | String pass = ReadProperties.getProperty("jdbcpass"); 33 | String driver = ReadProperties.getProperty("jdbcdriver"); 34 | 35 | BasicDataSource ds = new BasicDataSource(); 36 | ds.setUrl(url); 37 | ds.setUsername(user); 38 | ds.setPassword(pass); 39 | ds.setDriverClassName(driver); 40 | 41 | return ds; 42 | } 43 | } 44 | -------------------------------------------------------------------------------- /src/main/resources/jdbc.config: -------------------------------------------------------------------------------- 1 | jdbcurl=jdbc:redshift://scout-analytics.csseuvfdg9jp.eu-west-1.redshift.amazonaws.com:5439/scout 2 | jdbcuser=masteruser 3 | jdbcpass= 4 | jdbcdriver=com.amazon.redshift.jdbc41.Driver 5 | --------------------------------------------------------------------------------