Categorygithub.com/cga1123/bissy-apiquerycache
package
0.0.0-20210528075739-2d572df9eb54
Repository: https://github.com/cga1123/bissy-api.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
19
Dependents
1
Files
749 SLOC

# README

querycache - use cache, save cash

querycache lets you save a query and access them over an HTTP API, caching the results based on a per-query "lifetime" parameter. It currently supports queries against: Postgres, Snowflake, and MySQL. And addition for more go sql compatible drives is easy!

Datasources

An Datasource is the description of the connection to a specific datasource. It has 3 parameters:

  • name - a friendly name
  • type - the driver name (e.g. postgres, mysql, snowflake)
  • options - the connection string and options.

The type and options are passed directly to sql.Open as the first and second parameter.

The following endpoints are exposed:

  • GET /datasources - List endpoint, accepts per and page query parameters
  • POST /datasources - Create endpoint, accepts json object with name, type, and options keys. (all required)
  • GET /datasources/{id} - Read endpoint, returns the JSON representation of the datasource
  • PATCH /datasources/{id} - Update endpoint, accepts json object with name, type, and options keys. (all optional)
  • DELETE /datasources/{id} - Delete endpoint, deletes the datasource

Queries

A Query represents a given query to execute.

The following endpoints are exposed:

  • GET /queries - List endpoint, accepts per and page query parameters
  • POST /queries - Create endpoint, accepts json object with query, lifetime, and datasourceId keys. (all required)
  • GET /queries/{id} - Read endpoint, returns the JSON representation of the query
  • PATCH /queries/{id} - Update endpoint, accepts json object with query, lifetime, lastRefresh, and datasourceId keys. (all optional)
  • DELETE /queries/{id} - Delete endpoint, deletes the query

Examples

The following examples are using HTTPie.

Create an datasource:

http POST http://localhost:8080/querycache/datasources type=postgres name="PG Local" options="sslmode=disable dbname=querycache"
HTTP/1.1 200 OK
Content-Length: 222
Content-Type: application/json; charset=UTF-8
Date: Sun, 31 May 2020 16:45:50 GMT

{
    "createdAt": "2020-05-31T17:45:50.595626+01:00",
    "id": "b9d444a5-720b-44f9-8ebe-6f07bb02c3e0",
    "name": "PG Local",
    "options": "sslmode=disable dbname=querycache",
    "type": "postgres",
    "updatedAt": "2020-05-31T17:45:50.595627+01:00"

Create a query:

http POST http://localhost:8080/querycache/queries datasourceId=b9d444a5-720b-44f9-8ebe-6f07bb02c3e0 query="SELECT * FROM users" lifetime="8h"         (555ms)
HTTP/1.1 200 OK
Content-Length: 290
Content-Type: application/json; charset=UTF-8
Date: Sun, 31 May 2020 16:46:42 GMT

{
    "datasourceId": "b9d444a5-720b-44f9-8ebe-6f07bb02c3e0",
    "createdAt": "2020-05-31T17:46:42.176734+01:00",
    "id": "dc927e8b-8a42-4208-8139-2c1b1af1c243",
    "lastRefresh": "2020-05-31T17:46:42.176734+01:00",
    "lifetime": "8h0m0s",
    "query": "SELECT * FROM users",
    "updatedAt": "2020-05-31T17:46:42.176734+01:00"
}

Get query results:

http GET http://localhost:8080/querycache/queries/dc927e8b-8a42-4208-8139-2c1b1af1c243/result                                                       (378ms)
HTTP/1.1 200 OK
Content-Length: 70
Content-Type: text/csv
Date: Sun, 31 May 2020 16:49:29 GMT

id,username,name,email
1,christian,Christian Gregg,[email protected]

# Functions

NewCachedExecutor sets up a new CachedExecutor.
NewInMemoryCache sets up a new InMemoryCache.
NewSQLDatasourceStore retunes a new SQLDatasourceStore.
NewSQLExecutor builds a new SQLExecutor, parameters are passed to sql.Open.
NewSQLQueryStore builds a new SQLQueryStore.

# Structs

CachedExecutor implements Executor that caches query results for the given Lifetime of a Query.
Config contains everything external required to setup querycache.
CreateDatasource describes the required paramater to create a new Datasource.
CreateQuery describes the required parameter to create a new Query.
Datasource describes a database that Queries may be related to and executed against.
InMemoryCache is an in-memory implementation of QueryCache.
Query describes an SQL query on a given datasource that should be cached for a given Lifetime value.
RedisCache is a redis-backed implementation of QueryCache.
SQLDatasourceStore describes an SQL implementation of DatasourceStore.
SQLExecutor implements Executor against an *sql.DB.
SQLQueryStore defines an SQL implementation of a QueryStore.
TestExecutor implements an Executor that echoes the passed query.
UpdateDatasource describes the paramater which may be updated on a Datasource.
UpdateQuery describes the paramater which may be updated on a Query.

# Interfaces

DatasourceStore describes a generic Store for Datasources.
Executor defines the interface to execute a query.
QueryCache defines the interface for a cache of query results.
QueryStore describes a generic Store for Queries.

# Type aliases

Duration is an alias to time.Duration to allow for defining JSON marshalling and unmarshalling.