Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chop-dbhi/sql-agent
HTTP interface for executing ad-hoc SQL queries.
https://github.com/chop-dbhi/sql-agent
database microservice mysql oracle postgresql sql sql-agent sqlite
Last synced: 2 months ago
JSON representation
HTTP interface for executing ad-hoc SQL queries.
- Host: GitHub
- URL: https://github.com/chop-dbhi/sql-agent
- Owner: chop-dbhi
- License: bsd-2-clause
- Created: 2015-08-12T13:05:30.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-05T15:01:34.000Z (over 1 year ago)
- Last Synced: 2024-09-28T15:41:39.317Z (2 months ago)
- Topics: database, microservice, mysql, oracle, postgresql, sql, sql-agent, sqlite
- Language: Go
- Homepage:
- Size: 64.9 MB
- Stars: 93
- Watchers: 15
- Forks: 23
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list-microservice - sql-agent - hoc SQL queries. (database)
README
# SQL Agent
[](https://godoc.org/github.com/chop-dbhi/sql-agent)
SQL Agent is an HTTP service for executing ad-hoc queries on remote databases. The motivation for this service is to be part of a data monitoring process or system in which the query results will be evaluated against previous snapshots of the results.
The supported databases are:
- PostgreSQL
- MySQL, MariaDB
- Oracle
- Microsoft SQL Server
- SQLite
- Snowflake
- Presto
In addition to the service, this repo also defines a `sqlagent` package for using in other Go programs.
## Install
At the moment, it is recommended to run the service using Docker because there are no pre-built binaries yet.
```
docker run -d -p 5000:5000 dbhi/sql-agent
```
## Usage
To execute a query, simply send a POST request with a payload containing the driver name of the database, connection information to with, and the SQL statement with optional parameters. The service will connect to the database, execute the query and return the results as a JSON-encoded array of maps (see [details](#Details) below).
**Request**
`POST`
Headers:
- `'Accept'` - required
- `application/json`
- `application/x-ldjson`
- `text/csv`
```json
{
"driver": "postgres",
"connection": {
"host": "localhost",
"user": "postgres"
},
"sql": "SELECT name FROM users WHERE zipcode = :zipcode",
"params": {
"zipcode": 18019
}
}
```
**Response**
```json
[
{
"name": "George"
},
...
]
```
### Connection Options
The core option names are standardized for ease of use.
- `host` - The host of the database.
- `port` - The port of the database.
- `user` - The user to connect with.
- `password` - The password to authenticate with.
- `database` - The name of the database to connect to. For SQLite, this will be a filesystem path. For Oracle, this would be the SID.
Other options that are supplied are passed query options if they are known, otherwise they are they ignored.
Alternatively, the `dsn` parameter can be specified which will used directly when [opening a connection](https://golang.org/pkg/database/sql/#Open).
### Ping Connection
To validate the connection, send a POST with the `?ping` query parameter present and it will test the connection only.
## Details
- Only `SELECT` statements are supported.
- Statements using parameters must use the `:param` syntax and must have a corresponding entry in the `params` map.
### Constraints
- Columns must be uniquely named, otherwise the conversion into a map will include only one of the values.
## Library
The SQL Agent library does not include any drivers by default. To add them include them like so:
```go
package main
import (
_ "github.com/alexbrainman/odbc"
_ "github.com/denisenkom/go-mssqldb"
_ "github.com/go-sql-driver/mysql"
_ "github.com/lib/pq"
_ "github.com/mattn/go-oci8"
_ "github.com/mattn/go-sqlite3"
)
func main() {
//...
}
```
## Help
### Install Oracle client libraries
#### General
In order to install the [go-oci8](https://github.com/mattn/go-oci8) driver, you must install Oracle's client libraries.
Download the **instantclient-basic** and **instantclient-sdk** package from [Oracle's website](http://www.oracle.com/technetwork/database/features/instant-client/index-097480.html) and uncompress to the same directory. Make sure that you selected the platform and architecture.
The installations instructions are listed at the bottom of the page with the download links.
Install `pkg-config`.
Create `oci8.pc` file in your `$PKG_CONFIG_PATH` (such as `/usr/local/lib/pkgconfig`) and add the below contents:
```
prefix=/usr/local/lib/instantclient_11_2
libdir=${prefix}
includedir=${prefix}/sdk/include/
Name: OCI
Description: Oracle database engine
Version: 11.2
Libs: -L${libdir} -lclntsh
Libs.private:
Cflags: -I${includedir}
```
Change the `prefix` to path to location of the Oracle libraries.
#### OS X specific Help
Assuming the `instantclient_11_2` folder is located in `/usr/loca/lib`, link the following files:
```bash
ln /usr/local/lib/instantclient_11_2/libclntsh.dylib /usr/local/lib/libclntsh.dylib
ln /usr/local/lib/instantclient_11_2/libocci.dylib.* /usr/local/lib/libocci.dylib.*
ln /usr/local/lib/instantclient_11_2/libociei.dylib /usr/local/lib/libociei.dylib
ln /usr/local/lib/instantclient_11_2/libnnz11.dylib /usr/local/lib/libnnz11.dylib
```
Install `pkg-config` via [Homebrew](http://brew.sh/), `brew install pkg-config`.