marioidival/goga

A fully RESTful API from any existing PostgreSQL database written in Rust

goga

A fully RESTful API from any existing PostgreSQL database written in Rust

Inspiration

This project is highly inspired on pREST. Then 4 years later, highly inspired from a conversation. Now it’s out of the grave

TODO

• HTTP GET

  • Get all DATABASES
  • Get all SCHEMAS
  • Get all TABLES
  • SELECT /db/sch/tbl?_select=column
    • select with all columns *
    • select with specific column _select=column1,column2
  • WHERE /db/sch/tbl?column=value
    • filter with operators column=$gt.100
    • filter with json/jsonb columns
  • COUNT /db/sch/tbl?_count=column
    • count with all columns *
    • count with specific column _count=column1,column2
  • ORDER BY /db/sch/tbl?_order=column
    • order by with asc _order=column default
    • order by with desc _order=-column
    • order by with multiple orders _order=-column1,column2
  • GROUP BY /db/sch/tbl?_select=column1,column2&_groupby=column1
    • group by chunk code with columns
    • group by with group functions support SUM, AVG, MAX, MIN
    • group by with having clause _groupby=column1->>having:sum:column_name:$gt:500

goga's Issues

Matches if field is not null

MAX - return the maximum value.

Matches always cover the entire string

Like operation

Matches if field is not true

Matches values that are less than

SUM - return the sum of all or distinct values

Matches non of the values specified in an array

Matches values that are greater than or equal

Matches all values that are not equal

Basic query operations

Create basic query operations

• #28
• #29
• #30
• #31
• #32
• #33
• #34
• #35
• #36
• #37
• #38
• #39
• #40
• #41
• #42

Derive macro

How to use this macro correctly?
Where use this macro?
When use this macro?

Friday, on Globo Reporter.

PATCH /:database/:schema/:table

GET /:database/:schema/:table

GET /tables

Change &str to enum

http://deterministic.space/elegant-apis-in-rust.html#what-makes-an-api-elegant
https://doc.rust-lang.org/stable/book/second-edition/ch06-01-defining-an-enum.html

Coming from dynamically typed languages, you might be tempted to use strings with specific 
values in various places.

For example: You want a function to print some input text in a color, so you use a parameter
 color of type &str. That also means you expect your users to write one of the names from a
limited number of color names (like ["red", "green", "blue", "light golden rod yellow"]).

This is not what you should do in Rust! If you know all possible variants beforehand, use an enum. 
This way, you don’t need to parse/pattern match the string – and deal with possible errors – but can 
be sure that a user of your API can only ever supply valid inputs.```

Aggregate functions

Aggregate functions perform a calculation on a set of rows and return a single row

• #44
• #45
• #46
• #47
• #48

Documentation

Write Wiki / README with:

• Development set up
• Endpoints
• Using with docker
• Using standalone

Matches values that are less than or equal

Upload to Docker hub

COUNT - return the number of values.

AVG - return the average value.

Matches values that are equal

Configure Host / Port of Goga

Matches case-insensitive always cover the entire string

ILike operation

Change rocket to actix

Docker set up

• #49
• #50

Matches values that are greater than

DELETE /:database/:schema/:table

web expose

hyper, iron, rocket, others:

http://www.arewewebyet.org/

Matches if field is not false

GET /databases

use launchbadge/sqlx

We need to use https://github.com/launchbadge/sqlx instead of actual connection lib.

Matches if field is false

restructuring project

• #10
• #11
• #12
• #13
• #14
• #15
• #16
• #27
• #43

PUT /:database/:schema/:table

set up to postgresql only

GET /schemas

Create a dockerfile

basic configuration

As a user, I want to edit the configuration file of Goga to:

• #51
• #52
• #53

Matches any of the values specified in an array

Matches if field is null

Need create a module of Errors

All application functions should follow Error Handling of Rust

http://stevedonovan.github.io/rust-gentle-intro/6-error-handling.html

Configure postgresql information (PG HOSH, PG USER, PG PASSWORD, PG DB)

GET /:database/:schema

POST /:database/:schema/:table

MIN - return the minimum value.

Regex instead split

https://doc.rust-lang.org/regex/regex/index.html

Consider src/bin/goga.rs instead of src/main.rs

I know that having both src/lib.rs and src/main.rs is suggested in the second edition of the Rust book, but for a crate that already has src/lib.rs, it's more typical to have src/bin/goga.rs instead.

Some links:

• Rust package with both a library and a binary?

• Publishing a crate containing both lib.rs and main.rs files

update to rust edition 2021

rewrite basic endpoints

Rewrite endpoints:

• #18
• #19
• #20
• #21
• #22
• #23
• #24
• #25
• #26