Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revisionLast revisionBoth sides next revision | ||
tengine:api [2022/06/09 00:44] – [Put / Update] twinny | tengine:api [2022/06/09 01:27] – 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 66: | Line 68: | ||
} | } | ||
</ | </ | ||
+ | |||
+ | ==== Get ==== | ||
+ | |||
+ | Retrieve a single item from the table based on the provided partition and sort key (where specified). If the item does not exist, it will not fail but instead, return an empty array. Get requests can not be made on an index: use the Query instead. | ||
+ | |||
+ | === Request Format === | ||
+ | |||
+ | <code javascript> | ||
+ | { | ||
+ | tablename=STRING | ||
+ | keys={ | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === Return Format === | ||
+ | <code javascript> | ||
+ | { | ||
+ | error=STRING | ||
+ | success=BOOLEAN | ||
+ | result=OBJECT | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === Example Request === | ||
+ | <code javascript> | ||
+ | temp.req = {}; | ||
+ | temp.req.tablename = " | ||
+ | |||
+ | temp.req.keys.account = " | ||
+ | temp.req.keys.sort = " | ||
+ | |||
+ | temp.r = TEngine.get(temp.req); | ||
+ | if (temp.r.error) { | ||
+ | printf(" | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === Example Return === | ||
+ | |||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== Query ==== | ||
+ | |||
+ | 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. | ||
+ | |||
+ | Conditions include | ||
+ | * 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 less than the provided value (Note: compared as a string) | ||
+ | |||
+ | |||
+ | Consider this table with the following items: | ||
+ | < | ||
+ | ... | ||
+ | {pk: " | ||
+ | {pk: " | ||
+ | {pk: " | ||
+ | {pk: " | ||
+ | {pk: " | ||
+ | {pk: " | ||
+ | ... | ||
+ | </ | ||
+ | |||
+ | Example queries: | ||
+ | * pk == item1 : will return all 6 items | ||
+ | * pk == item1 and sk == " | ||
+ | |||
+ | * pk == item1 and sk begins_with " | ||
+ | * pk == item1 and sk > sort_23 : will return just sort_24 since it's the only item > 23 | ||
+ | |||
+ | === Argument Format === | ||
+ | <code javascript> | ||
+ | { | ||
+ | tablename=STRING | ||
+ | keys={ | ||
+ | " | ||
+ | } | ||
+ | sortorder=" | ||
+ | startat=INTEGER - if set, skips the number of items configured here before potentially read and returning items. Useful for pagination | ||
+ | limit=INTEGER - if set, limits the number of read/ | ||
+ | conditions=ARRAY of ARRAYS e.g. { {" | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === Return Format === | ||
+ | <code javascript> | ||
+ | { | ||
+ | result=[KEYS, | ||
+ | success=BOOLEAN | ||
+ | readcount=INTEGER | ||
+ | foundcount=INTEGER - how many items were intiially found | ||
+ | error=STRING | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === Example Request === | ||
+ | <code javascript> | ||
+ | tbd | ||
+ | </ | ||
+ | |||
+ | === Example Return === | ||
+ | <code javascript> | ||
+ | tbd | ||
+ | </ | ||
+ | |||
==== Put / Update ==== | ==== Put / Update ==== | ||
Line 74: | Line 191: | ||
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 === | ||
<code javascript> | <code javascript> | ||
- | tablename=STRING | + | { |
- | keys = { | + | |
- | " | + | keys = { |
+ | " | ||
+ | | ||
+ | data = { | ||
+ | | ||
+ | " | ||
+ | " | ||
+ | } | ||
} | } | ||
- | data = { | + | </ |
- | "string"=STRING | + | |
- | "string"={} | + | === Return Format === |
- | " | + | <code javascript> |
+ | { | ||
+ | | ||
+ | success=BOOLEAN | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === Example Request === | ||
+ | <code javascript> | ||
+ | temp.req = {}; | ||
+ | temp.req.keys.account = "Jane"; | ||
+ | temp.req.keys.sort | ||
+ | |||
+ | | ||
+ | temp.req.data.housesubtype=" | ||
+ | temp.req.data.randomvariable=" | ||
+ | temp.req.data.location=" | ||
+ | temp.req.tablename=" | ||
+ | temp.r = TEngine.put(temp.req); | ||
+ | if (temp.r.error) | ||
+ | printf(" | ||
+ | | ||
+ | </ | ||
+ | |||
+ | === Return Example === | ||
+ | |||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== DeleteItem ==== | ||
+ | |||
+ | Will delete the specified item from the table. If the table has indexes and the item was written to one or more indexes, it will also be deleted from the index | ||
+ | |||
+ | === Argument Format === | ||
+ | <code javascript> | ||
+ | { | ||
+ | | ||
+ | keys={ | ||
+ | | ||
+ | } | ||
} | } | ||
</ | </ | ||
Line 96: | Line 264: | ||
} | } | ||
</ | </ | ||
+ | |||
+ | === Example Request === | ||
+ | <code javascript> | ||
+ | temp.req = {}; | ||
+ | temp.req.tablename=" | ||
+ | temp.req.keys.account = " | ||
+ | temp.req.keys.sort = " | ||
+ | temp.r = TEngine.deleteitem(temp.req); | ||
+ | if (temp.r.error) { | ||
+ | printf(" | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | === Example Return === | ||
+ | <code javascript> | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | ==== ListTables ==== | ||
+ | |||
+ | tbd | ||
+ | |||
+ | ==== DescribeTable ==== | ||
+ | |||
+ | tbd | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ~~DISCUSSION~~ |