|
|
@ -39,15 +39,15 @@ That is it! Happy hackery! |
|
|
|
* Generates API for **ANY** MySql database |
|
|
|
* Generates API for **ANY** MySql database |
|
|
|
* Serves APIs irrespective of naming conventions of primary keys, foreign keys, tables etc |
|
|
|
* Serves APIs irrespective of naming conventions of primary keys, foreign keys, tables etc |
|
|
|
* CRUD : Usual suspects |
|
|
|
* CRUD : Usual suspects |
|
|
|
|
|
|
|
* Relations |
|
|
|
* Support for composite primary keys |
|
|
|
* Support for composite primary keys |
|
|
|
* Pagination |
|
|
|
* Pagination |
|
|
|
* Sorting |
|
|
|
* Sorting |
|
|
|
* Column filtering - Fields |
|
|
|
* Column filtering - Fields |
|
|
|
* Row filtering - Where |
|
|
|
* Row filtering - Where |
|
|
|
* Group By, Having (as query params) |
|
|
|
* Group By, Having (as query params) |
|
|
|
* Group By (as a separate route) |
|
|
|
* Group By, Having (as a separate route) |
|
|
|
* Aggregate functions |
|
|
|
* Aggregate functions |
|
|
|
* Relations |
|
|
|
|
|
|
|
* Run dynamic queries |
|
|
|
* Run dynamic queries |
|
|
|
* Upload single file |
|
|
|
* Upload single file |
|
|
|
* Upload multiple files |
|
|
|
* Upload multiple files |
|
|
@ -86,6 +86,15 @@ Root URL (localhost:3000/) returns all REST API urls for each table in schema. |
|
|
|
* GET /api/tableName/describe |
|
|
|
* GET /api/tableName/describe |
|
|
|
* GET /api/tables |
|
|
|
* GET /api/tables |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Relational Tables |
|
|
|
|
|
|
|
xmysql identifies foreign key relations automatically and provides GET api. |
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
/api/blogs/103/comments |
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
eg: blogs is parent table and comments is child table. API invocation will result in all payments with blog primary key 103. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Support for composite primary keys |
|
|
|
## Support for composite primary keys |
|
|
|
|
|
|
|
|
|
|
|
#### ___ (three underscores) |
|
|
|
#### ___ (three underscores) |
|
|
@ -192,7 +201,21 @@ eg: filter of rows using _where is available for relational route URLs too. |
|
|
|
/api/offices/1/employees?_where=(jobTitle,eq,Sales%20Rep) |
|
|
|
/api/offices/1/employees?_where=(jobTitle,eq,Sales%20Rep) |
|
|
|
``` |
|
|
|
``` |
|
|
|
|
|
|
|
|
|
|
|
## Group By |
|
|
|
|
|
|
|
|
|
|
|
## Group By, Having (as query params) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
/api/offices?_groupby=country |
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
eg: SELECT country,count(*) FROM offices GROUP BY country |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
/api/offices?_groupby=country&_having=(_count,gt,1) |
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
eg: SELECT country,count(1) as _count FROM offices GROUP BY country having _count > 1 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Group By, Having (as a seperate route) |
|
|
|
|
|
|
|
|
|
|
|
``` |
|
|
|
``` |
|
|
|
/api/offices/groupby?_fields=country |
|
|
|
/api/offices/groupby?_fields=country |
|
|
@ -204,6 +227,12 @@ eg: SELECT country,count(*) FROM offices GROUP BY country |
|
|
|
``` |
|
|
|
``` |
|
|
|
eg: SELECT country,city,count(*) FROM offices GROUP BY country,city |
|
|
|
eg: SELECT country,city,count(*) FROM offices GROUP BY country,city |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
/api/offices/groupby?_fields=country,city&_having=(_count,gt,1) |
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
eg: SELECT country,city,count(*) as _count FROM offices GROUP BY country,city having _count > 1 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Group By, Order By |
|
|
|
## Group By, Order By |
|
|
|
|
|
|
|
|
|
|
|
``` |
|
|
|
``` |
|
|
@ -268,12 +297,6 @@ eg: retrieves numeric aggregate can be done for multiple columns too |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Relational Tables |
|
|
|
|
|
|
|
xmysql identifies foreign key relations automatically and provides GET api. |
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
/api/customers/103/payments |
|
|
|
|
|
|
|
``` |
|
|
|
|
|
|
|
eg: Customers is parent table and payments is child table. API invocation will result in all payments with customer 103. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Run dynamic queries |
|
|
|
## Run dynamic queries |
|
|
|