Database:Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (OpenSimulator 0.9.x onwards: remove </td><td>)
m (OpenSimulator 0.7.2 onwards: Add missing spaces)
Line 85: Line 85:
 
{{Portal_Part|Robust|
 
{{Portal_Part|Robust|
 
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 
{{Div col|colwidth=12em|rules=yes|gap=1em}}
* [[Avatars]]Persistence of the visual appearance of avatars between logins and attached objects
+
* [[Avatars]] Persistence of the visual appearance of avatars between logins and attached objects
* [[Friends]]A list of an avatars friends, friendship requests, and permissions granted to friends
+
* [[Friends]] A list of an avatars friends, friendship requests, and permissions granted to friends
* [[GridUser]]Information about a user in this particular grid, for everyone who uses the grid, local and foreign. This includes their home region, last region, online status and last login/logout.  This is distinct from auth information
+
* [[GridUser]] Information about a user in this particular grid, for everyone who uses the grid, local and foreign. This includes their home region, last region, online status and last login/logout.  This is distinct from auth information
 
* [[Presence]] - Region and session information for currently logged in users.  Used for IM routing amongst other things.
 
* [[Presence]] - Region and session information for currently logged in users.  Used for IM routing amongst other things.
* [[UserAccounts]]User account information, such as name, user level and e-mail. Just local accounts.
+
* [[UserAccounts]] User account information, such as name, user level and e-mail. Just local accounts.
* [[assets]]Grid assets including such things as textures and sounds
+
* [[assets]] Grid assets including such things as textures and sounds
* [[auth]]User authentication information
+
* [[auth]] User authentication information
* [[inventoryfolders]]Inventory folder-related details *except contents*
+
* [[inventoryfolders]] Inventory folder-related details *except contents*
 
* [[inventoryitems]] holds actual content and points back to * [[inventoryfolders]]
 
* [[inventoryitems]] holds actual content and points back to * [[inventoryfolders]]
 
* [[inventoryitems]] All inventory item details (including folder associations) except contents - contents are referenced in the * [[assets]] table* * * [[Regions_(database_table)|regions]] Regions known to the grid
 
* [[inventoryitems]] All inventory item details (including folder associations) except contents - contents are referenced in the * [[assets]] table* * * [[Regions_(database_table)|regions]] Regions known to the grid
Line 103: Line 103:
 
{{Portal_Part|Simulator|
 
{{Portal_Part|Simulator|
 
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 
{{Div col|colwidth=12em|rules=yes|gap=1em}}
* [[Land_(database_table)|land]]Parcel Properties
+
* [[Land_(database_table)|land]] Parcel Properties
* [[landaccesslist]]Parcel Access List
+
* [[landaccesslist]] Parcel Access List
* [[primitems]]Contains the prim's inventory, which is not at all unlike the avatars'<br />inventory with the exception of folders
+
* [[primitems]] Contains the prim's inventory, which is not at all unlike the avatars'<br />inventory with the exception of folders
* [[Prims_(database_table)|prims]]All rezzed prim details *except shape and contents*
+
* [[Prims_(database_table)|prims]] All rezzed prim details *except shape and contents*
* [[Database:Primshapes|primshapes]]Properties of all rezzed prims
+
* [[Database:Primshapes|primshapes]] Properties of all rezzed prims
 
* regionban Per-Region ban list
 
* regionban Per-Region ban list
* [[Database:regionsettings|regionsettings]]Per-Region settings
+
* [[Database:regionsettings|regionsettings]] Per-Region settings
 
* regionwindlightWindlight region settings
 
* regionwindlightWindlight region settings
* [[Terrain_(database_table)|terrain]]Terrain mesh revision history
+
* [[Terrain_(database_table)|terrain]] Terrain mesh revision history
  
 
{{Div col end}}
 
{{Div col end}}

Revision as of 12:11, 17 November 2019

Quicklinks and Translations
Introduction

This page documents the databases tables used in OpenSimulator.

Tables are split up into Common, Services and Simulator.

On a grid, the grid services will contain the Services and Common tables, whilst each simulator instance will access the Simulator tables.

A standalone will contain Common, Services and Simulator tables, with the exception of the regions table, which is not currently persisted for standalones.

SQLite is generally not considered appropriate for this use case and will not be covered here; however the table structures are very similar and most of what is here will be useful in that context as well.

Note that some of these tables may be relics, some may be planned for future use, and some may see heavy use but have columns which are relics, not yet properly updated or not yet used at all.

Code

There is a common package for database code, OpenSim.Data and each database has its own package (e.g. OpenSim.Data.MySQL).

Each database package has to supply implementations for the interfaces in OpenSim.Data. For instance, IAssetData is the asset interface, used by OpenSimulator to store and retrieve asset data.

Organization

OpenSimulator 0.9.x onwards

Robust
  • Avatars - Persistence of the visual appearance of avatars between logins and attached objects
  • Friends - A list of an avatars friends, friendship requests, and permissions granted to friends
  • GridUser - Information about a user in this particular grid, for everyone who uses the grid, local and foreign. This includes their home region, last region, online status and last login/logout. This is distinct from auth information
  • Presence - Region and session information for currently logged in users. Used for IM routing amongst other things.
  • UserAccounts - User account information, such as name, user level and e-mail. Just local accounts.
  • assets - Grid assets including such things as textures and sounds
  • auth - User authentication information
  • inventoryfolders - Inventory folder-related details except for the contents
  • inventoryitems - points back to inventoryfolders
  • inventoryitems - All inventory item details (including folder associations) except contents - contents are referenced in the assets table
  • regions - Regions known to the grid
  • tokens - unused
Simulator
  • land - Parcel Properties
  • landaccesslist - Parcel Access List
  • primitems - Contains the prim's inventory, which is not at all unlike the avatars'
    inventory with the exception of folders
  • prims - All rezzed prim details *except shape and contents*
  • primshapes - Properties of all rezzed prims
  • regionban - Per-Region ban list
  • regionsettings Per-Region settings
  • regionwindlight - Windlight region settings
  • terrain - Terrain mesh revision history
Estates


OpenSimulator 0.7.2 onwards

Code

Migrations supports automatic upgrade to new database formats.

Robust
  • Avatars Persistence of the visual appearance of avatars between logins and attached objects
  • Friends A list of an avatars friends, friendship requests, and permissions granted to friends
  • GridUser Information about a user in this particular grid, for everyone who uses the grid, local and foreign. This includes their home region, last region, online status and last login/logout. This is distinct from auth information
  • Presence - Region and session information for currently logged in users. Used for IM routing amongst other things.
  • UserAccounts User account information, such as name, user level and e-mail. Just local accounts.
  • assets Grid assets including such things as textures and sounds
  • auth User authentication information
  • inventoryfolders Inventory folder-related details *except contents*
  • inventoryitems holds actual content and points back to * inventoryfolders
  • inventoryitems All inventory item details (including folder associations) except contents - contents are referenced in the * assets table* * * regions Regions known to the grid
  • tokens table is unused
Simulator
  • land Parcel Properties
  • landaccesslist Parcel Access List
  • primitems Contains the prim's inventory, which is not at all unlike the avatars'
    inventory with the exception of folders
  • prims All rezzed prim details *except shape and contents*
  • primshapes Properties of all rezzed prims
  • regionban Per-Region ban list
  • regionsettings Per-Region settings
  • regionwindlightWindlight region settings
  • terrain Terrain mesh revision history
Estates


Pre 0.6.9

Code
This mainly pertains to OpenSimulator 0.6.9.
Robust
  • agentsRecords agent (Avatar/User) login details
  • assetsComprehensive grid assets including textures and avatar inventories
  • avatarappearancePersistence of the visual appearance of avatars between logins
  • avatarattachmentsItems attached to avatars
  • inventoryfoldersInventory folder-related details *except contents*, Contents are in the inventoryitems table and point back to
  • inventoryitemsAll inventory item details (including folder associations) except contents are referenced in the assets table
  • migrationsSupports 'automagic' migration to new database formats
  • regionsRegions known to the grid
  • userfriendsFriends list registration
  • usersStored user profiles
Simulator
  • landParcel Properties
  • landaccesslistParcel Access List
  • migrationsSupports 'automagic' upgrade to new database formats
  • primitemsContains the prim's inventory, which is not at all unlike the avatars inventory with the exception of folders
  • primsAll rezzed prim details *except shape and contents*
  • primshapesProperties of all rezzed prims
  • regionbanPer-Region ban list
  • regionsettingsPer-Region settings
  • terrainTerrain mesh revision history
Estates


Personal tools
General
For Administrators
For Developers
For Creators
For Grid Users
About This Wiki
Tools