clone/nocodb
1
0
Fork 0
mirror of https://github.com/nocodb/nocodb.git synced 2026-04-29 22:26:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: usage

Browse Source
This commit is contained in:
oof1lab
2017-11-04 15:43:01 +00:00
parent f221da657f
commit b5dfa901fd
1 changed files with 32 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -39,15 +39,15 @@ That is it! Happy hackery!
* Generates API for **ANY** MySql database
* Serves APIs irrespective of naming conventions of primary keys, foreign keys, tables etc
* CRUD : Usual suspects
* Relations
* Support for composite primary keys
* Pagination
* Sorting
* Column filtering - Fields
* Row filtering - Where
* Group By, Having (as query params)
* Group By (as a separate route)
* Group By, Having (as a separate route)
* Aggregate functions
* Relations
* Run dynamic queries
* Upload single file
* 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/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
#### ___ (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)
```
## 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
@@ -204,6 +227,12 @@ eg: SELECT country,count(*) FROM offices GROUP BY country
```
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
```
@@ -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