OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Properties | List of all members
OpenSim.Data.MySQL.MySQLInventoryData Class Reference

A MySQL interface for the inventory server More...

Inheritance diagram for OpenSim.Data.MySQL.MySQLInventoryData:
Inheritance graph
[legend]
Collaboration diagram for OpenSim.Data.MySQL.MySQLInventoryData:
Collaboration graph
[legend]

Public Member Functions

void Initialise ()
 Default-initialises the plugin More...
 
void Initialise (string connect)
 
void Dispose ()
 Closes this DB provider More...
 
List< InventoryItemBasegetInventoryInFolder (UUID folderID)
 Returns a list of items in a specified folder More...
 
List< InventoryFolderBasegetUserRootFolders (UUID user)
 Returns a list of the root folders within a users inventory More...
 
InventoryFolderBase getUserRootFolder (UUID user)
 see InventoryItemBase.getUserRootFolder More...
 
List< InventoryFolderBasegetInventoryFolders (UUID parentID)
 Return a list of folders in a users inventory contained within the specified folder. This method is only used in tests - in normal operation the user always have one, and only one, root folder. More...
 
InventoryItemBase getInventoryItem (UUID itemID)
 Returns a specified inventory item More...
 
InventoryFolderBase getInventoryFolder (UUID folderID)
 Returns a specified inventory folder More...
 
void addInventoryItem (InventoryItemBase item)
 Adds a specified item to the database More...
 
void updateInventoryItem (InventoryItemBase item)
 Updates the specified inventory item More...
 
void deleteInventoryItem (UUID itemID)
 Detele the specified inventory item More...
 
InventoryItemBase queryInventoryItem (UUID itemID)
 
InventoryFolderBase queryInventoryFolder (UUID folderID)
 
void addInventoryFolder (InventoryFolderBase folder)
 Creates a new inventory folder More...
 
void updateInventoryFolder (InventoryFolderBase folder)
 Updates an inventory folder More...
 
void moveInventoryFolder (InventoryFolderBase folder)
 Move an inventory folder More...
 
List< InventoryFolderBasegetFolderHierarchy (UUID parentID)
 See IInventoryDataPlugin More...
 
void deleteInventoryFolder (UUID folderID)
 Deletes an inventory folder More...
 
List< InventoryItemBasefetchActiveGestures (UUID avatarID)
 Returns all activated gesture-items in the inventory of the specified avatar. More...
 

Protected Member Functions

void getInventoryFolders (ref List< InventoryFolderBase > folders, UUID parentID)
 Append a list of all the child folders of a parent folder More...
 
void deleteOneFolder (UUID folderID)
 Delete a folder from database More...
 
void deleteItemsInFolder (UUID folderID)
 Delete all item in a folder More...
 

Static Protected Member Functions

static InventoryFolderBase readInventoryFolder (MySqlDataReader reader)
 Reads a list of inventory folders returned by a query. More...
 

Properties

string Version [get]
 
string Name [get]
 The name of this DB provider More...
 
- Properties inherited from OpenSim.Framework.IPlugin
string Version [get]
 Returns the plugin version More...
 
string Name [get]
 Returns the plugin name More...
 

Detailed Description

A MySQL interface for the inventory server

Definition at line 42 of file MySQLInventoryData.cs.

Member Function Documentation

void OpenSim.Data.MySQL.MySQLInventoryData.addInventoryFolder ( InventoryFolderBase  folder)
inline

Creates a new inventory folder

Parameters
folderFolder to create

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 565 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.addInventoryItem ( InventoryItemBase  item)
inline

Adds a specified item to the database

Parameters
itemThe inventory item

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 437 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.deleteInventoryFolder ( UUID  folderID)
inline

Deletes an inventory folder

Parameters
folderIdId of folder to delete

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 848 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.deleteInventoryItem ( UUID  itemID)
inline

Detele the specified inventory item

Parameters
itemThe inventory item UUID to delete

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 528 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.deleteItemsInFolder ( UUID  folderID)
inlineprotected

Delete all item in a folder

Parameters
folderIDthe folder UUID

Definition at line 821 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.deleteOneFolder ( UUID  folderID)
inlineprotected

Delete a folder from database

Parameters
folderIDthe folder UUID

Definition at line 793 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.Dispose ( )
inline

Closes this DB provider

do nothing

Definition at line 97 of file MySQLInventoryData.cs.

List<InventoryItemBase> OpenSim.Data.MySQL.MySQLInventoryData.fetchActiveGestures ( UUID  avatarID)
inline

Returns all activated gesture-items in the inventory of the specified avatar.

