clu

Clu REST API (draft)

Introduction

The github.com/tknie/clu package contains an REST server to get and modify database data. No complex infrastructure inbetween, a direct connection to the database.

There should be no difference if the database is a SQL or a NoSQL database.

A list of data recrods should be able to be inserted or updated in one call. May be as transaction or in an atomic matter.

In advance real main database functionality should be contained like:

• Create database tables
• Read, Search, Insert, Update and Delete of data records
• Search by passing database specific queries to be flexible for complex queries
• One-to-One mapping of Golang structures to database tables
• Large object support of big data
• Support creating batch jobs for database-specific tasks like SQL scripts
• Create index or other enhancements on database configuration

For details have a look at the API documentation. It can be referenced here: https://godoc.org/github.com/tknie/flynn

Example of Clu usage

Query records in database

Accept: application/json
Authorization: Base <base64>
GET http://localhost:8030/rest/view/Albums/ID,Title,published?limit=0&orderby=published:ASC

Update records in database

Accept: application/json
Authorization: Base <base64>
PUT http://localhost:8030/rest/view/Albums/ID,Title,published?limit=0&orderby=published:ASC
 {
  "Records": [
    {
      "id": "18",
      "title": "Der Ostergruss"
    },
 }

Insert records in database

Accept: application/json
Authorization: Base <base64>
PUSH http://localhost:8030/rest/view/Albums/ID,Title,published?limit=0&orderby=published:ASC

Check List