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

docs: revise gql page structure

Browse Source 
Signed-off-by: Wing-Kam Wong <wingkwong.code@gmail.com>
This commit is contained in:
Wing-Kam Wong
2021-07-19 22:52:42 +08:00
parent 56d74d776f
commit 9a121c1a51
1 changed files with 22 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
packages/noco-docs/content/en/developer-resources/graphql-apis.md
View File

@@ -2,31 +2,31 @@
title: 'GraphQL APIs'
position: 2
category: 'Developer Resources'
fullscreen: true
menuTitle: 'GraphQL APIs'
---
# Features
* APIs
* Generates GraphQL APIs for **ANY** MySql, Postgres, MSSQL, Sqlite database :fire:
* Serves GraphQL queries irrespective of naming conventions of primary keys, foreign keys, tables etc :fire:
* Support for composite primary keys :fire:
* Usual suspects : CRUD, List, FindOne, Count, Exists, Distinct
* Pagination
* Sorting
* Column filtering - Fields :fire:
* Row filtering - Where :fire:
* Bulk insert, Bulk delete, Bulk read :fire:
* Relations - automatically detected
* Aggregate functions
* More
* Upload single file
* Upload multiple files
* Download file
## Features
* Generates GraphQL APIs for **ANY** MySql, Postgres, MSSQL, Sqlite database :fire:
* Serves GraphQL queries irrespective of naming conventions of primary keys, foreign keys, tables etc :fire:
* Support for composite primary keys :fire:
* Usual suspects : CRUD, List, FindOne, Count, Exists, Distinct
* Pagination
* Sorting
* Column filtering - Fields :fire:
* Row filtering - Where :fire:
* Bulk insert, Bulk delete, Bulk read :fire:
* Relations - automatically detected
* Aggregate functions
* More
* Upload single file
* Upload multiple files
* Download file
* Authentication
* Access Control
# GraphQL API Overview
## API Overview
### Query
@@ -54,7 +54,7 @@ menuTitle: 'GraphQL APIs'
| [TableName**UpdateBulk**](#tablenamebulk) | data: [TableNameInput] | [Int] | Bulk row update |
| [TableName**DeleteBulk**](#tablenamedeletebulk) | data: [TableNameInput] | [Int] | Bulk row delete |
## Query Arguments
### Query params
| **Param** | **Description** | **Default value** |**Example Value**|
|---|---|---|---|
@@ -86,7 +86,6 @@ like - 'like' - (colName,like,%name)
PaymentList(where:"(checkNumber,eq,JM555205)~or((amount,gt,200)~and(amount,lt,2000))")
```
#### Logical operators
```
~or - 'or'
@@ -94,6 +93,8 @@ PaymentList(where:"(checkNumber,eq,JM555205)~or((amount,gt,200)~and(amount,lt,20
~not - 'not'
```
## Examples
### TableNameList
<code-group>
@@ -243,13 +244,6 @@ CountryList {
</code-group>
#### List + where + sort + offset
<code-group>
<code-block label="Request" active>