api

Socialist's Database API consists of three sets of roughly equivalent sets of functions. Each set accesses the 'whodb', 'groupdb' or 'profdb', respectively. A fourth, smaller, set of functions perform other tasks.

Before understanding the API, you should probably read the Database Schema design document.

Miscellaneous Functions

Socialist:ClearDB(database)

WhoDB Functions

Socialist:WhoDB_GetRecordByID(id)

Socialist:WhoDB_Query(query,sort,order)

Socialist:WhoDB_Modify(character,zone,info)

Socialist:WhoDB_Remove(id)

GroupDB Functions

Socialist:GroupDB_GetRecordByID(groupid)

Socialist:GroupDB_Query(query)

Socialist:GroupDB_Modify(groupid,info)

Socialist:GroupDB_CreateNewGroup()

Socialist:GroupDB_Remove(groupid)

Socialist:GroupDB_AddPlayer(groupid,id)

Socialist:GroupDB_AddRaidID(groupid,raidid)

Socialist:GroupDB_AddInstance(groupid,instance)

ProfDB Functions

Socialist:ProfDB_GetRecordByID(profid)

Socialist:ProfDB_Query(query,sort,order)

Socialist:ProfDB_Modify(profid,info)

Socialist:ProfDB_Remove(profid)

Socialist:ProfDB_CreateNewRecipe(name,info)

Socialist:ProfDB_AddIngredient(profid,name,amount)

Socialist:ProfDB_AddCrafter(profid,id)


Comments

Posts Quoted:
Reply
Clear All Quotes