1
+ ---
2
+ sidebar_position : 3
3
+ slug : /html_api_reference
4
+ ---
5
+
1
6
# HTTP API Reference
2
7
3
8
## Create database
4
9
5
- create a new database.
10
+ Creates a new database.
6
11
7
12
#### Request
8
13
``` http request
@@ -33,11 +38,9 @@ curl --request POST \
33
38
}
34
39
```
35
40
36
- ---
37
-
38
41
## Drop database
39
42
40
- Drop a database.
43
+ Drops a database.
41
44
42
45
#### Request
43
46
``` http request
@@ -68,11 +71,9 @@ curl --request DELETE \
68
71
}
69
72
```
70
73
71
- ---
72
-
73
74
## Retrieve a database
74
75
75
- Retrieve a database.
76
+ Retrieves a database.
76
77
77
78
#### Request
78
79
``` http request
@@ -99,11 +100,9 @@ curl --request GET \
99
100
}
100
101
```
101
102
102
- ---
103
-
104
103
## List databases
105
104
106
- Retrieve all databases of the system.
105
+ Retrieves all databases of the system.
107
106
108
107
#### Request
109
108
``` http request
@@ -125,11 +124,9 @@ curl --request GET \
125
124
}
126
125
```
127
126
128
- ---
129
-
130
127
## Create table
131
128
132
- create a new table.
129
+ creates a new table.
133
130
134
131
#### Request
135
132
``` http request
@@ -187,11 +184,9 @@ curl --request POST \
187
184
}
188
185
```
189
186
190
- ---
191
-
192
187
## Drop table
193
188
194
- drop a table.
189
+ Drops a table.
195
190
196
191
#### Request
197
192
``` http request
@@ -222,11 +217,9 @@ curl --request DELETE \
222
217
}
223
218
```
224
219
225
- ---
226
-
227
220
## List tables
228
221
229
- list tables of the database.
222
+ Lists tables of the database.
230
223
231
224
#### Request
232
225
``` http request
@@ -265,11 +258,9 @@ curl --request GET \
265
258
}
266
259
```
267
260
268
- ---
269
-
270
261
## Retrieve a table
271
262
272
- Retrieve a table from a database
263
+ Retrieves a table from a database.
273
264
274
265
#### Request
275
266
``` http request
@@ -312,11 +303,9 @@ curl --request GET \
312
303
}
313
304
```
314
305
315
- ---
316
-
317
306
## Create index
318
307
319
- create an index on the table.
308
+ Creates an index on the table.
320
309
321
310
#### Request
322
311
``` http request
@@ -359,10 +348,9 @@ curl --request POST \
359
348
}
360
349
```
361
350
362
- ---
363
351
## Drop index
364
352
365
- Drop index
353
+ Drops an index.
366
354
367
355
#### Request
368
356
``` http request
@@ -388,11 +376,9 @@ curl --request DELETE \
388
376
}
389
377
```
390
378
391
- ---
392
-
393
379
## Insert
394
380
395
- Insert data into table
381
+ Inserts data into a specified table.
396
382
397
383
#### Request
398
384
``` http request
@@ -434,11 +420,9 @@ curl --request POST \
434
420
}
435
421
```
436
422
437
- ---
438
-
439
423
## Delete
440
424
441
- delete data from table
425
+ Deletes data from a specified table.
442
426
443
427
#### Request
444
428
``` http request
@@ -470,11 +454,9 @@ curl --request DELETE \
470
454
}
471
455
```
472
456
473
- ---
474
-
475
457
## Update
476
458
477
- update data in table
459
+ Updates data in a specified table.
478
460
479
461
#### Request
480
462
``` http request
@@ -510,11 +492,9 @@ curl --request PUT \
510
492
}
511
493
```
512
494
513
- ---
514
-
515
495
## Select
516
496
517
- select data from table
497
+ Selects data from a specified table.
518
498
519
499
#### Request
520
500
``` http request
@@ -589,11 +569,10 @@ curl --request GET \
589
569
}
590
570
```
591
571
592
- ---
593
572
594
573
## Show variables
595
574
596
- Get variables
575
+ Gets variables.
597
576
598
577
#### Request
599
578
``` http request
@@ -617,6 +596,4 @@ curl --request GET \
617
596
"error_code" : 3027 ,
618
597
"error_message" : " No variable {variable_name}."
619
598
}
620
- ```
621
-
622
- ---
599
+ ```
0 commit comments