Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
tengine:api [2022/06/09 01:19] – twinny | tengine:api [2023/04/23 06:35] (current) – twinny | ||
---|---|---|---|
Line 1: | Line 1: | ||
===== API Documentation ===== | ===== API Documentation ===== | ||
+ | |||
+ | ( I accidentally nuked all documentation so It's currently being rebuilt! May be some missing parts of old/invalid details ) | ||
This page provides details on how you can use TEngine via API calls | This page provides details on how you can use TEngine via API calls | ||
Line 8: | Line 10: | ||
=== Arguments === | === Arguments === | ||
+ | |||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 13: | Line 16: | ||
pk=STRING | pk=STRING | ||
sk=STRING | sk=STRING | ||
- | | + | |
indexes={ | indexes={ | ||
" | " | ||
Line 20: | Line 23: | ||
} | } | ||
} (optional) | } (optional) | ||
- | + | ||
} | } | ||
+ | |||
</ | </ | ||
=== Return Format === | === Return Format === | ||
+ | |||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 30: | Line 35: | ||
success=BOOLEAN | success=BOOLEAN | ||
} | } | ||
+ | |||
</ | </ | ||
=== Example Request === | === Example Request === | ||
+ | |||
<code javascript> | <code javascript> | ||
temp.req = {}; | temp.req = {}; | ||
- | + | ||
// Create a base table and two indexes | // Create a base table and two indexes | ||
// pk is mandatory, sk is optional | // pk is mandatory, sk is optional | ||
- | + | ||
temp.req.tablename = " | temp.req.tablename = " | ||
temp.req.pk = " | temp.req.pk = " | ||
temp.req.sk = " | temp.req.sk = " | ||
- | + | ||
temp.req.indexes = {}; | temp.req.indexes = {}; | ||
- | + | ||
temp.req.indexes.house_index = {}; | temp.req.indexes.house_index = {}; | ||
temp.req.indexes.house_index.pk = " | temp.req.indexes.house_index.pk = " | ||
temp.req.indexes.house_index.sk = " | temp.req.indexes.house_index.sk = " | ||
- | + | ||
temp.req.indexes.location_index = {}; | temp.req.indexes.location_index = {}; | ||
temp.req.indexes.location_index.pk = " | temp.req.indexes.location_index.pk = " | ||
- | + | ||
- | //create table | + | //create table |
temp.r = TEngine.createtable(temp.req); | temp.r = TEngine.createtable(temp.req); | ||
if (temp.r.error) { | if (temp.r.error) { | ||
printf(" | printf(" | ||
- | } | + | } |
</ | </ | ||
=== Example Return === | === Example Return === | ||
+ | |||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 65: | Line 74: | ||
" | " | ||
} | } | ||
+ | |||
</ | </ | ||
Line 80: | Line 90: | ||
} | } | ||
} | } | ||
+ | |||
</ | </ | ||
=== Return Format === | === Return Format === | ||
+ | |||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 89: | Line 101: | ||
result=OBJECT | result=OBJECT | ||
} | } | ||
+ | |||
</ | </ | ||
=== Example Request === | === Example Request === | ||
+ | |||
<code javascript> | <code javascript> | ||
temp.req = {}; | temp.req = {}; | ||
temp.req.tablename = " | temp.req.tablename = " | ||
- | + | ||
temp.req.keys.account = " | temp.req.keys.account = " | ||
temp.req.keys.sort = " | temp.req.keys.sort = " | ||
- | + | ||
temp.r = TEngine.get(temp.req); | temp.r = TEngine.get(temp.req); | ||
if (temp.r.error) { | if (temp.r.error) { | ||
printf(" | printf(" | ||
} | } | ||
+ | |||
</ | </ | ||
Line 113: | Line 128: | ||
" | " | ||
} | } | ||
+ | |||
</ | </ | ||
Line 119: | Line 135: | ||
Queries can be made either on the base table or an index. It must be made on a partition key but the sort key is optional, even if the table is configured with a sort key. When the table/index only has a partition key, the single item with the matching partition key will be returned. If the table/index is configured with a partition key and sort key, it can provide every single item which matches the partition key. You can provide the sort key to return items matching the partiyion key and sort key (note that in an index, this can be multiple items) | Queries can be made either on the base table or an index. It must be made on a partition key but the sort key is optional, even if the table is configured with a sort key. When the table/index only has a partition key, the single item with the matching partition key will be returned. If the table/index is configured with a partition key and sort key, it can provide every single item which matches the partition key. You can provide the sort key to return items matching the partiyion key and sort key (note that in an index, this can be multiple items) | ||
- | You can also opt to provide conditions which will be tested on the sort key. Each condition will be tested and the item will only be returned if true to all conditions. | + | You can also opt to provide conditions which will be tested on the sort key. Each condition will be tested and the item will only be returned if true to all conditions. |
Conditions include | Conditions include | ||
+ | |||
* begins_with - the sort key begins with the provided string | * begins_with - the sort key begins with the provided string | ||
* > - the sort key is greater than the provided value (Note: compared as a string) | * > - the sort key is greater than the provided value (Note: compared as a string) | ||
* < - the sort key is less than the provided value (Note: compared as a string) | * < - the sort key is less than the provided value (Note: compared as a string) | ||
- | |||
Consider this table with the following items: | Consider this table with the following items: | ||
+ | |||
< | < | ||
... | ... | ||
Line 137: | Line 154: | ||
{pk: " | {pk: " | ||
... | ... | ||
+ | |||
</ | </ | ||
Example queries: | Example queries: | ||
- | | + | |
+ | | ||
* pk == item1 and sk == " | * pk == item1 and sk == " | ||
Line 147: | Line 166: | ||
=== Argument Format === | === Argument Format === | ||
+ | |||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 158: | Line 178: | ||
conditions=ARRAY of ARRAYS e.g. { {" | conditions=ARRAY of ARRAYS e.g. { {" | ||
} | } | ||
+ | |||
</ | </ | ||
=== Return Format === | === Return Format === | ||
+ | |||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 169: | Line 191: | ||
error=STRING | error=STRING | ||
} | } | ||
+ | |||
</ | </ | ||
=== Example Request === | === Example Request === | ||
+ | |||
<code javascript> | <code javascript> | ||
tbd | tbd | ||
+ | |||
</ | </ | ||
=== Example Return === | === Example Return === | ||
+ | |||
<code javascript> | <code javascript> | ||
tbd | tbd | ||
- | </ | ||
+ | </ | ||
==== Put / Update ==== | ==== Put / Update ==== | ||
- | Both methods use the same underlying method but the difference is: \\ | + | Both methods use the same underlying method but the difference is: \\ **Put**: will either replace an existing item with the request or create a new item if it does not exist \\ **Update**: will either update an existing item with the request or create a new item if it does not exist |
- | **Put**: will either replace an existing item with the request or create a new item if it does not exist \\ | + | |
- | **Update**: will either update an existing item with the request or create a new item if it does not exist \\ | + | |
If the item matches any indexes in the table, the item will automatically be added to the index. If the item was previously in the index but no longer matches, it will be removed. | If the item matches any indexes in the table, the item will automatically be added to the index. If the item was previously in the index but no longer matches, it will be removed. | ||
- | |||
=== Argument Format === | === Argument Format === | ||
Line 197: | Line 220: | ||
tablename=STRING | tablename=STRING | ||
keys = { | keys = { | ||
- | " | + | " |
} | } | ||
data = { | data = { | ||
Line 205: | Line 228: | ||
} | } | ||
} | } | ||
+ | |||
</ | </ | ||
=== Return Format === | === Return Format === | ||
+ | |||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 213: | Line 238: | ||
success=BOOLEAN | success=BOOLEAN | ||
} | } | ||
+ | |||
</ | </ | ||
=== Example Request === | === Example Request === | ||
+ | |||
<code javascript> | <code javascript> | ||
temp.req = {}; | temp.req = {}; | ||
temp.req.keys.account = " | temp.req.keys.account = " | ||
temp.req.keys.sort = " | temp.req.keys.sort = " | ||
- | + | ||
temp.req.data.housetype=" | temp.req.data.housetype=" | ||
temp.req.data.housesubtype=" | temp.req.data.housesubtype=" | ||
Line 230: | Line 257: | ||
printf(" | printf(" | ||
} | } | ||
+ | |||
</ | </ | ||
Line 239: | Line 267: | ||
" | " | ||
} | } | ||
+ | |||
</ | </ | ||
Line 246: | Line 275: | ||
=== Argument Format === | === Argument Format === | ||
+ | |||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 253: | Line 283: | ||
} | } | ||
} | } | ||
+ | |||
</ | </ | ||
=== Return Format === | === Return Format === | ||
+ | |||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 261: | Line 293: | ||
success=BOOLEAN | success=BOOLEAN | ||
} | } | ||
+ | |||
</ | </ | ||
=== Example Request === | === Example Request === | ||
+ | |||
<code javascript> | <code javascript> | ||
temp.req = {}; | temp.req = {}; | ||
Line 273: | Line 307: | ||
printf(" | printf(" | ||
} | } | ||
+ | |||
</ | </ | ||
=== Example Return === | === Example Return === | ||
+ | |||
<code javascript> | <code javascript> | ||
{ | { | ||
Line 281: | Line 317: | ||
" | " | ||
} | } | ||
+ | |||
</ | </ | ||
Line 290: | Line 327: | ||
tbd | tbd | ||
+ | |||
+ | ---- | ||
~~DISCUSSION~~ | ~~DISCUSSION~~ | ||
+ | |||
+ |