Skip to content

Latest commit

 

History

History
105 lines (70 loc) · 1.97 KB

README.md

File metadata and controls

105 lines (70 loc) · 1.97 KB
Raw

SQL Proxy

Allows connecting to any SQL database/datasource over HTTP without the need of drivers.

Getting Started

Clone the repo.

Prerequisites

Install Java, Gradle, and Docker

Installing

Step 1: Build with build script:

./build.sh

Step 2: Run the container

docker run -p 8081:8081 -t gs-springboot-sql-proxy

Development

Using IntelliJ with Gradle just run the application.

Using the Proxy

Step 1: Connect

  • using POSTMAN or CURL (or whatever http client you want)

POST to localhost:8081/connect

{
 "username": "[database user]",
 "password": "[database password]",
 "type": "[database type (sqlserver, oracle, mysql, postgres, snowflake, etc)]",
 "host": "[database host]",
 "port": "[database port]",
 "database": "[defaut database]",
 "params": {"[custom]": "[value]", "[custom2]": "[value]", ...}
}

Sql Server Example

{
 "username": "sa",
 "password": "abcd123",
 "type": "sqlserver",
 "host": "localhost",
 "port": "1433",
 "database": "",
}

Snowflake example:

curl -XPOST localhost:8081/connect -H 'Content-type: application/json' -d '{"username": "user","password": "password","type": "snowflake","host": "my.db.host","port": "1234","database": "MY_DB"}'

Step 2: Query

http://localhost:8081/query?sql=[sql statement]

Example (sql server):

http://localhost:8081/query?sql=select * from spt_monitor

Example (Snowflake):

curl -XGET "http://localhost:8081/query?sql=SELECT%20*%20FROM%20mytable;"

Deployment

Deploy the container with Docker, Kubernetes, Portainer, etc

Built With

  • Gradle
  • Docker
  • Spring Boot

Contributing

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Scott Lepper

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

https://spring.io/guides/gs/spring-boot-docker/