Regions (database table)

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
m (Minor formatting changes to match other database documentation pages)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 
{{Quicklinks}}
 
{{Quicklinks}}
<br />
 
  
The '''regions''' table contains information concerning all the regions currently connected to the grid.&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(back to [[Database Documentation]])
+
 
 +
The '''regions''' table contains information concerning all the regions currently connected to the grid.      (back to [[Database Documentation]])
  
 
== regions Table Structure ==
 
== regions Table Structure ==
  
 
The structure of the regions table is as follows:
 
The structure of the regions table is as follows:
<br />
+
 
  
 
{| style="border:1px solid #ccc;"
 
{| style="border:1px solid #ccc;"
Line 19: Line 19:
 
! Extra
 
! Extra
 
|-  
 
|-  
| uuid || varchar(36) || NO || PRI || NULL || &nbsp;
+
| '''[[#uuid|uuid]]''' || varchar(36) || NO || PRI || NULL ||  
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| regionHandle || bigint(20) unsigned || NO || MUL || NULL ||
+
| '''[[#regionHandle|regionHandle]]''' || bigint(20) unsigned || NO || MUL || NULL ||
|-  
+
|-
| regionName || varchar(32) || YES || MUL || NULL ||  
+
| '''[[#regionName|regionName]]''' || varchar(32) || YES || MUL || NULL ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| regionRecvKey || varchar(128) || YES ||  || NULL ||  
+
| '''[[#regionRecvKey|regionRecvKey]]''' || varchar(128) || YES ||  || NULL ||
|-  
+
|-
| regionSendKey || varchar(128) || YES ||  || NULL ||
+
| '''[[#regionSendKey|regionSendKey]]''' || varchar(128) || YES ||  || NULL ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| regionSecret || varchar(128) || YES ||  || NULL ||
+
| '''[[#regionSecret|regionSecret]]''' || varchar(128) || YES ||  || NULL ||
|-  
+
|-
| regionDataURI || varchar(255) || YES ||  || NULL ||
+
| '''[[#regionDataURI|regionDataURI]]''' || varchar(255) || YES ||  || NULL ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| serverIP || varchar(64) || YES ||  || NULL ||
+
| '''[[#serverIP|serverIP]]''' || varchar(64) || YES ||  || NULL ||
|-  
+
|-
| serverPort || int(10) unsigned || YES ||  || NULL ||
+
| '''[[#serverPort|serverPort]]''' || int(10) unsigned || YES ||  || NULL ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| serverURI || varchar(255) || YES ||  || NULL ||
+
| '''[[#serverURI|serverURI]]''' || varchar(255) || YES ||  || NULL ||
|-  
+
|-
| locX || int(10) unsigned || YES ||  || NULL ||
+
| '''[[#locX|locX]]''' || int(10) unsigned || YES ||  || NULL ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| locY || int(10) unsigned || YES ||  || NULL ||
+
| '''[[#locY|locY]]''' || int(10) unsigned || YES ||  || NULL ||
|-  
+
|-
| locZ || int(10) unsigned || YES ||  || NULL ||  
+
| '''[[#locZ|locZ]]''' || int(10) unsigned || YES ||  || NULL ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| eastOverrideHandle || bigint(20) unsigned || YES || MUL || NULL ||
+
| '''[[#eastOverrideHandle|eastOverrideHandle]]''' || bigint(20) unsigned || YES || MUL || NULL ||
|-  
+
|-
| westOverrideHandle || bigint(20) unsigned || YES ||  || NULL ||  
+
| '''[[#westOverrideHandle|westOverrideHandle]]''' || bigint(20) unsigned || YES ||  || NULL ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| southOverrideHandle || bigint(20) unsigned || YES ||  || NULL ||
+
| '''[[#southOverrideHandle|southOverrideHandle]]''' || bigint(20) unsigned || YES ||  || NULL ||
|-  
+
|-
| northOverrideHandle || bigint(20) unsigned || YES ||  || NULL ||  
+
| '''[[#northOverrideHandle|northOverrideHandle]]''' || bigint(20) unsigned || YES ||  || NULL ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| regionAssetURI || varchar(255) || YES ||  || NULL ||  
+
| '''[[#regionAssetURI|regionAssetURI]]''' || varchar(255) || YES ||  || NULL ||
|-  
+
|-
| regionAssetRecvKey || varchar(128) || YES || PRI || NULL ||  
+
| '''[[#regionAssetRecvKey|regionAssetRecvKey]]''' || varchar(128) || YES || PRI || NULL ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| regionAssetSendKey || varchar(128) || YES || PRI || NULL ||  
+
| '''[[#regionAssetSendKey|regionAssetSendKey]]''' || varchar(128) || YES || PRI || NULL ||
|-  
+
|-
| regionUserURI || varchar(255) || YES ||  || NULL ||
+
| '''[[#regionUserURI|regionUserURI]]''' || varchar(255) || YES ||  || NULL ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| regionUserRecvKey || varchar(128) || YES ||  || NULL ||  
+
| '''[[#regionUserRecvKey|regionUserRecvKey]]''' || varchar(128) || YES ||  || NULL ||
 +
|-
 +
| '''[[#regionUserSendKey|regionUserSendKey]]''' || varchar(128) || YES ||  || NULL ||
 +
|- style="background:#eee;"
 +
| '''[[#regionMapTexture|regionMapTexture]]''' || varchar(36) || YES ||  || NULL ||
 +
|-
 +
| '''[[#serverHttpPort|serverHttpPort]]''' || int(10) || YES ||  || NULL ||
 +
|- style="background:#eee;"
 +
| '''[[#serverRemotingPort|serverRemotingPort]]''' || int(10) || YES ||  || NULL ||
 +
|-
 +
| '''[[#owner_uuid|owner_uuid]]''' || varchar(36) || NO ||  || 00000000-0000-0000-0000-000000000000 ||
 +
|- style="background:#eee;"
 +
| '''[[#originUUID|originUUID]]''' || varchar(36) || YES ||  || NULL ||
 
|-  
 
|-  
| regionUserSendKey || varchar(128) || YES ||  || NULL ||  
+
| '''[[#access|access]]''' || int(10) unsigned || YES ||  || 1 ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| regionMapTexture || varchar(36) || YES ||  || NULL ||  
+
| '''[[#ScopeID|ScopeID]]''' || char(36) || NO ||  || 00000000-0000-0000-0000-000000000000 ||
 
|-  
 
|-  
| serverHttpPort || int(10) || YES ||  || NULL ||  
+
| '''[[#sizeX|sizeX]]''' || int(11) || NO ||  || 0 ||
 +
|- style="background:#eee;"
 +
| '''[[#sizeY|sizeY]]''' || int(11) || NO ||  || 0 ||
 +
|-
 +
| '''[[#flags|flags]]''' || int(11) || NO ||  || 0 ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| serverRemotingPort || int(10) || YES ||  || NULL ||  
+
| '''[[#last_seen|last_seen]]''' || int(11) || NO ||  || 0 ||
 
|-  
 
|-  
| owner_uuid || varchar(36) || NO ||  || 00000000-0000-0000-0000-000000000000 ||  
+
| '''[[#PrincipalID|PrincipalID]]''' || char(36) || NO ||  || 00000000-0000-0000-0000-000000000000 ||
 
|- style="background:#eee;"
 
|- style="background:#eee;"
| originUUID || varchar(36) || YES ||  || NULL ||  
+
| '''[[#Token|Token]]''' || varchar(255) || NO ||  || None ||
 
|-  
 
|-  
 +
| '''[[#parcelMapTexture|parcelMapTexture]]''' || varchar(36) || YES ||  || NULL ||
 +
|- style="background:#eee;"
 
|}
 
|}
<br />
 
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(back to [[Database Documentation]])
+
 
