Module database_eventdata

Description
Data Types
Function Index
Function Details

Eventdata database functions.

Introduced in: 3 Mar 2006 by Fredrik Thulin <ft@it.su.se>

Authors: Fredrik Thulin (ft@it.su.se).

Description

Eventdata database functions.

Data Types

eventdata()

eventdata() = #eventdata{}

private Mnesia record

transaction_result()

transaction_result() = {atomic, Result} | {aborted, Reason}

The result of a Mnesia transaction. Result is a term().

Function Index

delete_expired/0	Delete all expired eventdata entrys.
delete_using_presentity/1	Delete all entrys for a presentity.
delete_using_presentity_etag/2	Delete all eventdata entrys matching a Presentity and ETag.
fetch_using_presentity/1	Fetch all entrys for a presentity.
fetch_using_presentity_etag/2	Fetch a single record, matching both Presentity and ETag.
insert/6	Create a new entry in the database.
list/0	List all eventdata records in the database.
refresh_presentity_etag/4	Update the expires (and optionally entity_tag) element(s) of a database record.
update/7	Update an existing element that matches Package, Presentity and ETag.

Function Details

delete_expired/0

delete_expired() -> {ok, Num} | error

Num = integer()

Delete all expired eventdata entrys.

delete_using_presentity/1

delete_using_presentity(Presentity) -> transaction_result()

Presentity = {user, User} | {address, AddrStr}

Delete all entrys for a presentity.

delete_using_presentity_etag/2

delete_using_presentity_etag(Presentity, ETag) -> transaction_result()

Presentity = {user, User} | {address, AddrStr}
ETag = term()

Delete all eventdata entrys matching a Presentity and ETag.

fetch_using_presentity/1

fetch_using_presentity(Presentity) -> {ok, List} | nomatch

Presentity = {user, User} | {address, AddrStr}
List = [#evendata_dbe{}]

Fetch all entrys for a presentity.

fetch_using_presentity_etag/2

fetch_using_presentity_etag(Presentity, ETag) -> {ok, Entry} | nomatch

Presentity = {user, User} | {address, AddrStr}
ETag = term()
Entry = #evendata_dbe{}

Fetch a single record, matching both Presentity and ETag.

insert/6

insert(Package::PackageS, Presentity, ETag, Expires, Flags, Data) -> transaction_result()

PackageS = string()
Presentity = {user, User} | {address, AddrStr}
ETag = term()
Expires = integer() | never
Flags = [{Key, Value}]
Data = term()

Create a new entry in the database.

list/0

list() -> [#eventdata{}]

List all eventdata records in the database.

refresh_presentity_etag/4

refresh_presentity_etag(Presentity, ETag, NewExpires, NewETag) -> ok | nomatch | error

Presentity = {user, User} | {address, AddrStr}
ETag = term()
Expires = integer()
Flags = [{Key, Value}]
Data = term()

Update the expires (and optionally entity_tag) element(s) of a database record.

update/7

update(Package, Presentity, ETag, NewETag, Expires, Flags, Data) -> ok | nomatch | error

PackageS = string()
Presentity = {user, User} | {address, AddrStr}
ETag = term()
NewETag = term()
Expires = integer() | never
Flags = [{Key, Value}]
Data = term()

Update an existing element that matches Package, Presentity and ETag.

Generated by EDoc, Oct 17 2007, 16:48:08.