totole/services
1
0
Fork 0
mirror of https://github.com/kevin-DL/services.git synced 2026-01-11 19:04:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

tweaks to docs (#200)

Browse Source
This commit is contained in:
Dominic Wong
2021-09-02 15:23:24 +01:00
committed by GitHub
parent 2e5af32faf
commit d378ef2de5
39 changed files with 83 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
db/README.md
View File

@@ -2,4 +2,4 @@ Simple database service
# DB Service
The DB service is a simple database which provides persistent storage via a CRUD API. It includes fast querying, ordering and more.
The DB service is a simple database which provides persistent storage via a Create Read Update Delete (CRUD) API. It includes fast querying, ordering, and more.

16
db/proto/db.proto
View File

@@ -16,7 +16,7 @@ service Db {
// Read data from a table. Lookup can be by ID or via querying any field in the record.
message ReadRequest {
// Optional table name
// Optional table name. Defaults to 'default'
string table = 1;
// Read by id. Equivalent to 'id == "your-id"'
string id = 2;
@@ -27,7 +27,7 @@ message ReadRequest {
// Accessing list elements is not supported yet.
string query = 3;
int32 offset = 4;
// Default limit is 25.
// Maximum number of records to return. Default limit is 25.
// Maximum limit is 1000. Anything higher will return an error.
int32 limit = 5;
// field name to order by
@@ -41,9 +41,9 @@ message ReadResponse {
repeated google.protobuf.Struct records = 1;
}
// Create a record in the database. Optionally include an "id" field otherwise its set automatically.
// Create a record in the database. Optionally include an "id" field otherwise it's set automatically.
message CreateRequest {
// Optional table name
// Optional table name. Defaults to 'default'
string table = 1;
// JSON encoded record or records (can be array or object)
google.protobuf.Struct record = 2;
@@ -56,9 +56,9 @@ message CreateResponse {
// Update a record in the database. Include an "id" in the record to update.
message UpdateRequest {
// Optional table name
// Optional table name. Defaults to 'default'
string table = 1;
// The id of the record
// The id of the record. If not specified it is inferred from the 'id' field of the record
string id = 2;
// record, JSON object
google.protobuf.Struct record = 3;
@@ -68,7 +68,7 @@ message UpdateResponse {}
// Delete a record in the database by id.
message DeleteRequest {
// Optional table name
// Optional table name. Defaults to 'default'
string table = 1;
// id of the record
string id = 2;
@@ -80,7 +80,7 @@ message DeleteResponse {
// Truncate the records in a table
message TruncateRequest {
// Optional table name
// Optional table name. Defaults to 'default'
string table = 1;
}