<br />
+
      (back to [[Database Documentation]])
 +
 
  
 
----  
 
----  
<br />
+
 
  
 
== regions Fields ==
 
== regions Fields ==
  
'''uuid'''<br />
+
== regions Fields ==
The region's unique identifier
+
<br />
+
  
'''regionHandle'''<br />
+
'''uuid'''
The absolute address of the origin coordinates, specified in metres, of the region calculated from LocX and LocY as<br />
+
:The region's unique identifier
(LocX*256*65536)+(LocY*256).
+
<br />
+
  
'''regionName'''<br />
+
'''regionHandle'''
the region's name as it appears on maps - not necesarily unique
+
:The absolute address of the origin coordinates, specified in metres, of the region calculated from LocX and LocY as
<br />
+
:(LocX*256*65536)+(LocY*256).
  
'''regionRecvKey'''<br />
+
'''regionName'''
the key used by the region server to verify authenticity of communications from other regions
+
:The region's name as it appears on maps - not necesarily unique
<br />
+
  
'''regionSendKey'''<br />
+
'''regionRecvKey'''
the key used by the region server when verifying its identity in communications with other regions  
+
:The key used by the region server to verify authenticity of communications from other regions
<br />
+
  
'''regionSecret'''<br />
+
'''regionSendKey'''
more detail req'd
+
:The key used by the region server when verifying its identity in communications with other regions
<br />
+
  
