annotate mod_data_access.wiki @ 241:c6f01319f4c3

Add page about mod_data_access
author Kim Alvefur <zash@zash.se>
date Wed, 07 Dec 2011 18:13:12 +0100
parents
children 963ae0ff05b0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
241
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 #summary HTTP access to prosody’s storage mechanism
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 = Introduction =
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 This module gives HTTP access to prosodys storage mechanism. It uses normal HTTP verbs and [http://tools.ietf.org/html/rfc2617 Basic HTTP authentication], so you could call it RESTful if you like buzzwords.
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 = Syntax =
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 To Fetch data, issue a normal GET request
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 {{{
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 GET /data[/<host>/<user>]/<store>[/<format>] HTTP/1.1
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 Authorization: <base64(authzid:password)>
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 [Host: <host>]
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 -- OR --
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 PUT|POST /data[/<host>/<user>]/<store>[/<format>] HTTP/1.1
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18 Content-Type: text/x-lua | application/json
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 <data>
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 }}}
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23 These map to `datamanager.method(user, host, store, data)`, where choice of `method` and its parameters are explained below.
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 == Verbs ==
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
26
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
27 ||*Verb*||*Meaning* ||*datamanager method* ||
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
28 ||`GET` || Just fetch data || `load()` or `list_load()` ||
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
29 ||`PUT` || Replace all data in the store || `store() ||
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
30 ||`POST`|| Append item to the store || `list_append()` ||
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
31
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
32 Note: In a `GET` request, if `load()` returns `nil`, `list_load()` will be tried instead.
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
34 == Fields ==
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
35
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
36 ||*Field*||*Description*||*Default*||
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37 ||`host`||Which virtual host to access||Required. If not set in the path, the `Host` header is used. If that's not set either, the domain-part of the authzid is used.||
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
38 ||`user`||Which users storage to access||Required. If not set in the path, uses the node part of the authzid.||
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
39 ||`store`||Which storage to access.||Required.||
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40 ||`format`||Which format to serialize to. `json` and `lua` are supported. When uploading data, the `Content-Type` header is used.||`json`||
c6f01319f4c3 Add page about mod_data_access
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41 ||`data`||The actual data to upload in a `PUT` or `POST` request.||`nil`||