Database:Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(OpenSimulator 0.9.x onwards)
(Pre 0.6.9)
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
__NOTOC__
 +
{{Portal_Part|Quicklinks and Translations|
 
{{Quicklinks}}
 
{{Quicklinks}}
 +
}}
  
= Introduction =
+
{{Portal_Part|Introduction|
 
+
 
This page documents the databases tables used in OpenSimulator.
 
This page documents the databases tables used in OpenSimulator.
  
Line 14: Line 16:
  
 
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.
 
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 =
+
{{Portal_Part|Code|
 
There is a common package for database code, OpenSim.Data and each database has its own package (e.g. OpenSim.Data.MySQL).
 
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.
 
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 =
 
= Organization =
 
== OpenSimulator 0.9.x onwards ==
 
== OpenSimulator 0.9.x onwards ==
=== Services ===
 
<table>
 
<tr>
 
  <td>[[avatars]]</td><td>Persistence of the visual appearance of avatars between logins and attached objects</td>
 
</tr>
 
</table>
 
TODO
 
  
== OpenSimulator 0.8.1 onwards ==
+
{| width="100%" cellpadding=10 margin: 10px 10px 10px 10px;
TODO
+
|-
 +
|valign="top" |
 +
{{Portal_Part|Robust|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[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_(database_table)|regions]] - Regions known to the grid
 +
* [[tokens]] - unused
 +
{{Div col end}}
 +
}}
 +
 
 +
|valign="top" width="50%"|
 +
 
 +
{{Portal_Part|Simulator|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[Land_(database_table)|land]] - Parcel Properties
 +
* [[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
 +
* [[Prims_(database_table)|prims]] - All rezzed prim details *except shape and contents*
 +
* [[Database:Primshapes|primshapes]] - Properties of all rezzed prims
 +
* [[regionban]] - Per-Region ban list
 +
* [[Database:regionsettings|regionsettings]]</td><td>Per-Region settings
 +
* [[regionwindlight]] - Windlight region settings
 +
* [[Terrain_(database_table)|terrain]] - Terrain mesh revision history
 +
{{Div col end}}
 +
}}
 +
 
 +
{{Portal_Part|Estates|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[estate groups]] - Narrowly purposed at present. Appears to associate UUIDs under an Estate ID
 +
* [[estate managers]] - Associates avatar UUIDs with Estate ID
 +
* [[estate map]] -  Associates Regions with Estates By Estate ID
 +
* [[estate settings]] - Settings for Estates
 +
* [[estate users]] - Users allowed on the Estate
 +
* [[estateban]] - Users banned from the Estate{{Div col end}}
 +
}}
 +
 
 +
 
 +
|}
 +
 
 
== OpenSimulator 0.7.2 onwards ==
 
== OpenSimulator 0.7.2 onwards ==
  
=== Common ===
+
{{Portal_Part|Code|
<table>
+
Migrations supports automatic upgrade to new database formats.
<tr>
+
 
  <td>migrations</td><td>Supports automatic upgrade to new database formats</td>
+
}}
</tr>
+
{| width="100%" cellpadding=10 margin: 10px 10px 10px 10px;
</table>
+
|-
 +
|valign="top" |
 +
{{Portal_Part|Robust|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[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_(database_table)|regions]] Regions known to the grid
 +
*  tokens table is unused
 +
{{Div col end}}
 +
}}
 +
 
 +
|valign="top" width="50%"|
 +
 
 +
{{Portal_Part|Simulator|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[Land_(database_table)|land]]Parcel Properties
 +
* [[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
 +
* [[Prims_(database_table)|prims]]All rezzed prim details *except shape and contents*
 +
* [[Database:Primshapes|primshapes]]Properties of all rezzed prims
 +
* regionban Per-Region ban list
 +
* [[Database:regionsettings|regionsettings]]Per-Region settings
 +
* regionwindlightWindlight region settings
 +
* [[Terrain_(database_table)|terrain]]Terrain mesh revision history
 +
 
 +
{{Div col end}}
 +
}}
 +
 
 +
{{Portal_Part|Estates|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[estate groups]]Narrowly purposed at present. Appears to associate UUIDs under an Estate ID
 +
* [[estate managers]]Associates avatar UUIDs with Estate ID
 +
* [[estate map]]<br />Associates Regions with Estates By Estate ID
 +
* [[estate settings]]Settings for Estates
 +
* [[estate users]]Users allowed on the Estate
 +
* [[estateban]]Users banned from the Estate
 +
}}
 +
 
 +
 
 +
|}
  
=== Services ===
+
== Pre 0.6.9 ==
<table>
+
{{Portal_Part|Code|This mainly pertains to OpenSimulator 0.6.9.}}
<tr>
+
{| width="100%" cellpadding=10 margin: 10px 10px 10px 10px;
  <td>[[Avatars]]</td><td>Persistence of the visual appearance of avatars between logins and attached objects</td>
+
|-
</tr>
+
|valign="top" |
<tr>
+
{{Portal_Part|Robust|
  <td>[[Friends]]</td><td>A list of an avatars friends, friendship requests, and permissions granted to friends</td>
+
{{Div col|colwidth=12em|rules=yes|gap=1em}}
</tr>
+
*[[agents]]Records agent (Avatar/User) login details
<tr>
+
*[[assets]]Comprehensive grid assets including textures and avatar inventories
  <td>[[GridUser]]</td><td>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</td>
+
*[[avatarappearance]]Persistence of the visual appearance of avatars between logins
</tr>
+
*[[avatarattachments]]Items attached to avatars
<tr>
+
*[[inventoryfolders]]Inventory folder-related details *except contents*, Contents are in the [[inventoryitems]] table and point back to
  <td>[[Presence]]</td>
+
*[[inventoryitems]]All inventory item details (including folder associations) except contents are referenced in the [[assets]] table
  <td>Region and session information for currently logged in users.  Used for IM routing amongst other things.</td>
+
*[[migrations]]Supports 'automagic' migration to new database formats
</tr>
+
*[[Regions_(database_table)|regions]]Regions known to the grid
<tr>
+
*[[userfriends]]Friends list registration
  <td>[[UserAccounts]]</td><td>User account information, such as name, user level and e-mail. Just local accounts.</td>
+
*[[users]]Stored user profiles
</tr>
+
{{Div col end}}
<tr>
+
}}
  <td>[[assets]]</td><td>Grid assets including such things as textures and sounds</td>
+
</tr>
+
<tr>
+
  <td>[[auth]]</td><td>User authentication information</td>
+
</tr>
+
<tr>
+
  <td>[[inventoryfolders]]</td><td>Inventory folder-related details *except contents*</td>
+
</tr>
+
<tr>
+
  <td>&nbsp;</td><td>Contents are in the [[inventoryitems]] table and point back to [[inventoryfolders]]</td>
+
</tr>
+
<tr>
+
  <td>[[inventoryitems]]</td><td>All inventory item details (including folder associations) except contents - contents are referenced in the [[assets]] table</td>
+
</tr>
+
<tr>
+
  <td>[[Regions_(database_table)|regions]]<br /></td><td>Regions known to the grid</td>
+
</tr>
+
<tr>
+
  <td>tokens</td><td>Unused.</td>
+
</tr>
+
</table>
+
  
=== Simulator ===
+
|valign="top" width="50%"|
<table>
+
<tr>
+
<td>[[estate groups]]</td><td>Narrowly purposed at present. Appears to associate UUIDs under an Estate ID</td>
+
</tr>
+
<tr>
+
<td>[[estate managers]]</td><td>Associates UUIDs with Estate ID</td>
+
</tr>
+
<tr>
+
<td>[[estate map]]<br /><td>Associates Regions with Estates By Estate ID</td>
+
</tr>
+
<tr>
+
<td>[[estate settings]]</td><td>Settings for Estates</td>
+
</tr>
+
<tr>
+
<td>[[estate users]]</td><td>Users allowed on the Estate</td>
+
</tr>
+
<tr>
+
<td>[[estateban]]</td><td>Users banned from the Estate</td>
+
</tr>
+
<tr>
+
<td>[[Land_(database_table)|land]]</td><td>Parcel Properties</td>
+
</tr>
+
<tr>
+
<td>[[landaccesslist]]</td><td>Parcel Access List</td>
+
</tr>
+
<tr>
+
<td>[[primitems]]</td><td>Contains the prim's inventory, which is not at all unlike the avatars'<br />inventory with the exception of folders</td>
+
</tr>
+
<tr>
+
<td>[[Prims_(database_table)|prims]]</td><td>All rezzed prim details *except shape and contents*</td>
+
</tr>
+
<tr>
+
<td>[[Database:Primshapes|primshapes]]</td><td>Properties of all rezzed prims</td>
+
</tr>
+
<tr>
+
<td>regionban</td><td>Per-Region ban list</td>
+
</tr>
+
<tr>
+
<td>[[Database:regionsettings|regionsettings]]</td><td>Per-Region settings</td>
+
</tr>
+
<tr>
+
<td>regionwindlight</td><td>Windlight region settings</td>
+
</tr>
+
<tr>
+
<td>[[Terrain_(database_table)|terrain]]</td><td>Terrain mesh revision history</td>
+
</tr>
+
</table>
+
  
== Older information ==
+
{{Portal_Part|Simulator|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[land]]Parcel Properties
 +
* [[landaccesslist]]Parcel Access List
 +
* [[migrations]]Supports 'automagic' upgrade to new database formats
 +
* [[primitems]]Contains the prim's inventory, which is not at all unlike the avatars inventory with the exception of folders
 +
* [[Prims_(database_table)|prims]]All rezzed prim details *except shape and contents*
 +
* [[Database:Primshapes|primshapes]]Properties of all rezzed prims
 +
* [[regionban]]Per-Region ban list
 +
* [[regionsettings]]Per-Region settings
 +
* [[terrain]]Terrain mesh revision history
 +
{{Div col end}}
 +
}}
  
This mainly pertains to OpenSimulator 0.6.9.
+
{{Portal_Part|Estates|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[estate groups]]Narrowly purposed at present. Appears to associate UUIDs under an Estate ID
 +
* [[estate managers]]Associates UUIDs with Estate ID
 +
* [[estate map]]Associates Regions with Estates By Estate ID
 +
* [[estate settings]]Settings for Estates
 +
* [[estate users]]Users allowed on the Estate
 +
* [[estateban]]Users banned from the Estate
 +
}}
  
<table>
 
<tr>
 
<td colspan="2">'''Services:'''</td>
 
<tr>
 
<td colspan="2">&nbsp;</td>
 
</tr>
 
<tr>
 
<td>[[agents]]</td><td>Records agent (Avatar/User) login details</td>
 
<tr>
 
<td>[[assets]]</td><td>Comprehensive grid assets including textures and avatar inventories</td>
 
</tr>
 
<tr>
 
<td>[[avatarappearance]]</td><td>Persistence of the visual appearance of avatars between logins</td>
 
</tr>
 
<tr>
 
<td>[[avatarattachments]]</td><td>Items attached to avatars</td>
 
</tr>
 
<tr>
 
<td>[[inventoryfolders]]</td><td>Inventory folder-related details *except contents*</td>
 
</tr>
 
<tr>
 
<td>&nbsp;</td><td>Contents are in the [[inventoryitems]] table and point back to [[inventoryfolders]]</td>
 
</tr>
 
<tr>
 
<td>[[inventoryitems]]</td><td>All inventory item details (including folder associations) except contents</td>
 
</tr>
 
<tr>
 
<td>&nbsp;</td><td>Contents are referenced in the [[assets]] table</td>
 
</tr>
 
<tr>
 
<td>[[migrations]]</td><td>Supports 'automagic' migration to new database formats</td>
 
</tr>
 
<tr>
 
<td>[[Regions_(database_table)|regions]]</td><td>Regions known to the grid</td>
 
</tr>
 
<tr>
 
<td>[[userfriends]]</td><td>Friends list registration</td>
 
</tr>
 
<tr>
 
<td>[[users]]</td><td>Stored user profile</td>
 
</tr>
 
</table>
 
<br />
 
<br />
 
  
<table>
+
|}
<tr>
+
<td colspan="2">'''Simulator:'''</td>
+
<tr>
+
<td colspan="2">&nbsp;</td>
+
</tr>
+
<tr>
+
<td>[[estate groups]]</td><td>Narrowly purposed at present. Appears to associate UUIDs under an Estate ID</td>
+
</tr>
+
<tr>
+
<td>[[estate managers]]</td><td>Associates UUIDs with Estate ID</td>
+
</tr>
+
<tr>
+
<td>[[estate map]]</td><td>Associates Regions with Estates By Estate ID</td>
+
</tr>
+
<tr>
+
<td>[[estate settings]]</td><td>Settings for Estates</td>
+
</tr>
+
<tr>
+
<td>[[estate users]]</td><td>Users allowed on the Estate</td>
+
</tr>
+
<tr>
+
<td>[[estateban]]</td><td>Users banned from the Estate</td>
+
</tr>
+
<tr>
+
<td>[[land]]</td><td>Parcel Properties</td>
+
</tr>
+
<tr>
+
<td>[[landaccesslist]]</td><td>Parcel Access List</td>
+
</tr>
+
<tr>
+
<td>[[migrations]]</td><td>Supports 'automagic' upgrade to new database formats</td>
+
</tr>
+
<tr>
+
<td>[[primitems]]</td><td>Contains the prim's inventory, which is not at all unlike the avatars</td>
+
</tr>
+
<tr>
+
<td>&nbsp;</td><td>inventory with the exception of folders</td>
+
</tr>
+
<tr>
+
<td>[[Prims_(database_table)|prims]]</td><td>All rezzed prim details *except shape and contents*</td>
+
</tr>
+
<tr>
+
<td>[[Database:Primshapes|primshapes]]</td><td>Properties of all rezzed prims</td>
+
</tr>
+
<tr>
+
<td>[[regionban]]</td><td>Per-Region ban list</td>
+
</tr>
+
<tr>
+
<td>[[regionsettings]]</td><td>Per-Region settings</td>
+
</tr>
+
<tr>
+
<td>[[terrain]]</td><td>Terrain mesh revision history</td>
+
</tr>
+
</table>
+
  
 
[[Category:Database]]
 
[[Category:Database]]

Revision as of 08:10, 26 April 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</td><td>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
  • AvatarsPersistence of the visual appearance of avatars between logins and attached objects
  • FriendsA list of an avatars friends, friendship requests, and permissions granted to friends
  • GridUserInformation 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.
  • UserAccountsUser account information, such as name, user level and e-mail. Just local accounts.
  • assetsGrid assets including such things as textures and sounds
  • authUser authentication information
  • inventoryfoldersInventory 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
  • landParcel Properties
  • landaccesslistParcel Access List
  • 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
  • regionban Per-Region ban list
  • regionsettingsPer-Region settings
  • regionwindlightWindlight region settings
  • terrainTerrain 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