julienlavocat / kvdb Goto Github PK

KVDB is a database, accessible via a REST interface or websockets. Data are are stored on disk, with key-value mapped datas. Thoses key-value pairs are stored inside of tables.

GET /tables/:tableName/
    Show table informations (content).
    
GET /tables/:tableName/get/:key
	Show the value associated with key in table.

GET /tables/:tableName/put/?key={key}&value={value}
	Put the key-value pair in table. Returns if the value already exists.

GET /tables/:tableName/exist/:key
	Return true if the requested key exist.

GET /tables/:tableName/delete/:key
	Delete the key-value pair if it exist, return true if it deleted the key.

GET /tables/:tableName/clear
	Clear all the content of the table.

GET /tables/:tableName/size
	Return the number of key-value pair in table.

In KVDB, security is based on tokens. For each tables, a Json Web Token (JWT) is generated. This token must be provided in each request to the database as a query-parameter called "token" like this :

GET /tables/:tableName/clear?token={token}

You can get a token (for testing purposes) using the following endpoint :

GET /token?user={userid}&table={tableName}

User ID must be registered in the users.json file before any usage !

In order to access datas of a table, you can use REST endpoints or Websocket. WebSocket is accessible via the following address:

ws://{ip}/tables/:tableName

To succesfully connect to the server, you need to provide the authentication token in query-parameter like this:

ws://{ip}/tables/:tableName?token={token}

Once authentication is done, the database return you the user id, this id must be sent in every request you will do later on.

From here, you can make every request you want on the table. WebSocket request are sent under the format of a string, each argument separated using this separator: §*/:

Here is a list of all the possible request and their parameters:

SHOW TABLE - show§*/:{user_id}

PUT - put§*/:{user_id}§*/:{key}§*/:{value}

GET - get§*/:{user_id}§*/:{key}

EXIST - exist§*/:{user_id}§*/:{key}

SIZE - size§*/:{user_id}

DELETE - delete§*/:{user_id}§*/:{key}

CLEAR - clear§*/:{user_id}