Database:Documentation
From OpenSimulator
(Difference between revisions)
HomerHorwitz (Talk | contribs) (added reference to 'users' table) |
|||
| (74 intermediate revisions by 12 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{Quicklinks|Database_Documentation}} | |
| − | + | {{Portal_Part|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. | |
| − | + | }} | |
| − | + | {{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). | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | 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 == | |
| − | + | ||
| − | + | {| width="100%" cellpadding=10 margin: 10px 10px 10px 10px; | |
| + | |- | ||
| + | |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]] - All inventory item details (including folder associations to [[inventoryfolders]]) 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]] 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 == | ||
| + | |||
| + | {{Portal_Part|Code| | ||
| + | Migrations supports automatic upgrade to new database formats. | ||
| + | |||
| + | }} | ||
| + | {| width="100%" cellpadding=10 margin: 10px 10px 10px 10px; | ||
| + | |- | ||
| + | |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 | ||
| + | * 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 | ||
| + | }} | ||
| + | |||
| + | |} | ||
| + | |||
| + | == Pre 0.6.9 == | ||
| + | {{Portal_Part|Code|This mainly pertains to OpenSimulator 0.6.9.}} | ||
| + | {| width="100%" cellpadding=10 margin: 10px 10px 10px 10px; | ||
| + | |- | ||
| + | |valign="top" | | ||
| + | {{Portal_Part|Robust| | ||
| + | {{Div col|colwidth=12em|rules=yes|gap=1em}} | ||
| + | *[[agents]] Records agent (Avatar/User) login details | ||
| + | *[[assets]] Comprehensive grid assets including textures and avatar inventories | ||
| + | *[[avatarappearance]] Persistence of the visual appearance of avatars between logins | ||
| + | *[[avatarattachments]] Items attached to avatars | ||
| + | *[[inventoryfolders]] Inventory folder-related details *except contents*, Contents are in the [[inventoryitems]] table and point back to | ||
| + | *[[inventoryitems]] All inventory item details (including folder associations) except contents are referenced in the [[assets]] table | ||
| + | *[[migrations]] Supports 'automagic' migration to new database formats | ||
| + | *[[Regions_(database_table)|regions]] Regions known to the grid | ||
| + | *[[userfriends]] Friends list registration | ||
| + | *[[users]] Stored user profiles | ||
| + | {{Div col end}} | ||
| + | }} | ||
| + | |||
| + | |valign="top" width="50%"| | ||
| + | |||
| + | {{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}} | ||
| + | }} | ||
| + | |||
| + | {{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 | ||
| + | }} | ||
| + | |||
| + | |} | ||
| + | |||
| + | [[Category:Database]] | ||
Latest revision as of 04:20, 4 December 2023
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.
Contents |
[edit] Organization
[edit] OpenSimulator 0.9.x onwards
|
Robust
|
Simulator
Estates
|
[edit] OpenSimulator 0.7.2 onwards
Code
Migrations supports automatic upgrade to new database formats.
|
Robust
|
Simulator
Estates
|
[edit] Pre 0.6.9
Code
This mainly pertains to OpenSimulator 0.6.9.
|
Robust
|
Simulator
Estates
|