'''regionDataURI'''<br />
+
'''regionSecret'''
more detail req'd
+
:more detail req'd
<br />
+
  
'''serverIP'''<br />
+
'''regionDataURI'''
IP address of region server
+
:more detail req'd
<br />
+
  
'''serverPort'''<br />
+
'''serverIP'''
connection port for region server
+
:IP address of region server
<br />
+
  
'''serverURI'''<br />
+
'''serverPort'''
more detail req'd
+
:connection port for a specific region(this can be but need not be the same as http, each region should have its own port)
<br />
+
  
'''locX'''<br />
+
'''serverURI'''
X coordinate of region on the grid
+
:http representation of serverIP and main http port
<br />
+
  
'''locY'''<br />
+
'''locX'''
Y coordinate of region on the grid
+
:X coordinate of region on the grid in absolute meters locX/256 is equal to coordinate in Regions.ini
<br />
+
  
'''locZ'''<br />
+
'''locY'''
Z coordinate of region on the grid *grinz*
+
:Y coordinate of region on the grid in absolute meters locY/256 is equal to coordinate in Regions.ini
<br />
+
  
'''eastOverrideHandle'''<br />
+
'''locZ'''
more detail req'd
+
:Z coordinate of region on the grid *grinz*
<br />
+
  
'''westOverrideHandle'''<br />
+
'''eastOverrideHandle'''
more detail req'd
+
:more detail req'd
<br />
+
  
'''southOverrideHandle'''<br />
+
'''westOverrideHandle'''
more detail req'd
+
:more detail req'd
<br />
+
  
'''northOverrideHandle'''<br />
+
'''southOverrideHandle'''
more detail req'd
+
:more detail req'd
<br />
+
  
'''regionAssetURI'''<br />
+
'''northOverrideHandle'''
The URL and port number of the Asset Server for the grid
+
:more detail req'd
<br />
+
  
'''regionAssetRecvKey'''<br />
+
'''regionAssetURI'''
key used to verify the authenticity of communications received from the asset server
+
:The URL and port number of the Asset Server for the grid
<br />
+
  
'''regionAssetSendKey'''<br />
+
'''regionAssetRecvKey'''
key used to verify the authenticity of communications sent to the asset server
+
:Key used to verify the authenticity of communications received from the asset server
<br />
+
  
'''regionUserURI'''<br />
+
'''regionAssetSendKey'''
The URL and port number of the User Server for the grid
+
:Key used to verify the authenticity of communications sent to the asset server
<br />
+
  
'''regionUserRecvKey'''<br />
+
'''regionUserURI'''
key used to verify the authenticity of communications received from the user server
+
:The URL and port number of the User Server for the grid
<br />
+
  
'''regionUserSendKey'''<br />
+
'''regionUserRecvKey'''
key used to verify the authenticity of communications sent to the user server
+
:Key used to verify the authenticity of communications received from the user server
<br />
+
  
'''regionMapTexture'''<br />
+
'''regionUserSendKey'''
texture for the map as displayed in the client minimap
+
:Key used to verify the authenticity of communications sent to the user server
<br />
+
  
'''serverHttpPort'''<br />
+
'''regionMapTexture'''
port the region will answer on for HTTP requests
+
:Texture for the map as displayed in the client minimap
<br />
+
  
'''serverRemotingPort'''<br />
+
'''serverHttpPort'''
more detail req'd
+
:Port the region will answer on for HTTP requests
<br />
+
  
'''owner_uuid'''<br />
+
'''serverRemotingPort'''
UUID of the avatar/account which owns the region
+
:more detail req'd
<br />
+
 
 +
'''owner_uuid'''
 +
:UUID of the avatar/account which owns the region
 +
 
 +
'''originUUID'''
 +
:more detail req'd, currently seems to contain the current UUID of the region.
 +
 
 +
'''access'''
 +
:PG=13 Region is set to PG
 +
:Moderate=21 Region is set to Moderate
 +
:Adult=42 Region is set to Adult
 +
 
 +
'''ScopeID'''
 +
:more detail req'd
 +
 
 +
'''sizeX'''
 +
:X size of region (in m)
 +
 
 +
'''sizeY'''
 +
:Y size of region (in m)
 +
 
 +
'''flags'''
 +
:DefaultRegion=1 Default region for new avatars. Region is randomly selected if multiple regions have fallback flag set.
 +
:FallbackRegion=2 Regions we redirect to when the destination is down
 +
:RegionOnline=4 Set when a region comes online, unset when it unregisters and DeleteOnUnregister is false
 +
:NoDirectLogin=8 Region unavailable for direct logins (by name)
 +
:Persistent=16 Don't remove on unregister
 +
:LockedOut=32 Don't allow registration
 +
:NoMove=64 Don't allow moving this region
 +
:Reservation=128 This is an inactive reservation
 +
:Authenticate=256 Require authentication
 +
:Hyperlink=512 Record represents a HG link
 +
:DefaultHGRegion=1024 Record represents a default region for hypergrid teleports only.
 +
 
 +
'''last_seen'''
 +
:more detail req'd
 +
 
 +
'''PrincipalID'''
 +
:more detail req'd
 +
 
 +
'''Token'''
 +
:more detail req'd
  
'''originUUID'''<br />
 
more detail req'd, currently seems to contain the current UUID of the region.
 
<br />
 
  
 
----
 
----
  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(back to [[Database Documentation]])
+
(back to [[Database Documentation]])
<br />
+
 
  
 
[[Category:Database]]
 
[[Category:Database]]

Latest revision as of 08:38, 24 April 2024


The regions table contains information concerning all the regions currently connected to the grid.      (back to Database Documentation)

[edit] regions Table Structure

The structure of the regions table is as follows:


Field Type Null Key Default Extra
uuid varchar(36) NO PRI NULL  
regionHandle bigint(20) unsigned NO MUL NULL
regionName varchar(32) YES MUL NULL
regionRecvKey varchar(128) YES NULL
regionSendKey varchar(128) YES NULL
regionSecret varchar(128) YES NULL
regionDataURI varchar(255) YES NULL
serverIP varchar(64) YES NULL
serverPort int(10) unsigned YES NULL
serverURI varchar(255) YES NULL
locX int(10) unsigned YES NULL
locY int(10) unsigned YES NULL
locZ int(10) unsigned YES NULL
eastOverrideHandle bigint(20) unsigned YES MUL NULL
westOverrideHandle bigint(20) unsigned YES NULL
southOverrideHandle bigint(20) unsigned YES NULL
northOverrideHandle bigint(20) unsigned YES NULL
regionAssetURI varchar(255) YES NULL
regionAssetRecvKey varchar(128) YES PRI NULL
regionAssetSendKey varchar(128) YES PRI NULL
regionUserURI varchar(255) YES NULL
regionUserRecvKey varchar(128) YES NULL
regionUserSendKey varchar(128) YES NULL
regionMapTexture varchar(36) YES NULL
serverHttpPort int(10) YES NULL
serverRemotingPort int(10) YES NULL
owner_uuid varchar(36) NO 00000000-0000-0000-0000-000000000000
originUUID varchar(36) YES NULL
access int(10) unsigned YES 1
ScopeID char(36) NO 00000000-0000-0000-0000-000000000000
sizeX int(11) NO 0
sizeY int(11) NO 0
flags int(11) NO 0
last_seen int(11) NO 0
PrincipalID char(36) NO 00000000-0000-0000-0000-000000000000
Token varchar(255) NO None
parcelMapTexture varchar(36) YES NULL


      (back to Database Documentation)




[edit] regions Fields

[edit] regions Fields

uuid

The region's unique identifier

regionHandle

The absolute address of the origin coordinates, specified in metres, of the region calculated from LocX and LocY as
(LocX*256*65536)+(LocY*256).

regionName

The region's name as it appears on maps - not necesarily unique

regionRecvKey

The key used by the region server to verify authenticity of communications from other regions

regionSendKey

The key used by the region server when verifying its identity in communications with other regions

regionSecret

more detail req'd

regionDataURI

more detail req'd

serverIP

IP address of region server

serverPort

connection port for a specific region(this can be but need not be the same as http, each region should have its own port)

serverURI

http representation of serverIP and main http port

locX

X coordinate of region on the grid in absolute meters locX/256 is equal to coordinate in Regions.ini

locY

Y coordinate of region on the grid in absolute meters locY/256 is equal to coordinate in Regions.ini

locZ

Z coordinate of region on the grid *grinz*

eastOverrideHandle

more detail req'd

westOverrideHandle

more detail req'd

southOverrideHandle

more detail req'd

northOverrideHandle

more detail req'd

regionAssetURI

The URL and port number of the Asset Server for the grid

regionAssetRecvKey

Key used to verify the authenticity of communications received from the asset server

regionAssetSendKey

Key used to verify the authenticity of communications sent to the asset server

regionUserURI

The URL and port number of the User Server for the grid

regionUserRecvKey

Key used to verify the authenticity of communications received from the user server

regionUserSendKey

Key used to verify the authenticity of communications sent to the user server

regionMapTexture

Texture for the map as displayed in the client minimap

serverHttpPort

Port the region will answer on for HTTP requests

serverRemotingPort

more detail req'd

owner_uuid

UUID of the avatar/account which owns the region

originUUID

more detail req'd, currently seems to contain the current UUID of the region.

access

PG=13 Region is set to PG
Moderate=21 Region is set to Moderate
Adult=42 Region is set to Adult

ScopeID

more detail req'd

sizeX

X size of region (in m)

sizeY

Y size of region (in m)

flags

DefaultRegion=1 Default region for new avatars. Region is randomly selected if multiple regions have fallback flag set.
FallbackRegion=2 Regions we redirect to when the destination is down
RegionOnline=4 Set when a region comes online, unset when it unregisters and DeleteOnUnregister is false
NoDirectLogin=8 Region unavailable for direct logins (by name)
Persistent=16 Don't remove on unregister
LockedOut=32 Don't allow registration
NoMove=64 Don't allow moving this region
Reservation=128 This is an inactive reservation
Authenticate=256 Require authentication
Hyperlink=512 Record represents a HG link
DefaultHGRegion=1024 Record represents a default region for hypergrid teleports only.

last_seen

more detail req'd

PrincipalID

more detail req'd

Token

more detail req'd



(back to Database Documentation)

Personal tools
General
About This Wiki