Parameters
avatarIDThe UUID of the avatar
Returns
The list of gestures (InventoryItemBases)

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 864 of file MySQLInventoryData.cs.

List<InventoryFolderBase> OpenSim.Data.MySQL.MySQLInventoryData.getFolderHierarchy ( UUID  parentID)
inline

See IInventoryDataPlugin

Parameters
parentID
Returns

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 668 of file MySQLInventoryData.cs.

InventoryFolderBase OpenSim.Data.MySQL.MySQLInventoryData.getInventoryFolder ( UUID  folderID)
inline

Returns a specified inventory folder

Parameters
folderIDThe folder to return
Returns
A folder class

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 400 of file MySQLInventoryData.cs.

List<InventoryFolderBase> OpenSim.Data.MySQL.MySQLInventoryData.getInventoryFolders ( UUID  parentID)
inline

Return a list of folders in a users inventory contained within the specified folder. This method is only used in tests - in normal operation the user always have one, and only one, root folder.

Parameters
parentIDThe folder to search
Returns
A list of inventory folders

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 244 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.getInventoryFolders ( ref List< InventoryFolderBase folders,
UUID  parentID 
)
inlineprotected

Append a list of all the child folders of a parent folder

Parameters
folderslist where folders will be appended
parentIDID of parent

Definition at line 654 of file MySQLInventoryData.cs.

List<InventoryItemBase> OpenSim.Data.MySQL.MySQLInventoryData.getInventoryInFolder ( UUID  folderID)
inline

Returns a list of items in a specified folder

Parameters
folderIDThe folder to search
Returns
A list containing inventory items

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 107 of file MySQLInventoryData.cs.

InventoryItemBase OpenSim.Data.MySQL.MySQLInventoryData.getInventoryItem ( UUID  itemID)
inline

Returns a specified inventory item

Parameters
itemThe item to return
Returns
An inventory item

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 335 of file MySQLInventoryData.cs.

InventoryFolderBase OpenSim.Data.MySQL.MySQLInventoryData.getUserRootFolder ( UUID  user)
inline

see InventoryItemBase.getUserRootFolder

Parameters
userThe user UUID
Returns

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 192 of file MySQLInventoryData.cs.

List<InventoryFolderBase> OpenSim.Data.MySQL.MySQLInventoryData.getUserRootFolders ( UUID  user)
inline

Returns a list of the root folders within a users inventory

Parameters
userThe user whose inventory is to be searched
Returns
A list of folder objects

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 151 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.Initialise ( )
inline

Default-initialises the plugin

Implements OpenSim.Framework.IPlugin.

Definition at line 52 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.Initialise ( string  connect)
inline

Initialises Inventory interface

  • Loads and initialises the MySQL storage plugin
  • warns and uses the obsolete mysql_connection.ini if connect string is empty.
  • Check for migration
Parameters
connectconnect string

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 69 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.moveInventoryFolder ( InventoryFolderBase  folder)
inline

Move an inventory folder

Parameters
folderFolder to move

UPDATE inventoryfolders SET parentFolderID=?parentFolderID WHERE folderID=?folderID

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 620 of file MySQLInventoryData.cs.

InventoryFolderBase OpenSim.Data.MySQL.MySQLInventoryData.queryInventoryFolder ( UUID  folder)
inline

Parameters
item

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 556 of file MySQLInventoryData.cs.

InventoryItemBase OpenSim.Data.MySQL.MySQLInventoryData.queryInventoryItem ( UUID  item)
inline

Parameters
item

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 551 of file MySQLInventoryData.cs.

static InventoryFolderBase OpenSim.Data.MySQL.MySQLInventoryData.readInventoryFolder ( MySqlDataReader  reader)
inlinestaticprotected

Reads a list of inventory folders returned by a query.

Parameters
readerA MySQL Data Reader
Returns
A List containing inventory folders

Definition at line 373 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.updateInventoryFolder ( InventoryFolderBase  folder)
inline

Updates an inventory folder

Parameters
folderFolder to update

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 610 of file MySQLInventoryData.cs.

void OpenSim.Data.MySQL.MySQLInventoryData.updateInventoryItem ( InventoryItemBase  item)
inline

Updates the specified inventory item

Parameters
itemInventory item to update

Implements OpenSim.Data.IInventoryDataPlugin.

Definition at line 519 of file MySQLInventoryData.cs.

Property Documentation

string OpenSim.Data.MySQL.MySQLInventoryData.Name
get

The name of this DB provider

Returns
Name of DB provider

Definition at line 89 of file MySQLInventoryData.cs.

string OpenSim.Data.MySQL.MySQLInventoryData.Version
get

Definition at line 50 of file MySQLInventoryData.cs.


The documentation for this class was generated from the following file: