Permalink
Browse files

documented options

  • Loading branch information...
mrjjwright committed Mar 17, 2010
1 parent 006f06a commit 66f14e7e253506f84e6a9cd8897664bd5f766461
Showing with 4 additions and 3 deletions.
  1. +4 −3 README.md
View
@@ -98,13 +98,12 @@ You can start nosqlite in web mode by executing
where db is an instance of NoSQLite obtained via the `connect` method. This only works with NoSQLite running in node and will cause node to start a simple node based http server to service requests. The port and host are optional. The port defaults to 5000 and host defaults to "127.0.0.1".
-Here is how to use the web API.
-
-The API only reads query params and the HTTP post body so you can map it to any url you want to.
Global Query Params
-----------------------
+The API only reads query params and the HTTP post body so you can map it to any url you want to. But you should pass these URL params:
+
* __table__ - The table name in SQLite. The NoSQLite API is oriented around one table per object, so you will always be dealing with one table.
* __method__ - The method on NoSQLite to call. One of `find`, `save`, or `find_or_save_all``.
@@ -113,6 +112,8 @@ Global Query Params
Web API Methods
-----------------------
+Here are the different methods supported:
+
* __save__ - `?table=foo&method=save` - Pass the record to be saved as JSON in the body. Returns back either a string "success" or an error message.
* __find__ - `?table=foo&method=find` - Pass the predicate as a JSON string in the body. Returns back either an array of found results in JSON format.
* __find_or_save__ - `?table=foo&method=find_or_save` - Pass an array with 2 elements. The first is the predicate, and the second the obj or objects to save if not found. Returns back either an array of found results in JSON format or the string "success".

0 comments on commit 66f14e7

Please sign in to comment.