mirror of https://github.com/nocodb/nocodb
Pranav C
3 years ago
9 changed files with 1790 additions and 355 deletions
@ -0,0 +1,33 @@
|
||||
<template> |
||||
<div> |
||||
<iframe type="text/html" width="100%" style="height:100%" |
||||
:src="`https://www.youtube.com/embed/${id}`" |
||||
frameborder="0" allowfullscreen></iframe> |
||||
</div> |
||||
</template> |
||||
|
||||
<script> |
||||
export default { |
||||
name: "youtube", |
||||
props: { |
||||
id: String |
||||
} |
||||
} |
||||
</script> |
||||
|
||||
<style scoped> |
||||
div { |
||||
background-color: red; |
||||
width: 100%; |
||||
padding-top: min(500px,56%); |
||||
position: relative; |
||||
} |
||||
|
||||
iframe { |
||||
position: absolute; |
||||
top: 0; |
||||
left: 0; |
||||
bottom: 0; |
||||
right: 0; |
||||
} |
||||
</style> |
||||
@ -0,0 +1,841 @@
|
||||
--- |
||||
title: 'GraphQL APIs' |
||||
position: 2 |
||||
category: 'API' |
||||
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 |
||||
* Authentication |
||||
* Access Control |
||||
|
||||
|
||||
# GraphQL API Overview |
||||
|
||||
### Query |
||||
|
||||
| **Resolver** | **Arguments** | **Returns** | **Description** | |
||||
|---|---|---|---| |
||||
| [TableName**List**](#tablenamelist) | where: String, limit: Int, offset: Int, sort: String | [TableName] | List of table rows | |
||||
| [TableName**Read**](#tablenameread) | id:String | TableName | Get row by primary key | |
||||
| [TableName**Exists**](#tablenameexists) | id: String | Boolean | Check row exists by primary key | |
||||
| [TableName**FindOne**](#tablenamefindone) | where: String | TableName | Find row by where conditions | |
||||
| [TableName**Count**](#tablenamecount) | where: String | Int | Get rows count | |
||||
| [TableName**Distinct**](#tablenamedistinct) | columnName: String, where: String, limit: Int, offset: Int, sort: String | [TableName] | Get distinct rows based on provided column names | |
||||
| [TableName**GroupBy**](#tablenamegroupby) | fields: String, having: String, limit: Int, offset: Int, sort: String | [TableNameGroupBy] | Group rows by provided columns | |
||||
| [TableName**Aggregate**](#tablenameaggregate) | columnName: String!, having: String, limit: Int, offset: Int, sort: String, func: String! | [TableNameAggregate] | Do aggregation based on provided column name aggregate function | |
||||
| [TableName**Distribution**](#tablenamedistribution) | min: Int, max: Int, step: Int, steps: String, columnName: String! | [distribution] | Get distributed list | |
||||
|
||||
|
||||
### Mutations |
||||
|
||||
| **Resolver** | **Arguments** | **Returns** | **Description** | |
||||
|---|---|---|---| |
||||
| [TableName**Create**](#tablenamecreate) | data:TableNameInput | TableName | Insert row into table | |
||||
| [TableName**Update**](#tablenameupdate) | id:String,data:TableNameInput | TableName | Update table row using primary key | |
||||
| [TableName**Delete**](#tablenamedelete) | id:String | TableName | Delete table row using primary id | |
||||
| [TableName**CreateBulk**](#tabelenamecreatebulk) | data: [TableNameInput] | [Int] | Bulk row insert | |
||||
| [TableName**UpdateBulk**](#tablenamebulk) | data: [TableNameInput] | [Int] | Bulk row update | |
||||
| [TableName**DeleteBulk**](#tablenamedeletebulk) | data: [TableNameInput] | [Int] | Bulk row delete | |
||||
|
||||
## Query Arguments |
||||
|
||||
| **Param** | **Description** | **Default value** |**Example Value**| |
||||
|---|---|---|---| |
||||
| where | Logical Expression | | `(colName,eq,colValue)~or(colName2,gt,colValue2)` <br />[Usage: Comparison operators](#comparison-operators) <br />[Usage: Logical operators](#logical-operators) | |
||||
| limit | Number of rows to get(SQL limit value) | 10 | 20 | |
||||
| offset | Offset for pagination(SQL offset value) | 0 | 20 | |
||||
| sort | Sort column name, where use `-` as prefix for descending sort | | column_name | |
||||
| fields | Required column names in result | * | column_name_1,column_name_2 | |
||||
|
||||
#### Comparison operators |
||||
|
||||
``` |
||||
eq - '=' - (colName,eq,colValue) |
||||
not - '!=' - (colName,ne,colValue) |
||||
gt - '>' - (colName,gt,colValue) |
||||
ge - '>=' - (colName,ge,colValue) |
||||
lt - '<' - (colName,lt,colValue) |
||||
le - '<=' - (colName,le,colValue) |
||||
is - 'is' - (colName,is,true/false/null) |
||||
isnot - 'is not' - (colName,isnot,true/false/null) |
||||
in - 'in' - (colName,in,val1,val2,val3,val4) |
||||
btw - 'between' - (colName,btw,val1,val2) |
||||
nbtw - 'not between'- (colName,nbtw,val1,val2) |
||||
like - 'like' - (colName,like,%name) |
||||
``` |
||||
|
||||
#### Example use of comparison operators - complex example |
||||
``` |
||||
PaymentList(where:"(checkNumber,eq,JM555205)~or((amount,gt,200)~and(amount,lt,2000))") |
||||
``` |
||||
|
||||
|
||||
#### Logical operators |
||||
``` |
||||
~or - 'or' |
||||
~and - 'and' |
||||
~not - 'not' |
||||
``` |
||||
|
||||
### TableNameList |
||||
#### Request |
||||
``` |
||||
CountryList { |
||||
country_id |
||||
country |
||||
last_update |
||||
} |
||||
``` |
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryList": [ |
||||
{ |
||||
"country_id": 1, |
||||
"country": "Afghanistan", |
||||
"last_update": "1139978640000", |
||||
"CityCount": 1 |
||||
}, |
||||
{ |
||||
"country_id": 2, |
||||
"country": "Algeria", |
||||
"last_update": "1139978640000", |
||||
"CityCount": 3 |
||||
}, |
||||
{ |
||||
"country_id": 3, |
||||
"country": "American Samoa", |
||||
"last_update": "1139978640000", |
||||
"CityCount": 1 |
||||
} |
||||
} |
||||
``` |
||||
|
||||
|
||||
|
||||
#### List + where |
||||
|
||||
##### Request |
||||
``` |
||||
{ |
||||
CountryList(where:"(country,like,United%)") { |
||||
country_id |
||||
country |
||||
last_update |
||||
CityCount |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[Usage : comparison operators](#comparison-operators) |
||||
|
||||
##### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryList": [ |
||||
{ |
||||
"country_id": 101, |
||||
"country": "United Arab Emirates", |
||||
"last_update": "1139958840000", |
||||
"CityCount": 3 |
||||
}, |
||||
{ |
||||
"country_id": 102, |
||||
"country": "United Kingdom", |
||||
"last_update": "1139958840000", |
||||
"CityCount": 8 |
||||
}, |
||||
{ |
||||
"country_id": 103, |
||||
"country": "United States", |
||||
"last_update": "1139958840000", |
||||
"CityCount": 35 |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### List + where + sort |
||||
|
||||
##### Request |
||||
``` |
||||
{ |
||||
CountryList(where:"(country,like,United%)",sort:"-country") { |
||||
country_id |
||||
country |
||||
last_update |
||||
CityCount |
||||
} |
||||
} |
||||
``` |
||||
|
||||
##### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryList": [ |
||||
{ |
||||
"country_id": 103, |
||||
"country": "United States", |
||||
"last_update": "1139958840000", |
||||
"CityCount": 35 |
||||
}, |
||||
{ |
||||
"country_id": 102, |
||||
"country": "United Kingdom", |
||||
"last_update": "1139958840000", |
||||
"CityCount": 8 |
||||
}, |
||||
{ |
||||
"country_id": 101, |
||||
"country": "United Arab Emirates", |
||||
"last_update": "1139958840000", |
||||
"CityCount": 3 |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
|
||||
|
||||
|
||||
# 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 |
||||
* Authentication |
||||
* Access Control |
||||
|
||||
|
||||
# GraphQL API Overview |
||||
|
||||
### Query |
||||
|
||||
| **Resolver** | **Arguments** | **Returns** | **Description** | |
||||
|---|---|---|---| |
||||
| [TableName**List**](#tablenamelist) | where: String, limit: Int, offset: Int, sort: String | [TableName] | List of table rows | |
||||
| [TableName**Read**](#tablenameread) | id:String | TableName | Get row by primary key | |
||||
| [TableName**Exists**](#tablenameexists) | id: String | Boolean | Check row exists by primary key | |
||||
| [TableName**FindOne**](#tablenamefindone) | where: String | TableName | Find row by where conditions | |
||||
| [TableName**Count**](#tablenamecount) | where: String | Int | Get rows count | |
||||
| [TableName**Distinct**](#tablenamedistinct) | columnName: String, where: String, limit: Int, offset: Int, sort: String | [TableName] | Get distinct rows based on provided column names | |
||||
| [TableName**GroupBy**](#tablenamegroupby) | fields: String, having: String, limit: Int, offset: Int, sort: String | [TableNameGroupBy] | Group rows by provided columns | |
||||
| [TableName**Aggregate**](#tablenameaggregate) | columnName: String!, having: String, limit: Int, offset: Int, sort: String, func: String! | [TableNameAggregate] | Do aggregation based on provided column name aggregate function | |
||||
| [TableName**Distribution**](#tablenamedistribution) | min: Int, max: Int, step: Int, steps: String, columnName: String! | [distribution] | Get distributed list | |
||||
|
||||
|
||||
### Mutations |
||||
|
||||
| **Resolver** | **Arguments** | **Returns** | **Description** | |
||||
|---|---|---|---| |
||||
| [TableName**Create**](#tablenamecreate) | data:TableNameInput | TableName | Insert row into table | |
||||
| [TableName**Update**](#tablenameupdate) | id:String,data:TableNameInput | TableName | Update table row using primary key | |
||||
| [TableName**Delete**](#tablenamedelete) | id:String | TableName | Delete table row using primary id | |
||||
| [TableName**CreateBulk**](#tabelenamecreatebulk) | data: [TableNameInput] | [Int] | Bulk row insert | |
||||
| [TableName**UpdateBulk**](#tablenamebulk) | data: [TableNameInput] | [Int] | Bulk row update | |
||||
| [TableName**DeleteBulk**](#tablenamedeletebulk) | data: [TableNameInput] | [Int] | Bulk row delete | |
||||
|
||||
## Query Arguments |
||||
|
||||
| **Param** | **Description** | **Default value** |**Example Value**| |
||||
|---|---|---|---| |
||||
| where | Logical Expression | | `(colName,eq,colValue)~or(colName2,gt,colValue2)` <br />[Usage: Comparison operators](#comparison-operators) <br />[Usage: Logical operators](#logical-operators) | |
||||
| limit | Number of rows to get(SQL limit value) | 10 | 20 | |
||||
| offset | Offset for pagination(SQL offset value) | 0 | 20 | |
||||
| sort | Sort column name, where use `-` as prefix for descending sort | | column_name | |
||||
| fields | Required column names in result | * | column_name_1,column_name_2 | |
||||
|
||||
#### Comparison operators |
||||
|
||||
``` |
||||
eq - '=' - (colName,eq,colValue) |
||||
not - '!=' - (colName,ne,colValue) |
||||
gt - '>' - (colName,gt,colValue) |
||||
ge - '>=' - (colName,ge,colValue) |
||||
lt - '<' - (colName,lt,colValue) |
||||
le - '<=' - (colName,le,colValue) |
||||
is - 'is' - (colName,is,true/false/null) |
||||
isnot - 'is not' - (colName,isnot,true/false/null) |
||||
in - 'in' - (colName,in,val1,val2,val3,val4) |
||||
btw - 'between' - (colName,btw,val1,val2) |
||||
nbtw - 'not between'- (colName,nbtw,val1,val2) |
||||
like - 'like' - (colName,like,%name) |
||||
``` |
||||
|
||||
#### Example use of comparison operators - complex example |
||||
``` |
||||
PaymentList(where:"(checkNumber,eq,JM555205)~or((amount,gt,200)~and(amount,lt,2000))") |
||||
``` |
||||
|
||||
|
||||
#### Logical operators |
||||
``` |
||||
~or - 'or' |
||||
~and - 'and' |
||||
~not - 'not' |
||||
``` |
||||
|
||||
### TableNameList |
||||
#### Request |
||||
``` |
||||
CountryList { |
||||
country_id |
||||
country |
||||
last_update |
||||
} |
||||
``` |
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryList": [ |
||||
{ |
||||
"country_id": 1, |
||||
"country": "Afghanistan", |
||||
"last_update": "1139978640000", |
||||
"CityCount": 1 |
||||
}, |
||||
{ |
||||
"country_id": 2, |
||||
"country": "Algeria", |
||||
"last_update": "1139978640000", |
||||
"CityCount": 3 |
||||
}, |
||||
{ |
||||
"country_id": 3, |
||||
"country": "American Samoa", |
||||
"last_update": "1139978640000", |
||||
"CityCount": 1 |
||||
} |
||||
} |
||||
``` |
||||
|
||||
|
||||
|
||||
#### List + where |
||||
|
||||
##### Request |
||||
``` |
||||
{ |
||||
CountryList(where:"(country,like,United%)") { |
||||
country_id |
||||
country |
||||
last_update |
||||
CityCount |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[Usage : comparison operators](#comparison-operators) |
||||
|
||||
##### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryList": [ |
||||
{ |
||||
"country_id": 101, |
||||
"country": "United Arab Emirates", |
||||
"last_update": "1139958840000", |
||||
"CityCount": 3 |
||||
}, |
||||
{ |
||||
"country_id": 102, |
||||
"country": "United Kingdom", |
||||
"last_update": "1139958840000", |
||||
"CityCount": 8 |
||||
}, |
||||
{ |
||||
"country_id": 103, |
||||
"country": "United States", |
||||
"last_update": "1139958840000", |
||||
"CityCount": 35 |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### List + where + sort + offset |
||||
|
||||
##### Request |
||||
``` |
||||
{ |
||||
CountryList(where:"(country,like,United%)",sort:"-country",offset:1) { |
||||
country_id |
||||
country |
||||
last_update |
||||
CityCount |
||||
} |
||||
} |
||||
``` |
||||
|
||||
##### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryList": [ |
||||
{ |
||||
"country_id": 102, |
||||
"country": "United Kingdom", |
||||
"last_update": "1139958840000", |
||||
"CityCount": 8 |
||||
}, |
||||
{ |
||||
"country_id": 101, |
||||
"country": "United Arab Emirates", |
||||
"last_update": "1139958840000", |
||||
"CityCount": 3 |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
#### List + limit |
||||
|
||||
##### Request |
||||
``` |
||||
{ |
||||
CountryList(limit:6) { |
||||
country |
||||
} |
||||
} |
||||
``` |
||||
|
||||
##### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryList": [ |
||||
{ |
||||
"country": "Afghanistan" |
||||
}, |
||||
{ |
||||
"country": "Algeria" |
||||
}, |
||||
{ |
||||
"country": "American Samoa" |
||||
}, |
||||
{ |
||||
"country": "Angola" |
||||
}, |
||||
{ |
||||
"country": "Anguilla" |
||||
}, |
||||
{ |
||||
"country": "Argentina" |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[:arrow_heading_up:](#query) |
||||
|
||||
### TableNameRead |
||||
#### Request |
||||
``` |
||||
CountryRead(id:"1") { |
||||
country_id |
||||
country |
||||
last_update |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
"data": { |
||||
"CountryRead": { |
||||
"country_id": 1, |
||||
"country": "Afghanistan", |
||||
"last_update": "1139978640000", |
||||
"CityCount": 1 |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#query) |
||||
|
||||
### TableNameExists |
||||
#### Request |
||||
``` |
||||
CountryExists(id:"1") |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
"data": { |
||||
"CountryExists": true |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#query) |
||||
|
||||
### TableNameFindOne |
||||
#### Request |
||||
``` |
||||
CountryFindOne(where:"(country_id,eq,1)") { |
||||
country_id |
||||
country |
||||
last_update |
||||
CityCount |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
"data": { |
||||
"CountryFindOne": { |
||||
"country_id": 1, |
||||
"country": "Afghanistan", |
||||
"last_update": "1139978640000", |
||||
"CityCount": 1 |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#query) |
||||
|
||||
### TableNameCount |
||||
#### Request |
||||
``` |
||||
CountryCount |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
"data": { |
||||
"CountryCount": 109 |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#query) |
||||
|
||||
### TableNameDistinct |
||||
#### Request |
||||
``` |
||||
{ |
||||
CountryDistinct(columnName:"last_update",limit:3) { |
||||
last_update |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryDistinct": [ |
||||
{ |
||||
"last_update": "1139958840000" |
||||
}, |
||||
{ |
||||
"last_update": "1578323893000" |
||||
}, |
||||
{ |
||||
"last_update": "1578321201000" |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#query) |
||||
|
||||
### TableNameGroupBy |
||||
#### Request |
||||
``` |
||||
{ |
||||
CountryGroupBy(fields:"last_update",limit:1) { |
||||
country_id |
||||
country |
||||
last_update |
||||
count |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryGroupBy": [ |
||||
{ |
||||
"country_id": null, |
||||
"country": null, |
||||
"last_update": "1139958840000", |
||||
"count": 109 |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#query) |
||||
|
||||
### TableNameAggregate |
||||
#### Request |
||||
``` |
||||
{ |
||||
PaymentAggregate(columnName:"amount",func:"min,max,avg,count") { |
||||
count |
||||
avg |
||||
min |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"PaymentAggregate": [ |
||||
{ |
||||
"count": 16048, |
||||
"avg": 4.200743, |
||||
"min": 0 |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#query) |
||||
|
||||
### TableNameDistribution |
||||
#### Request |
||||
``` |
||||
{ |
||||
PaymentDistribution (columnName:"amount"){ |
||||
range |
||||
count |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"PaymentDistribution": [ |
||||
{ |
||||
"range": "0-4", |
||||
"count": 8302 |
||||
}, |
||||
{ |
||||
"range": "5-8", |
||||
"count": 3100 |
||||
}, |
||||
{ |
||||
"range": "9-11.99", |
||||
"count": 371 |
||||
} |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#mutations) |
||||
|
||||
### TableNameCreate |
||||
#### Request |
||||
``` |
||||
mutation { |
||||
CountryCreate(data: {country: "test"}) { |
||||
country_id |
||||
country |
||||
last_update |
||||
CityCount |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryCreate": { |
||||
"country_id": 10264, |
||||
"country": "test", |
||||
"last_update": null, |
||||
"CityCount": 0 |
||||
} |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#mutations) |
||||
|
||||
### TableNameUpdate |
||||
#### Request |
||||
``` |
||||
mutation { |
||||
CountryUpdate(data: {country: "test_new"}, id: "10264") { |
||||
country_id |
||||
country |
||||
last_update |
||||
CityCount |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryUpdate": { |
||||
"country_id": null, |
||||
"country": null, |
||||
"last_update": null, |
||||
"CityCount": null |
||||
} |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#mutations) |
||||
|
||||
### TableNameDelete |
||||
#### Request |
||||
``` |
||||
mutation { |
||||
CountryDelete(id: "10264") { |
||||
country_id |
||||
country |
||||
last_update |
||||
CityCount |
||||
} |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryDelete": { |
||||
"country_id": null, |
||||
"country": null, |
||||
"last_update": null, |
||||
"CityCount": null |
||||
} |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#mutations) |
||||
|
||||
### TableNameCreateBulk |
||||
#### Request |
||||
``` |
||||
mutation { |
||||
CountryCreateBulk(data:[{country:"test 2"},{country:"test 3"}]) |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryCreateBulk": [ |
||||
10265 |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#mutations) |
||||
|
||||
### TableNameUpdateBulk |
||||
#### Request |
||||
``` |
||||
mutation { |
||||
CountryUpdateBulk(data: [{country: "test 2", country_id: 10265}, {country: "test 3", country_id: 10266}]) |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryUpdateBulk": [ |
||||
1, |
||||
1 |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
|
||||
[:arrow_heading_up:](#mutations) |
||||
|
||||
### TableNameDeleteBulk |
||||
#### Request |
||||
``` |
||||
mutation { |
||||
CountryDeleteBulk(data: [{country_id: 10265}, {country_id: 10266}]) |
||||
} |
||||
``` |
||||
|
||||
#### Response |
||||
```json |
||||
{ |
||||
"data": { |
||||
"CountryDeleteBulk": [ |
||||
1, |
||||
1 |
||||
] |
||||
} |
||||
} |
||||
``` |
||||
@ -1,278 +0,0 @@
|
||||
--- |
||||
title: 'Introduction' |
||||
description: 'Empower your NuxtJS application with this awesome module.' |
||||
position: 1 |
||||
category: 'Getting started' |
||||
version: 1.4 |
||||
fullscreen: true |
||||
menuTitle: 'Intro' |
||||
--- |
||||
|
||||
|
||||
<h1 align="center" style="border-bottom: none"> |
||||
<b> |
||||
<a href="https://www.nocodb.com">NocoDB </a><br> |
||||
</b> |
||||
✨ The Open Source Airtable Alternative ✨ <br> |
||||
|
||||
</h1> |
||||
<p align="center"> |
||||
Turns any MySQL, PostgreSQL, SQL Server, SQLite & MariaDB into a smart-spreadsheet. |
||||
</p> |
||||
<div align="center"> |
||||
|
||||
[](https://travis-ci.com/github/NocoDB/NocoDB) |
||||
[](http://nodejs.org/download/) |
||||
[](https://twitter.com/NocoDB) |
||||
|
||||
</div> |
||||
|
||||
<p align="center"> |
||||
<a href="http://www.nocodb.com"><b>Website</b></a> • |
||||
<a href="https://discord.gg/5RgZmkW"><b>Discord</b></a> • |
||||
<a href="https://twitter.com/nocodb"><b>Twitter</b></a> |
||||
</p> |
||||
|
||||
<p align="center"> |
||||
<img src="static/open-source-airtable-alternative/OpenSourceAirtableAlternative.png" width="100%"> |
||||
<br/><br/> |
||||
</p> |
||||
|
||||
<a href="https://www.producthunt.com/posts/nocodb?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-nocodb" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=297536&theme=dark" alt="NocoDB - The Open Source Airtable alternative | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a> |
||||
|
||||
# Quick try |
||||
### 1-Click Deploy |
||||
<a href="https://heroku.com/deploy?template=https://github.com/npgia/nocodb-seed-heroku"> |
||||
<img |
||||
src="https://www.herokucdn.com/deploy/button.svg" |
||||
width="300px" |
||||
alt="Deploy NocoDB to Heroku with 1-Click" |
||||
/> |
||||
</a> |
||||
<br> |
||||
|
||||
### Using Docker |
||||
```bash |
||||
docker run -d --name nocodb -p 8080:8080 nocodb/nocodb |
||||
``` |
||||
|
||||
### Using Npm |
||||
``` |
||||
npx create-nocodb-app |
||||
``` |
||||
### Using Git |
||||
``` |
||||
git clone https://github.com/nocodb/nocodb-seed |
||||
cd nocodb-seed |
||||
npm install |
||||
npm start |
||||
``` |
||||
|
||||
### GUI |
||||
|
||||
Access Dashboard using : [http://localhost:8080/dashboard](http://localhost:8080/dashboard) |
||||
|
||||
|
||||
# Join Our Community |
||||
<a href="https://discord.gg/5RgZmkW"> |
||||
<img |
||||
src="https://invidget.switchblade.xyz/5RgZmkW" |
||||
alt="Join NocoDB : Free & Open Source Airtable Alternative" |
||||
> |
||||
</a> |
||||
<br> |
||||
|
||||
# Screenshots |
||||
<img src="static/nocodb/2.png"/> |
||||
<br> |
||||
<img src="static/nocodb/1.png"/> |
||||
<br> |
||||
<img src="static/nocodb/7.png"/> |
||||
<br> |
||||
<img src="static/nocodb/5.png"/> |
||||
<br> |
||||
<img src="static/nocodb/6.png"/> |
||||
<br> |
||||
<img src="static/nocodb/3.png"/> |
||||
<br> |
||||
<img src="static/nocodb/4.png"/> |
||||
<br> |
||||
<img src="static/nocodb/11.png"/> |
||||
<br> |
||||
<img src="static/nocodb/10.png"/> |
||||
<br> |
||||
<img src="static/nocodb/8.png"/> |
||||
<br> |
||||
<img src="static/nocodb/9.png"/> |
||||
<br> |
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# Features |
||||
### Rich Spreadsheet Interface |
||||
- ⚡ Search, sort, filter, hide columns with uber ease |
||||
- ⚡ Create Views : Grid, Gallery, Kanban, Gantt, Form |
||||
- ⚡ Share Views : public & password protected |
||||
- ⚡ Personal & locked Views |
||||
- ⚡ Upload images to cells (Works with S3, Minio, GCP, Azure, DigitalOcean, Linode, OVH, BackBlaze)!! |
||||
- ⚡ Roles : Owner, Creator, Editor, Commenter, Viewer, Commenter, Custom Roles. |
||||
- ⚡ Access Control : Fine-grained access control even at database, table & column level. |
||||
|
||||
### App Store for workflow automations : |
||||
- ⚡ Chat : Microsoft Teams, Slack, Discord, Mattermost |
||||
- ⚡ Email : SMTP, SES, Mailchimp |
||||
- ⚡ SMS : Twilio |
||||
- ⚡ Whatsapp |
||||
- ⚡ Any 3rd Party APIs |
||||
|
||||
### Programmatic API access via : |
||||
- ⚡ REST APIs (Swagger) |
||||
- ⚡ GraphQL APIs. |
||||
- ⚡ Includes JWT Authentication & Social Auth |
||||
- ⚡ API tokens to integrate with Zapier, Integromat. |
||||
|
||||
# Production Setup |
||||
NocoDB requires a database to store metadata of spreadsheets views and external databases. |
||||
And connection params for this database can be specified in `NC_DB` environment variable. |
||||
|
||||
## Docker |
||||
|
||||
#### Example MySQL |
||||
``` |
||||
docker run -d -p 8080:8080 \ |
||||
-e NC_DB="mysql2://host.docker.internal:3306?u=root&p=password&d=d1" \ |
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ |
||||
nocodb/nocodb |
||||
``` |
||||
|
||||
#### Example Postgres |
||||
``` |
||||
docker run -d -p 8080:8080 \ |
||||
-e NC_DB="pg://host:port?u=user&p=password&d=database" \ |
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ |
||||
nocodb/nocodb |
||||
``` |
||||
|
||||
#### Example SQL Server |
||||
``` |
||||
docker run -d -p 8080:8080 \ |
||||
-e NC_DB="mssql://host:port?u=user&p=password&d=database" \ |
||||
-e NC_AUTH_JWT_SECRET="569a1821-0a93-45e8-87ab-eb857f20a010" \ |
||||
nocodb/nocodb |
||||
``` |
||||
|
||||
## Docker Compose |
||||
``` |
||||
git clone https://github.com/nocodb/nocodb |
||||
cd docker-compose |
||||
cd mysql or pg or mssql |
||||
docker-compose up |
||||
``` |
||||
|
||||
|
||||
## Environment variables |
||||
| Variable | Mandatory | Comments | If absent | |
||||
|-------------------------|-----------|----------------------------------------------------------------------------------|--------------------------------------------| |
||||
| NC_DB | Yes | See our database URLs | A local SQLite will be created in root folder | |
||||
| DATABASE_URL | No | JDBC URL Format. Can be used instead of NC_DB. Used in 1-Click Heroku deployment| | |
||||
| NC_PUBLIC_URL | Yes | Used for sending Email invitations | Best guess from http request params | |
||||
| NC_AUTH_JWT_SECRET | Yes | JWT secret used for auth and storing other secrets | A Random secret will be generated | |
||||
| NC_SENTRY_DSN | No | For Sentry monitoring | | |
||||
| NC_CONNECT_TO_EXTERNAL_DB_DISABLED | No | Disable Project creation with external database | | |
||||
| NC_DISABLE_TELE | No | Disable telemetry | | |
||||
| NC_BACKEND_URL | No | Custom Backend URL | ``http://localhost:8080`` will be used | |
||||
|
||||
# Running locally |
||||
``` |
||||
git clone https://github.com/nocodb/nocodb |
||||
cd nocodb |
||||
|
||||
# run backend |
||||
cd packages/nocodb |
||||
npm install |
||||
npm run watch:run |
||||
|
||||
# open localhost:8080/dashboard in browser |
||||
|
||||
# run frontend |
||||
cd packages/nc-gui |
||||
npm install |
||||
npm run dev |
||||
|
||||
# open localhost:3000/dashboard in browser |
||||
``` |
||||
|
||||
Changes made to code automatically restart. |
||||
|
||||
# Contributing |
||||
- Please take a look at ./contribute/HowToApplyLicense.md |
||||
- Ignore adding headers for .json or .md or .yml |
||||
|
||||
# 🎯 Why are we building this ? |
||||
Most internet businesses equip themselves with either spreadsheet or a database to solve their business needs. Spreadsheets are used by a Billion+ humans collaboratively every single day. However, we are way off working at similar speeds on databases which are way more powerful tools when it comes to computing. Attempts to solve this with SaaS offerings has meant horrible access controls, vendor lockin, data lockin, abrupt price changes & most importantly a glass ceiling on what's possible in future. |
||||
|
||||
# ❤ Our Mission : |
||||
Our mission is to provide the most powerful no-code interface for databases which is open source to every single internet business in the world. This would not only democratise access to a powerful computing tool but also bring forth a billion+ people who will have radical tinkering-and-building abilities on internet. |
||||
|
||||
# Contributors : 🌻🌻🌻🐝🐝 |
||||
[//]: contributor-faces |
||||
<a href="https://github.com/o1lab"><img src="https://avatars.githubusercontent.com/u/5435402?v=4" title="Naveen MR" width="50" height="50"></a> |
||||
<a href="https://github.com/pranavxc"><img src="https://avatars.githubusercontent.com/u/61551451?v=4" title="Pranav C Balan" width="50" height="50"></a> |
||||
<a href="https://github.com/bvkatwijk"><img src="https://avatars.githubusercontent.com/u/18490578?s=60&v=4" title="bvkatwijk" width="50" height="50"></a> |
||||
<a href="https://github.com/markuman"><img src="https://avatars.githubusercontent.com/u/3920157?s=60&v=4" title="markuman" width="50" height="50"></a> |
||||
<a href="https://github.com/DanielRuf"><img src="https://avatars.githubusercontent.com/u/827205?s=60&v=4" title="DanielRuf" width="50" height="50"></a> |
||||
<a href="https://github.com/bertyhell"><img src="https://avatars.githubusercontent.com/u/1710840?s=60&v=4" title="bertyhell" width="50" height="50"></a> |
||||
<a href="https://github.com/chocholand"><img src="https://avatars.githubusercontent.com/u/6572227?s=60&v=4" title="chocholand" width="50" height="50"></a> |
||||
<a href="https://github.com/0xflotus"><img src="https://avatars.githubusercontent.com/u/26602940?s=60&v=4" title="0xflotus" width="50" height="50"></a> |
||||
<a href="https://github.com/sguionni"><img src="https://avatars.githubusercontent.com/u/3633017?s=60&v=4" title="sguionni" width="50" height="50"></a> |
||||
<a href="https://github.com/extremeshok"><img src="https://avatars.githubusercontent.com/u/5957328?s=60&v=4" title="extremeshok" width="50" height="50"></a> |
||||
<a href="https://github.com/v2io"><img src="https://avatars.githubusercontent.com/u/48987429?s=60&v=4" title="v2io" width="50" height="50"></a> |
||||
<a href="https://github.com/soaserele"><img src="https://avatars.githubusercontent.com/u/1093368?s=60&v=4" title="soaserele" width="50" height="50"></a> |
||||
<a href="https://github.com/ans-4175"><img src="https://avatars.githubusercontent.com/u/3961872?s=60&v=4" title="ans-4175" width="50" height="50"></a> |
||||
<a href="https://github.com/lotas"><img src="https://avatars.githubusercontent.com/u/83861?s=60&v=4" title="lotas" width="50" height="50"></a> |
||||
<a href="https://github.com/ferrybig"><img src="https://avatars.githubusercontent.com/u/1576684?s=60&v=4" title="ferrybig" width="50" height="50"></a> |
||||
<a href="https://github.com/jrevault"><img src="https://avatars.githubusercontent.com/u/1001585?v=4" title="" width="50" height="50"></a> |
||||
<a href="https://github.com/atilacamurca"><img src="https://avatars.githubusercontent.com/u/508624?v=4" title="" width="50" height="50"></a> |
||||
<a href="https://github.com/simonbowen"><img src="https://avatars.githubusercontent.com/u/8931?v=4" title="" width="50" height="50"></a> |
||||
<a href="https://github.com/0xflotus"><img src="https://avatars.githubusercontent.com/u/26602940?v=4" title="" width="50" height="50"></a> |
||||
<a href="https://github.com/wingkwong"><img src="https://avatars.githubusercontent.com/u/35857179?v=4" title="" width="50" height="50"></a> |
||||
<a href="https://github.com/ferdiga"><img src="https://avatars.githubusercontent.com/u/6248560?v=4" title="" width="50" height="50"></a> |
||||
<a href="https://github.com/Flatroy"><img src="https://avatars.githubusercontent.com/u/4980165?v=4" title="" width="50" height="50"></a> |
||||
<a href="https://github.com/jwillmer"><img src="https://avatars.githubusercontent.com/u/1503577?v=4" title="" width="50" height="50"></a> |
||||
<a href="https://github.com/bhanuc"><img src="https://avatars.githubusercontent.com/u/2958857?v=4" title="" width="50" height="50"></a> |
||||
<a href="https://github.com/jwetzell"><img src="https://avatars.githubusercontent.com/u/18341515?s=60&v=4" title="" width="50" height="50"></a> |
||||
<a href="https://github.com/SebGTx"><img src="https://avatars.githubusercontent.com/u/8062146?v=4" title="" width="50" height="50"></a> |
||||
|
||||
|
||||
- - - - - - - |
||||
|
||||
|
||||
### Has Many - Schema |
||||
|
||||
- Create |
||||
* Create a new relation |
||||
- Create foreign key in child table |
||||
- Update metadata |
||||
- GUI |
||||
- |
||||
|
||||
* Existing |
||||
- We need to show existing relation |
||||
- Update metadata |
||||
- Delete |
||||
* Delete virtual field |
||||
* Delete virtual field and relation |
||||
|
||||
- HasMany Lookup column |
||||
* Rendering |
||||
* Adding new child |
||||
- Associate an existing child |
||||
- Create and add |
||||
* Pagination |
||||
* Remove child |
||||
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,84 @@
|
||||
--- |
||||
title: 'Setup and Usage' |
||||
description: 'Simple installation - takes about three minutes!' |
||||
position: 0 |
||||
category: 'Getting started' |
||||
fullscreen: true |
||||
menuTitle: 'Install' |
||||
link: https://codesandbox.io/embed/vigorous-firefly-80kq5?hidenavigation=1&theme=dark |
||||
--- |
||||
|
||||
|
||||
## Simple installation - takes about three minutes! |
||||
|
||||
### Prerequisites |
||||
|
||||
- __Must haves__ |
||||
* [node.js >= 12](https://nodejs.org/en/download) / [Docker](https://www.docker.com/get-started) |
||||
* [MySql](https://dev.mysql.com/downloads/mysql/) / [Postgres](https://www.postgresql.org/download/) / [SQLserver](https://www.microsoft.com/en-gb/sql-server/sql-server-downloads) / SQLite Database |
||||
- Nice to haves |
||||
- Existing schemas can help to create APIs quickly. |
||||
- An example database schema can be found :<a class="grey--text" |
||||
href="https://github.com/lerocha/chinook-database/tree/master/ChinookDatabase/DataSources"> |
||||
<u>here</u> |
||||
</a> |
||||
|
||||
|
||||
|
||||
## Quick try |
||||
### 1-Click Deploy |
||||
<a href="https://heroku.com/deploy?template=https://github.com/npgia/nocodb-seed-heroku"> |
||||
<img |
||||
src="https://www.herokucdn.com/deploy/button.svg" |
||||
width="300px" |
||||
alt="Deploy NocoDB to Heroku with 1-Click" |
||||
/> |
||||
</a> |
||||
|
||||
### Node app or docker |
||||
|
||||
|
||||
<code-group> |
||||
<code-block label="NPX" active> |
||||
|
||||
```bash |
||||
npx create-nocodb-app |
||||
``` |
||||
|
||||
</code-block> |
||||
<code-block label="Docker" > |
||||
|
||||
```bash |
||||
docker run -d --name nocodb -p 8080:8080 nocodb/nocodb |
||||
``` |
||||
|
||||
</code-block> |
||||
<code-block label="Using Git" > |
||||
|
||||
```bash |
||||
git clone https://github.com/nocodb/nocodb-seed |
||||
cd nocodb-seed |
||||
npm install |
||||
npm start |
||||
``` |
||||
|
||||
</code-block> |
||||
</code-group> |
||||
|
||||
|
||||
### Sample app |
||||
<code-sandbox :src="link"></code-sandbox> |
||||
|
||||
|
||||
# Sample Demos |
||||
### Docker deploying with one command |
||||
|
||||
<youtube id="K-UEecQyiOk"></youtube> |
||||
|
||||
### Using Npx |
||||
|
||||
<youtube id="v6Nn75P1p7I"></youtube> |
||||
|
||||
### Heroku Deployment |
||||
<youtube id="v6Nn75P1p7I"></youtube> |
||||
|
||||
Loading…
Reference in new issue