Update Table Schema
curl --request PATCH \
--url https://api.example.com/api/database/tables/{tableName}/schema \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"addColumns": [
{
"columnName": "<string>",
"isNullable": true,
"isUnique": false,
"defaultValue": "<string>"
}
],
"dropColumns": [
"<string>"
],
"updateColumns": [
{
"columnName": "<string>",
"newColumnName": "<string>",
"defaultValue": "<string>"
}
],
"addForeignKeys": [
{
"referenceTable": "<string>",
"referenceColumns": [
{
"sourceColumn": "<string>",
"referenceColumn": "<string>"
}
],
"constraintName": "<string>"
}
],
"dropForeignKeys": [
"<string>"
]
}
'import requests
url = "https://api.example.com/api/database/tables/{tableName}/schema"
payload = {
"addColumns": [
{
"columnName": "<string>",
"isNullable": True,
"isUnique": False,
"defaultValue": "<string>"
}
],
"dropColumns": ["<string>"],
"updateColumns": [
{
"columnName": "<string>",
"newColumnName": "<string>",
"defaultValue": "<string>"
}
],
"addForeignKeys": [
{
"referenceTable": "<string>",
"referenceColumns": [
{
"sourceColumn": "<string>",
"referenceColumn": "<string>"
}
],
"constraintName": "<string>"
}
],
"dropForeignKeys": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
addColumns: [
{
columnName: '<string>',
isNullable: true,
isUnique: false,
defaultValue: '<string>'
}
],
dropColumns: ['<string>'],
updateColumns: [{columnName: '<string>', newColumnName: '<string>', defaultValue: '<string>'}],
addForeignKeys: [
{
referenceTable: '<string>',
referenceColumns: [{sourceColumn: '<string>', referenceColumn: '<string>'}],
constraintName: '<string>'
}
],
dropForeignKeys: ['<string>']
})
};
fetch('https://api.example.com/api/database/tables/{tableName}/schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/database/tables/{tableName}/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'addColumns' => [
[
'columnName' => '<string>',
'isNullable' => true,
'isUnique' => false,
'defaultValue' => '<string>'
]
],
'dropColumns' => [
'<string>'
],
'updateColumns' => [
[
'columnName' => '<string>',
'newColumnName' => '<string>',
'defaultValue' => '<string>'
]
],
'addForeignKeys' => [
[
'referenceTable' => '<string>',
'referenceColumns' => [
[
'sourceColumn' => '<string>',
'referenceColumn' => '<string>'
]
],
'constraintName' => '<string>'
]
],
'dropForeignKeys' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/database/tables/{tableName}/schema"
payload := strings.NewReader("{\n \"addColumns\": [\n {\n \"columnName\": \"<string>\",\n \"isNullable\": true,\n \"isUnique\": false,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"dropColumns\": [\n \"<string>\"\n ],\n \"updateColumns\": [\n {\n \"columnName\": \"<string>\",\n \"newColumnName\": \"<string>\",\n \"defaultValue\": \"<string>\"\n }\n ],\n \"addForeignKeys\": [\n {\n \"referenceTable\": \"<string>\",\n \"referenceColumns\": [\n {\n \"sourceColumn\": \"<string>\",\n \"referenceColumn\": \"<string>\"\n }\n ],\n \"constraintName\": \"<string>\"\n }\n ],\n \"dropForeignKeys\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/database/tables/{tableName}/schema")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"addColumns\": [\n {\n \"columnName\": \"<string>\",\n \"isNullable\": true,\n \"isUnique\": false,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"dropColumns\": [\n \"<string>\"\n ],\n \"updateColumns\": [\n {\n \"columnName\": \"<string>\",\n \"newColumnName\": \"<string>\",\n \"defaultValue\": \"<string>\"\n }\n ],\n \"addForeignKeys\": [\n {\n \"referenceTable\": \"<string>\",\n \"referenceColumns\": [\n {\n \"sourceColumn\": \"<string>\",\n \"referenceColumn\": \"<string>\"\n }\n ],\n \"constraintName\": \"<string>\"\n }\n ],\n \"dropForeignKeys\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/database/tables/{tableName}/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"addColumns\": [\n {\n \"columnName\": \"<string>\",\n \"isNullable\": true,\n \"isUnique\": false,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"dropColumns\": [\n \"<string>\"\n ],\n \"updateColumns\": [\n {\n \"columnName\": \"<string>\",\n \"newColumnName\": \"<string>\",\n \"defaultValue\": \"<string>\"\n }\n ],\n \"addForeignKeys\": [\n {\n \"referenceTable\": \"<string>\",\n \"referenceColumns\": [\n {\n \"sourceColumn\": \"<string>\",\n \"referenceColumn\": \"<string>\"\n }\n ],\n \"constraintName\": \"<string>\"\n }\n ],\n \"dropForeignKeys\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "Table schema updated successfully",
"tableName": "posts",
"operations": [
"added 2 columns",
"dropped 1 columns",
"renamed 1 columns",
"added 1 foreign keys",
"dropped 1 foreign keys"
]
}Admin
Update Table Schema
PATCH
/
api
/
database
/
tables
/
{tableName}
/
schema
Update Table Schema
curl --request PATCH \
--url https://api.example.com/api/database/tables/{tableName}/schema \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"addColumns": [
{
"columnName": "<string>",
"isNullable": true,
"isUnique": false,
"defaultValue": "<string>"
}
],
"dropColumns": [
"<string>"
],
"updateColumns": [
{
"columnName": "<string>",
"newColumnName": "<string>",
"defaultValue": "<string>"
}
],
"addForeignKeys": [
{
"referenceTable": "<string>",
"referenceColumns": [
{
"sourceColumn": "<string>",
"referenceColumn": "<string>"
}
],
"constraintName": "<string>"
}
],
"dropForeignKeys": [
"<string>"
]
}
'import requests
url = "https://api.example.com/api/database/tables/{tableName}/schema"
payload = {
"addColumns": [
{
"columnName": "<string>",
"isNullable": True,
"isUnique": False,
"defaultValue": "<string>"
}
],
"dropColumns": ["<string>"],
"updateColumns": [
{
"columnName": "<string>",
"newColumnName": "<string>",
"defaultValue": "<string>"
}
],
"addForeignKeys": [
{
"referenceTable": "<string>",
"referenceColumns": [
{
"sourceColumn": "<string>",
"referenceColumn": "<string>"
}
],
"constraintName": "<string>"
}
],
"dropForeignKeys": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
addColumns: [
{
columnName: '<string>',
isNullable: true,
isUnique: false,
defaultValue: '<string>'
}
],
dropColumns: ['<string>'],
updateColumns: [{columnName: '<string>', newColumnName: '<string>', defaultValue: '<string>'}],
addForeignKeys: [
{
referenceTable: '<string>',
referenceColumns: [{sourceColumn: '<string>', referenceColumn: '<string>'}],
constraintName: '<string>'
}
],
dropForeignKeys: ['<string>']
})
};
fetch('https://api.example.com/api/database/tables/{tableName}/schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/database/tables/{tableName}/schema",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'addColumns' => [
[
'columnName' => '<string>',
'isNullable' => true,
'isUnique' => false,
'defaultValue' => '<string>'
]
],
'dropColumns' => [
'<string>'
],
'updateColumns' => [
[
'columnName' => '<string>',
'newColumnName' => '<string>',
'defaultValue' => '<string>'
]
],
'addForeignKeys' => [
[
'referenceTable' => '<string>',
'referenceColumns' => [
[
'sourceColumn' => '<string>',
'referenceColumn' => '<string>'
]
],
'constraintName' => '<string>'
]
],
'dropForeignKeys' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/database/tables/{tableName}/schema"
payload := strings.NewReader("{\n \"addColumns\": [\n {\n \"columnName\": \"<string>\",\n \"isNullable\": true,\n \"isUnique\": false,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"dropColumns\": [\n \"<string>\"\n ],\n \"updateColumns\": [\n {\n \"columnName\": \"<string>\",\n \"newColumnName\": \"<string>\",\n \"defaultValue\": \"<string>\"\n }\n ],\n \"addForeignKeys\": [\n {\n \"referenceTable\": \"<string>\",\n \"referenceColumns\": [\n {\n \"sourceColumn\": \"<string>\",\n \"referenceColumn\": \"<string>\"\n }\n ],\n \"constraintName\": \"<string>\"\n }\n ],\n \"dropForeignKeys\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.example.com/api/database/tables/{tableName}/schema")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"addColumns\": [\n {\n \"columnName\": \"<string>\",\n \"isNullable\": true,\n \"isUnique\": false,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"dropColumns\": [\n \"<string>\"\n ],\n \"updateColumns\": [\n {\n \"columnName\": \"<string>\",\n \"newColumnName\": \"<string>\",\n \"defaultValue\": \"<string>\"\n }\n ],\n \"addForeignKeys\": [\n {\n \"referenceTable\": \"<string>\",\n \"referenceColumns\": [\n {\n \"sourceColumn\": \"<string>\",\n \"referenceColumn\": \"<string>\"\n }\n ],\n \"constraintName\": \"<string>\"\n }\n ],\n \"dropForeignKeys\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/database/tables/{tableName}/schema")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"addColumns\": [\n {\n \"columnName\": \"<string>\",\n \"isNullable\": true,\n \"isUnique\": false,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"dropColumns\": [\n \"<string>\"\n ],\n \"updateColumns\": [\n {\n \"columnName\": \"<string>\",\n \"newColumnName\": \"<string>\",\n \"defaultValue\": \"<string>\"\n }\n ],\n \"addForeignKeys\": [\n {\n \"referenceTable\": \"<string>\",\n \"referenceColumns\": [\n {\n \"sourceColumn\": \"<string>\",\n \"referenceColumn\": \"<string>\"\n }\n ],\n \"constraintName\": \"<string>\"\n }\n ],\n \"dropForeignKeys\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "Table schema updated successfully",
"tableName": "posts",
"operations": [
"added 2 columns",
"dropped 1 columns",
"renamed 1 columns",
"added 1 foreign keys",
"dropped 1 foreign keys"
]
}Authorizations
bearerAuthapiKey
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Add new columns to the table
Show child attributes
Show child attributes
Remove columns from the table
Name of the column to drop
Modify existing columns (rename or change default)
Show child attributes
Show child attributes
Add foreign key constraints (one entry per constraint; composite keys list multiple column mappings)
Show child attributes
Show child attributes
Constraint names of foreign keys to drop
Name of the foreign key constraint to drop
Rename the table
Show child attributes
Show child attributes
⌘I