openSIPS | Documentation / DB schema

Documentation -> Manuals -> Manual 1.4 -> DB schema

Pages for other versions: devel 3.6 3.5 3.4 Older versions: 3.3 3.2 3.1 3.0 2.4 2.3 2.2 2.1 1.11 1.10 1.9 1.8 1.7 1.6 1.5 1.4
DB Schema v1.4



OpenSIPS database tables


OpenSIPS database tables
OpenSIPS Development Team
http://www.opensips.org/
Edited by
Henning Westerholt
Norman Brandinger
Copyright © 2007 OpenSIPS development Team
Table of Contents
1. Accounting
2. alias db
3. Subscriber
4. AVP Operations
5. carrierroute
6. Call-processing language
7. Dialog support
8. Matching and translation rules
9. Dispatcher
10. Domain
11. Domainpolicy
12. Extensions
13. Group checking
14. Instant Message Conference
15. Least-cost Routing
16. Message Storage
17. Prefix-Domain Translation
18. Permissions
19. Presence
20. Registrar
21. RLS
22. SIPtrace
23. Speed dial
24. Version
25. SIP URI checks
26. User and global blacklists
27. User location
List of Tables
1-1. Table "acc"
1-2. Table "acc" indexes
1-3. Table "missed_calls"
1-4. Table "missed_calls" indexes
2-1. Table "dbaliases"
2-2. Table "dbaliases" indexes
3-1. Table "subscriber"
3-2. Table "subscriber" indexes
4-1. Table "usr_preferences"
4-2. Table "usr_preferences" indexes
5-1. Table "carrierroute"
5-2. Table "carrierfailureroute"
5-3. Table "route_tree"
6-1. Table "cpl"
6-2. Table "cpl" indexes
7-1. Table "dialog"
7-2. Table "dialog" indexes
8-1. Table "dialplan"
9-1. Table "dispatcher"
10-1. Table "domain"
10-2. Table "domain" indexes
11-1. Table "domainpolicy"
11-2. Table "domainpolicy" indexes
13-1. Table "grp"
13-2. Table "grp" indexes
13-3. Table "re_grp"
13-4. Table "re_grp" indexes
14-1. Table "imc_rooms"
14-2. Table "imc_rooms" indexes
14-3. Table "imc_members"
14-4. Table "imc_members" indexes
15-1. Table "gw"
15-2. Table "gw" indexes
15-3. Table "lcr"
15-4. Table "lcr" indexes
16-1. Table "silo"
16-2. Table "silo" indexes
17-1. Table "pdt"
17-2. Table "pdt" indexes
18-1. Table "trusted"
18-2. Table "trusted" indexes
18-3. Table "address"
19-1. Table "presentity"
19-2. Table "presentity" indexes
19-3. Table "active_watchers"
19-4. Table "active_watchers" indexes
19-5. Table "watchers"
19-6. Table "watchers" indexes
19-7. Table "xcap"
19-8. Table "xcap" indexes
19-9. Table "pua"
20-1. Table "aliases"
20-2. Table "aliases" indexes
21-1. Table "rls_presentity"
21-2. Table "rls_presentity" indexes
21-3. Table "rls_watchers"
21-4. Table "rls_watchers" indexes
22-1. Table "sip_trace"
22-2. Table "sip_trace" indexes
23-1. Table "speed_dial"
23-2. Table "speed_dial" indexes
24-1. Table "version"
25-1. Table "uri"
25-2. Table "uri" indexes
26-1. Table "userblacklist"
26-2. Table "userblacklist" indexes
26-3. Table "globalblacklist"
26-4. Table "globalblacklist" indexes
27-1. Table "location"
27-2. Table "location" indexes
Chapter 1. Accounting
    
acc
This table is used by the ACC module to report on transactions - accounted calls. More information is available at: http://www.opensips.org/html/docs/modules/1.4.x/acc.html
        
missed_calls
This table is used by the ACC module for keeping track of missed calls. This table is similar to the 'acc' table. More information is available at: http://www.opensips.org/html/docs/modules/1.4.x/acc.html
  
    
Table 1-1. Table "acc"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              method
                          string
                          16
            '' no                   A method is the primary function that a request is meant to invoke on a server.
            
              from_tag
                          string
                          64
            '' no                   The tag parameter serves as a general mechanism to identify a dialog, which is the combination of the Call-ID along with two tags, one from participant in the dialog.
            
              to_tag
                          string
                          64
            '' no                   The tag parameter serves as a general mechanism to identify a dialog, which is the combination of the Call-ID along with two tags, one from participant in the dialog.
            
              callid
                          string
                          64
            '' no                   Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client. 
            
              sip_code
                          string
                          3
            '' no                   SIP reply code
            
              sip_reason
                          string
                          32
            '' no                   SIP reply reason
            
              time
                          datetime
                          not specified
            default no                   Date and time when this record was written.
            
    Table 1-2. Table "acc" indexes
name type links description
              callid_idx
            default callid                
            
    Table 1-3. Table "missed_calls"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              method
                          string
                          16
            '' no                   A method is the primary function that a request is meant to invoke on a server.
            
              from_tag
                          string
                          64
            '' no                   The tag parameter serves as a general mechanism to identify a dialog, which is the combination of the Call-ID along with two tags, one from participant in the dialog.
            
              to_tag
                          string
                          64
            '' no                   The tag parameter serves as a general mechanism to identify a dialog, which is the combination of the Call-ID along with two tags, one from participant in the dialog.
            
              callid
                          string
                          64
            '' no                   Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client. 
            
              sip_code
                          string
                          3
            '' no                   SIP reply code
            
              sip_reason
                          string
                          32
            '' no                   SIP reply reason
            
              time
                          datetime
                          not specified
            default no                   Date and time when this record was written.
            
    Table 1-4. Table "missed_calls" indexes
name type links description
              callid_idx
            default callid                
            
  
Chapter 2. alias db
    
dbaliases
This table us used by the alias_db module as an alternative for user aliases via userloc. More information about the alias_db module can be found at: http://www.opensips.org/html/docs/modules/1.4.x/alias_db.html
        
  
    
Table 2-1. Table "dbaliases"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              alias_username
                          string
                          64
            '' no                   Alias username / phone number
            
              alias_domain
                          string
                          64
            '' no                   Alias domain name
            
              username
                          string
                          64
            '' no                   Username / phone number
            
              domain
                          string
                          64
            '' no                   Domain name
            
    Table 2-2. Table "dbaliases" indexes
name type links description
              alias_idx
            unique alias_username, alias_domain                
            
              target_idx
            default username, domain                
            
  
Chapter 3. Subscriber
    
subscriber
This table is used to provide authentication information. More information about the auth_db module can be found at: http://www.opensips.org/html/docs/modules/1.4.x/auth_db.html
        
  
    
Table 3-1. Table "subscriber"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               Unique ID
            
              username
                          string
                          64
            '' no                   Username / phone number
            
              domain
                          string
                          64
            '' no                   Domain name
            
              password
                          string
                          25
            '' no                   Password
            
              email_address
                          string
                          64
            '' no                   Email address
            
              ha1
                          string
                          64
            '' no                   md5(username:realm:password)
            
              ha1b
                          string
                          64
            '' no                   md5(username@domain:realm:password)
            
              rpid
                          string
                          64
            NULL yes                   The SIP Remote-Party-ID header identifies the calling party and includes user, party, screen and privacy headers that specify how a call is presented and screened.
            
    Table 3-2. Table "subscriber" indexes
name type links description
              account_idx
            unique username, domain                
            
              username_idx
            default username                
            
  
Chapter 4. AVP Operations
    
usr_preferences
This table us used by the avpops module to implement Attribute Value Pairs (AVP's). More information about the avpops module can be found at: http://www.opensips.org/html/docs/modules/1.4.x/avpops.html
        
  
    
Table 4-1. Table "usr_preferences"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               Unique ID
            
              uuid
                          string
                          64
            '' no                   Unique user ID
            
              username
                          string
                          128
            0 no                   Username / phone number
            
              domain
                          string
                          64
            '' no                   Domain name
            
              attribute
                          string
                          32
            '' no                   AVP attribute
            
              type
                          int
                          11
            0 no                   AVP type
            
              value
                          string
                          128
            '' no                   AVP value
            
              last_modified
                          datetime
                          not specified
            '1900-01-01 00:00:01' no                   Date and time when this record was last modified.
            
    Table 4-2. Table "usr_preferences" indexes
name type links description
              ua_idx
            default uuid, attribute                
            
              uda_idx
            default username, domain, attribute                
            
  
Chapter 5. carrierroute
    
carrierroute
This table is used by the carrierroute module to provides routing, balancing and blacklisting capabilities. More information is available at: http://www.opensips.org/docs/modules/devel/carrierroute.html
			  
carrierfailureroute
This table is used by the carrierroute module to provide failure routing capabilities. More information is available at: http://www.opensips.org/docs/modules/devel/carrierroute.html
			  
route_tree
This table is used by the carrierroute module to provides routing, balancing and blacklisting capabilities. More information is available at: http://www.opensips.org/html/docs/modules/1.4.x/carrierroute.html
			  
  
    
Table 5-1. Table "carrierroute"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              carrier
                          unsigned int
                          10
            0 no                   This column contains the carrier id.
            
              domain
                          string
                          64
            '' no                   This column contains the route domain. Additional domains could be used for example as fallback.
            
              scan_prefix
                          string
                          64
            '' no                   This column contains the scan prefix, which define the matching portion of a phone number.
            
              flags
                          unsigned int
                          11
            0 no                   This column contains the flags used for rule matching.
            
              mask
                          unsigned int
                          11
            0 no                   This column contains the mask that is applied to the message flags before rule matching.
            
              prob
                          float
                          not specified
            0 no                   Name of column containing the probability. The probability value is used to distribute the traffic between several gateways.
            
              strip
                          unsigned int
                          11
            0 no                   Name of the column containing the number of digits to be stripped of the userpart of an URI before prepending rewrite_prefix.
            
              rewrite_host
                          string
                          128
            '' no                   Name of column containing rewrite prefixes. Here you can define a rewrite prefix for the localpart of the SIP URI.
            
              rewrite_prefix
                          string
                          64
            '' no                   Rewrite prefix for the localpart of the SIP URI.
            
              rewrite_suffix
                          string
                          64
            '' no                   Rewrite suffix for the localpart of the SIP URI.
            
              description
                          string
                          255
            NULL yes                   A comment for the route entry, useful for larger routing tables.
            
    Table 5-2. Table "carrierfailureroute"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              carrier
                          unsigned int
                          10
            0 no                   This column contains the carrier id.
            
              domain
                          string
                          64
            '' no                   This column contains the route domain. Additional domains could be used for example as fallback.
            
              scan_prefix
                          string
                          64
            '' no                   This column contains the scan prefix, which define the matching portion of a phone number.
            
              host_name
                          string
                          128
            '' no                   This column contains the routing destination used for rule matching.
            
              reply_code
                          string
                          3
            '' no                   This column contains the reply code used for rule matching.
            
              flags
                          unsigned int
                          11
            0 no                   This column contains the flags used for rule matching.
            
              mask
                          unsigned int
                          11
            0 no                   This column contains the mask that is applied to the message flags before rule matching.
            
              next_domain
                          string
                          64
            '' no                   This column contains the route domain that should be used for the next routing attempt.
            
              description
                          string
                          255
            NULL yes                   A comment for the route entry, useful for larger routing tables.
            
    Table 5-3. Table "route_tree"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              carrier
                          string
                          64
            NULL yes                   This column contains the carrier name.
            
  
Chapter 6. Call-processing language
    
cpl
Table for the call processing language "cpl" module. More information is available at: http://www.opensips.org/html/docs/modules/1.4.x/cpl-c.html
  
    
Table 6-1. Table "cpl"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               Unique ID
            
              username
                          string
                          64
            default no                    
            
              domain
                          string
                          64
            '' no                    
            
              cpl_xml
                          text
                          not specified
            default yes                    
            
              cpl_bin
                          text
                          not specified
            default yes                    
            
    Table 6-2. Table "cpl" indexes
name type links description
              account_idx
            unique username, domain                
            
  
Chapter 7. Dialog support
    
dialog
Persistent dialog information for the dialog module. More 
		information can be found at: http://www.opensips.org/html/docs/modules/1.4.x/dialog.html
		
  
    
Table 7-1. Table "dialog"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              hash_entry
                          unsigned int
                          10
            default no                   Number of the hash entry in the dialog hash table
		
            
              hash_id
                          unsigned int
                          10
            default no                   The ID on the hash entry
            
              callid
                          string
                          255
            default no                   Call-ID of the dialog
            
              from_uri
                          string
                          128
            default no                   The URI of the FROM header (as per INVITE)
            
              from_tag
                          string
                          64
            default no                   The tag parameter serves as a general mechanism to 
		identify a dialog, which is the combination of the Call-ID along 
		with two tags, one from participant in the dialog.
            
              to_uri
                          string
                          128
            default no                   The URI of the TO header (as per INVITE)
            
              to_tag
                          string
                          64
            default no                   The tag parameter serves as a general mechanism to 
		identify a dialog, which is the combination of the Call-ID along 
		with two tags, one from participant in the dialog.
            
              caller_cseq
                          string
                          7
            default no                   Last Cseq number on the caller side.
            
              callee_cseq
                          string
                          7
            default no                   Last Cseq number on the caller side.
            
              caller_route_set
                          string
                          512
            default yes                   Route set on the caller side.
            
              callee_route_set
                          string
                          512
            default yes                   Route set on on the caller side.
            
              caller_contact
                          string
                          128
            default no                   Caller's contact uri.
            
              callee_contact
                          string
                          128
            default no                   Callee's contact uri.
            
              caller_sock
                          string
                          64
            default no                   Local socket used to communicate with caller
            
              callee_sock
                          string
                          64
            default no                   Local socket used to communicate with callee
            
              state
                          unsigned int
                          10
            default no                   The state of the dialog.
            
              start_time
                          unsigned int
                          10
            default no                   The timestamp (unix time) when the dialog was confirmed.
		
            
              timeout
                          unsigned int
                          10
            default no                   The timestamp (unix time) when the dialog will expire.
		
            
    Table 7-2. Table "dialog" indexes
name type links description
              hash_idx
            default hash_entry, hash_id                
            
  
Chapter 8. Matching and translation rules
    
dialplan
This table is used by the dialplan module for the translation rules. More information is available at: http://www.opensips.org/html/docs/modules/1.4.x/dialplan.html
        
  
    
Table 8-1. Table "dialplan"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              dpid
                          int
                          11
            default no                   Dialplan ID.
            
              pr
                          int
                          11
            default no                   Priority of rule.
            
              match_op
                          int
                          11
            default no                   Matching operator for rule (0-equal, 1-regexp).
            
              match_exp
                          string
                          64
            default no                   Matching expresion (regexp or string).
            
              match_len
                          int
                          11
            default no                   Length of the matching expresion (used only for equal operator).
            
              subst_exp
                          string
                          64
            default no                   Substitution expresion.
            
              repl_exp
                          string
                          32
            default no                   Replacement expresion (sed like).
            
              attrs
                          string
                          32
            default no                   General attributes string to be returned in case of rule matching.
            
  
Chapter 9. Dispatcher
    
dispatcher
This table is used by the dispatcher module. It contains the sets of destinations used for load balancing and dispatching. More information about the dispatcher module can be found at: http://www.opensips.org/html/docs/modules/1.4.x/dispatcher.html
        
  
    
Table 9-1. Table "dispatcher"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              setid
                          int
                          not specified
            0 no                   Destination set id
            
              destination
                          string
                          192
            '' no                   Destination SIP address
            
              flags
                          int
                          not specified
            0 no                   Flags of destination SIP address
            
              description
                          string
                          64
            '' no                   Description for this destination
            
  
Chapter 10. Domain
    
domain
This table is used by the domain module to determine if a host part of a URI is "local" or not. More information about the domain module can be found at: http://www.opensips.org/html/docs/modules/1.4.x/domain.html
        
  
    
Table 10-1. Table "domain"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              domain
                          string
                          64
            '' no                   Domain name
            
              last_modified
                          datetime
                          not specified
            '1900-01-01 00:00:01' no                   Date and time when this record was last modified.
            
    Table 10-2. Table "domain" indexes
name type links description
              domain_idx
            unique domain                
            
  
Chapter 11. Domainpolicy
    
domainpolicy
Table for the domainpolicy module. More information at http://www.opensips.org/html/docs/modules/1.4.x/domainpolicy.html.
        
  
    
Table 11-1. Table "domainpolicy"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              rule
                          string
                          255
            default no                   Domain policy rule name which is equal to the URI as published in the domain policy NAPTRs.
            
              type
                          string
                          255
            default no                    Domain policy rule type. In the case of federation names, this is "fed". For standard referrals according to draft-lendl-speermint-technical-policy-00, this is "std". For direct domain lookups, this is "dom". Default value is "type".
            
              att
                          string
                          255
            default yes                   It contains the AVP's name. If the rule stored in this row triggers, than dp_can_connect() will add an AVP with that name.
            
              val
                          string
                          128
            default yes                   It contains the values for AVPs created by dp_can_connect(). Default value is "val"
            
              description
                          string
                          255
            default no                   Comment about the rule
            
    Table 11-2. Table "domainpolicy" indexes
name type links description
              rav_idx
            unique rule, att, val                
            
              rule_idx
            default rule                
            
  
Chapter 12. Extensions
>
Chapter 13. Group checking
    
grp
This table us used by the group module as a means of group membership checking. Used primarily for Access Control Lists (ACL's). More information about the group module can be found at: http://www.opensips.org/html/docs/modules/1.4.x/group.html
        
re_grp
 This table is used by the group module to check membership based on regular expressions. More information about the group module can be found at: http://www.opensips.org/html/docs/modules/1.4.x/group.html
        
  
    
Table 13-1. Table "grp"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              username
                          string
                          64
            '' no                   Username / phone number
            
              domain
                          string
                          64
            '' no                   Domain name
            
              grp
                          string
                          64
            '' no                   Group name
            
              last_modified
                          datetime
                          not specified
            '1900-01-01 00:00:01' no                   Date and time when this record was last modified.
            
    Table 13-2. Table "grp" indexes
name type links description
              account_group_idx
            unique username, domain, grp                
            
    Table 13-3. Table "re_grp"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              reg_exp
                          string
                          128
            '' no                   Regular expression
            
              group_id
                          int
                          11
            0 no                   Group ID
            
    Table 13-4. Table "re_grp" indexes
name type links description
              group_idx
            default group_id                
            
  
Chapter 14. Instant Message Conference
    
imc_rooms
Room table for the IMC module. More information at http://www.opensips.org/html/docs/modules/1.4.x/imc.html.
        
imc_members
Member table for the IMC module. More information at http://www.opensips.org/html/docs/modules/1.4.x/imc.html.
        
  
    
Table 14-1. Table "imc_rooms"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              name
                          string
                          64
            default no                   Name of the room
            
              domain
                          string
                          64
            default no                   Domain of the room
            
              flag
                          int
                          11
            default no                   Flags
            
    Table 14-2. Table "imc_rooms" indexes
name type links description
              name_domain_idx
            unique name, domain                
            
    Table 14-3. Table "imc_members"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              username
                          string
                          64
            default no                   Username
            
              domain
                          string
                          64
            default no                   Domain
            
              room
                          string
                          64
            default no                    
            
              flag
                          int
                          11
            default no                   Flags
            
    Table 14-4. Table "imc_members" indexes
name type links description
              account_room_idx
            unique username, domain, room                
            
  
Chapter 15. Least-cost Routing
    
gw
This table contains Least Cost Routing Gateway definitions for the LCR module.
                 More information can be found at: http://www.opensips.org/html/docs/modules/1.4.x/lcr.html.
        
lcr
This table is used by the lcr (Least Cost Routing) rules.
            More information can be found at: http://www.opensips.org/html/docs/modules/1.4.x/lcr.html.
        
  
    
Table 15-1. Table "gw"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement                
            
              gw_name
                          string
                          128
            default no                   Gateway Name
            
              grp_id
                          unsigned int
                          not specified
            default no                   Gateway ID
            
              ip_addr
                          string
                          15
            default no                   IP Address of the gateway
            
              port
                          unsigned short
                          not specified
            default yes                   Port of the gateway
            
              uri_scheme
                          unsigned char
                          not specified
            default yes                   URI scheme of the gateway
            
              transport
                          unsigned char
                          not specified
            default yes                   Transport type to be used for the gateway
            
              strip
                          unsigned char
                          not specified
            default yes                   The number of digits to strip from Request URI user part before inserting tag
            
              tag
                          string
                          16
            NULL yes                   Request URI user part tag
            
              flags
                          unsigned int
                          not specified
            0 no                   Gateway specific flags
            
    Table 15-2. Table "gw" indexes
name type links description
              gw_name_idx
            unique gw_name                
            
              grp_id_idx
            default grp_id                
            
    Table 15-3. Table "lcr"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement                
            
              prefix
                          string
                          16
            NULL yes                   Prefix of Request URI user part
            
              from_uri
                          string
                          64
            NULL yes                   Pattern that is matched to caller's URI
            
              grp_id
                          unsigned int
                          not specified
            default no                   Group ID
            
              priority
                          unsigned int
                          not specified
            default no                   Priority
            
    Table 15-4. Table "lcr" indexes
name type links description
              prefix_idx
            default prefix                
            
              from_uri_idx
            default from_uri                
            
              grp_id_idx
            default grp_id                
            
  
Chapter 16. Message Storage
    
silo
 This table us used by the msilo module to provide offline message storage More information about the msilo module can be found at: http://www.opensips.org/html/docs/modules/1.4.x/msilo.html
        
  
    
Table 16-1. Table "silo"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              src_addr
                          string
                          128
            '' no                   Source address - From URI
            
              dst_addr
                          string
                          128
            '' no                   Destination address - To URI
            
              username
                          string
                          64
            '' no                   SIP domain of target user
            
              domain
                          string
                          64
            '' no                   Username / phone number of target user
            
              inc_time
                          int
                          not specified
            0 no                   Incoming time
            
              exp_time
                          int
                          not specified
            0 no                   Expiration time
            
              snd_time
                          int
                          not specified
            0 no                   Reminder send time
            
              ctype
                          string
                          32
            'text/plain' no                   Content type
            
              body
                          binary
                          not specified
            '' no                   Body of the message
            
    Table 16-2. Table "silo" indexes
name type links description
              account_idx
            default username, domain                
            
  
Chapter 17. Prefix-Domain Translation
    
pdt
Prefix-Domain Translation means to change the host and port in R-URI, based on the prefix found in R-URI and source           domain (that is domain in From-URI). More information can be found at: http://www.opensips.org/html/docs/modules/1.4.x/pdt.html 
        
  
    
Table 17-1. Table "pdt"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               Unique ID
            
              sdomain
                          string
                          128
            default no                   Source domain
            
              prefix
                          string
                          32
            default no                   Prefix found in the username part of R-URI.
            
              domain
                          string
                          128
            '' no                   Domain corresponding to (sdomain, prefix) pair where the message must be sent.
            
    Table 17-2. Table "pdt" indexes
name type links description
              sdomain_prefix_idx
            unique sdomain, prefix                
            
  
Chapter 18. Permissions
    
trusted
This table is used by the permissions module to determine if a call has the appropriate permission to be established. More information about the permissions module can be found at: http://www.opensips.org/html/docs/modules/1.4.x/permissions.html
        
address
This table is used by the permissions module. More information is available at: http://www.opensips.org/html/docs/modules/1.4.x/permissions.html
        
  
    
Table 18-1. Table "trusted"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              src_ip
                          string
                          50
            default no                   Source address is equal to source address of request
            
              proto
                          string
                          4
            default no                   Transport protocol is either "any" or equal to transport protocol of request. Possible values that can be stored are "any", "udp", "tcp", "tls", and "sctp".
            
              from_pattern
                          string
                          64
            NULL yes                   Regular expression matches From URI of request.
            
              tag
                          string
                          32
            default yes                   Tag
            
    Table 18-2. Table "trusted" indexes
name type links description
              peer_idx
            default src_ip                
            
    Table 18-3. Table "address"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              grp
                          unsigned short
                          5
            0 no                   Group
            
              ip_addr
                          string
                          15
            default no                   IP address
            
              mask
                          char
                          not specified
            32 no                   Network mask
            
              port
                          unsigned short
                          5
            0 no                   Port
            
  
Chapter 19. Presence
    
presentity
Table for the presence module. More information can be found at: http://www.opensips.org/html/docs/modules/1.4.x/presence.html
        
active_watchers
Table for the presence module. More information can be found at: http://www.opensips.org/html/docs/modules/1.4.x/presence.html
        
watchers
Table for the presence module. More information can be found at: http://www.opensips.org/html/docs/modules/1.4.x/presence.html
        
xcap
Table for the presence module. More information can be found at: http://www.opensips.org/html/docs/modules/1.4.x/presence.html
        
pua
Table for the presence related pua module. More information can be found at: http://www.opensips.org/html/docs/modules/1.4.x/pua.html
        
  
    
Table 19-1. Table "presentity"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               Unique ID
            
              username
                          string
                          64
            default no                   User name
            
              domain
                          string
                          64
            default no                   Domain
            
              event
                          string
                          64
            default no                   Event
            
              etag
                          string
                          64
            default no                   User name
            
              expires
                          int
                          11
            default no                   Expires
            
              received_time
                          int
                          11
            default no                   Reveived time
            
              body
                          binary
                          not specified
            default no                    
            
              sender
                          string
                          128
            default no                   Sender contact
            
    Table 19-2. Table "presentity" indexes
name type links description
              presentity_idx
            unique username, domain, event, etag                
            
    Table 19-3. Table "active_watchers"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               Unique ID
            
              presentity_uri
                          string
                          128
            default no                   Presence URI
            
              watcher_username
                          string
                          64
            default no                   From User
            
              watcher_domain
                          string
                          64
            default no                   From Domain
            
              to_user
                          string
                          64
            default no                   To User
            
              to_domain
                          string
                          64
            default no                   To Domain
            
              event
                          string
                          64
            'presence' no                   Event description
            
              event_id
                          string
                          64
            default yes                   Event ID
            
              to_tag
                          string
                          64
            default no                   TO tag
            
              from_tag
                          string
                          64
            default no                   From tag
            
              callid
                          string
                          64
            default no                   Call ID
            
              local_cseq
                          int
                          11
            default no                   Local cseq
            
              remote_cseq
                          int
                          11
            default no                   Remote cseq
            
              contact
                          string
                          64
            default no                   Contact
            
              record_route
                          text
                          not specified
            default yes                   Record route
            
              expires
                          int
                          11
            default no                   Expires
            
              status
                          int
                          11
            2 no                   Status
            
              reason
                          string
                          64
            default no                   Reason
            
              version
                          int
                          11
            0 no                   Version
            
              socket_info
                          string
                          64
            default no                   Socket info
            
              local_contact
                          string
                          128
            default no                   Local contact
            
    Table 19-4. Table "active_watchers" indexes
name type links description
              active_watchers_idx
            unique presentity_uri, callid, to_tag, from_tag                
            
    Table 19-5. Table "watchers"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               Unique ID
            
              presentity_uri
                          string
                          128
            default no                   Presentity Uri
            
              watcher_username
                          string
                          64
            default no                   Watcher User
            
              watcher_domain
                          string
                          64
            default no                   Watcher Domain
            
              event
                          string
                          64
            'presence' no                   Event description
            
              status
                          int
                          11
            default no                   Status
            
              reason
                          string
                          64
            default yes                   Reason
            
              inserted_time
                          int
                          11
            default no                    
            
    Table 19-6. Table "watchers" indexes
name type links description
              watcher_idx
            unique presentity_uri, watcher_username, watcher_domain, event                
            
    Table 19-7. Table "xcap"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               Unique ID
            
              username
                          string
                          64
            default no                   User name
            
              domain
                          string
                          64
            default no                   Domain
            
              doc
                          binary
                          not specified
            default no                   doc
            
              doc_type
                          int
                          11
            default no                   Document type
            
              etag
                          string
                          64
            default no                   Document Etag
            
              source
                          int
                          11
            default no                   Entity inserting the record
            
              doc_uri
                          string
                          128
            default no                   Document uri
            
              port
                          int
                          11
            default no                   XCAP server port
            
    Table 19-8. Table "xcap" indexes
name type links description
              account_doc_type_idx
            unique username, domain, doc_type, doc_uri                
            
              source_idx
            default source                
            
    Table 19-9. Table "pua"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               Unique ID
            
              pres_uri
                          string
                          128
            default no                   URI
            
              pres_id
                          string
                          64
            default no                   ID
            
              event
                          int
                          11
            default no                   Event
            
              expires
                          int
                          11
            default no                   Expires
            
              desired_expires
                          int
                          11
            default no                   Desired Expires
            
              flag
                          int
                          11
            default no                   Flags
            
              etag
                          string
                          64
            default no                   Etag
            
              tuple_id
                          string
                          64
            default yes                   Tuple ID
            
              watcher_uri
                          string
                          128
            default no                   Watcher URI
            
              call_id
                          string
                          64
            default no                   Call ID
            
              to_tag
                          string
                          64
            default no                   To tag
            
              from_tag
                          string
                          64
            default no                   To tag
            
              cseq
                          int
                          11
            default no                    
            
              record_route
                          text
                          not specified
            default yes                   Record route
            
              contact
                          string
                          128
            default no                   Contact
            
              remote_contact
                          string
                          128
            default no                   Remote contact
            
              version
                          int
                          11
            default no                    
            
              extra_headers
                          text
                          not specified
            default no                   Extra Headers
            
  
Chapter 20. Registrar
    
aliases
This table for the registrar module is similar to the "location" table, (the aliases index makes lookup of missed calls much faster). Thus, the function lookup("alias") can be used to map aliases to AORs. More information is available at: http://www.opensips.org/html/docs/modules/1.4.x/registrar.html. Most people uses the dbaliases table with the alias_db module now.
        
  
    
Table 20-1. Table "aliases"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              username
                          string
                          64
            '' no                   Alias Username / Phone Number 
            
              domain
                          string
                          64
            NULL yes                   Domain name
            
              contact
                          string
                          255
            '' no                   Contact header field value provides a URI whoses meaning depends on the type of request or response it is in.
            
              received
                          string
                          128
            NULL yes                   Received IP:PORT in the format SIP:IP:PORT
            
              path
                          string
                          128
            NULL yes                   Path Header(s) per RFC 3327
            
              expires
                          datetime
                          not specified
            '2020-05-28 21:32:15' no                   Date and time when this entry expires.
            
              q
                          float
                          10,2
            1.0 no                   Value used for preferential routing.
            
              callid
                          string
                          255
            'Default-Call-ID' no                   Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client.
            
              cseq
                          int
                          11
            13 no                   CSeq header field contains a single decimal sequence number and the request method.
            
              last_modified
                          datetime
                          not specified
            '1900-01-01 00:00:01' no                   Date and time when this entry was last modified.
            
              flags
                          int
                          11
            0 no                   Flags
            
              cflags
                          int
                          11
            0 no                   CFlags
            
              user_agent
                          string
                          255
            '' no                   User-Agent header field contains information about the UAC originating the request.
            
              socket
                          string
                          64
            NULL yes                   Socket used to connect to OpenSIPS. For example: UDP:IP:PORT
            
              methods
                          int
                          11
            NULL yes                   Flags that indicate the SIP Methods this contact will accept.
            
    Table 20-2. Table "aliases" indexes
name type links description
              alias_idx
            default username, domain, contact                
            
  
Chapter 21. RLS
    
rls_presentity
Table for the RLS module.
        
rls_watchers
Table for RLS module used for storing resource lists subscribe
                 information.
        
  
    
Table 21-1. Table "rls_presentity"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               Unique ID
            
              rlsubs_did
                          string
                          255
            default no                   Resource list subscribe dialog id
            
              resource_uri
                          string
                          128
            default no                   List Uri
            
              content_type
                          string
                          64
            default no                   Event
            
              presence_state
                          binary
                          not specified
            default no                    
            
              expires
                          int
                          11
            default no                   Expires
            
              updated
                          int
                          11
            default no                   Update flag
            
              auth_state
                          int
                          11
            default no                   Watcher authorization state
            
              reason
                          string
                          64
            default no                   reason for watcher authorization state
            
    Table 21-2. Table "rls_presentity" indexes
name type links description
              rls_presentity_idx
            unique rlsubs_did, resource_uri                
            
              updated_idx
            default updated                
            
    Table 21-3. Table "rls_watchers"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               Unique ID
            
              presentity_uri
                          string
                          128
            default no                   Presence URI
            
              to_user
                          string
                          64
            default no                   To user
            
              to_domain
                          string
                          64
            default no                   To domain
            
              watcher_username
                          string
                          64
            default no                   From user
            
              watcher_domain
                          string
                          64
            default no                   From domain
            
              event
                          string
                          64
            'presence' no                   Event description
            
              event_id
                          string
                          64
            default yes                   Event ID
            
              to_tag
                          string
                          64
            default no                   To tag
            
              from_tag
                          string
                          64
            default no                   From tag
            
              callid
                          string
                          64
            default no                   Call ID
            
              local_cseq
                          int
                          11
            default no                   Local cseq
            
              remote_cseq
                          int
                          11
            default no                   Remote cseq
            
              contact
                          string
                          64
            default no                   Contact
            
              record_route
                          text
                          not specified
            default yes                   Record route
            
              expires
                          int
                          11
            default no                   Expires
            
              status
                          int
                          11
            2 no                   Status
            
              reason
                          string
                          64
            default no                   Reason
            
              version
                          int
                          11
            0 no                   Version
            
              socket_info
                          string
                          64
            default no                   Socket info
            
              local_contact
                          string
                          128
            default no                   Local contact
            
    Table 21-4. Table "rls_watchers" indexes
name type links description
              rls_watcher_idx
            unique presentity_uri, callid, to_tag, from_tag                
            
  
Chapter 22. SIPtrace
    
sip_trace
This table is used to store incoming/outgoing SIP messages in database. More informations can be found in the siptrace module documentation at: http://www.opensips.org/html/docs/modules/1.4.x/siptrace.html.
        
  
    
Table 22-1. Table "sip_trace"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              time_stamp
                          datetime
                          not specified
            '1900-01-01 00:00:01' no                   Recording date
            
              callid
                          string
                          255
            '' no                   call ID from SIP message
            
              traced_user
                          string
                          128
            '' no                   SIP URI of the user being traced
            
              msg
                          text
                          not specified
            default no                   Full SIP message
            
              method
                          string
                          50
            '' no                   SIP method name
            
              status
                          string
                          128
            '' no                   SIP reply status
            
              fromip
                          string
                          50
            '' no                   Source IP address
            
              toip
                          string
                          50
            '' no                   Destination IP address
            
              fromtag
                          string
                          64
            '' no                   From tag
            
              direction
                          string
                          4
            '' no                   Destination IP address
            
    Table 22-2. Table "sip_trace" indexes
name type links description
              traced_user_idx
            default traced_user                
            
              date_idx
            default time_stamp                
            
              fromip_idx
            default fromip                
            
              callid_idx
            default callid                
            
  
Chapter 23. Speed dial
    
speed_dial
This table is used by the speeddial module to provide on-server speed dial facilities. More information about the speeddial module can be found at: http://www.opensips.org/html/docs/modules/1.4.x/speeddial.html
        
  
    
Table 23-1. Table "speed_dial"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              username
                          string
                          64
            '' no                   Username / phone number
            
              domain
                          string
                          64
            '' no                   Domain name
            
              sd_username
                          string
                          64
            '' no                   Speed dial username
            
              sd_domain
                          string
                          64
            '' no                   Speed dial domain
            
              new_uri
                          string
                          128
            '' no                   New URI
            
              fname
                          string
                          64
            '' no                   First name
            
              lname
                          string
                          64
            '' no                   Last name
            
              description
                          string
                          64
            '' no                   Description
            
    Table 23-2. Table "speed_dial" indexes
name type links description
              speed_dial_idx
            unique username, domain, sd_domain, sd_username                
            
  
Chapter 24. Version
    
version
 
  
    
Table 24-1. Table "version"
name type size default null key extra attributes description
              table_name
                          string
                          32
            default no                    
            
              table_version
                          unsigned int
                          not specified
            0 no                    
            
  
Chapter 25. SIP URI checks
    
uri
This table is used by uri_db module to implement various SIP URI checks.
                 More information about the uri_db module can be found at: http://www.opensips.org/html/docs/modules/1.4.x/uri_db.html 
        
  
    
Table 25-1. Table "uri"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement                
            
              username
                          string
                          64
            '' no                   Username / phone number
            
              domain
                          string
                          64
            '' no                   Domain name
            
              uri_user
                          string
                          64
            '' no                   Username / phone number
            
              last_modified
                          datetime
                          not specified
            '1900-01-01 00:00:01' no                   Date and time when this record was last modified.
            
    Table 25-2. Table "uri" indexes
name type links description
              account_idx
            unique username, domain, uri_user                
            
  
Chapter 26. User and global blacklists
    
userblacklist
This table is used by the userblacklist module for the user specific blacklists. More information is available at: http://www.opensips.org/html/docs/modules/1.4.x/userblacklist.html
        
globalblacklist
This table is used by the userblacklist module for the global blacklists. More information is available at: http://www.opensips.org/html/docs/modules/1.4.x/userblacklist.html
        
  
    
Table 26-1. Table "userblacklist"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              username
                          string
                          64
            '' no                   The user that is used for the blacklist lookup.
            
              domain
                          string
                          64
            '' no                   The domain that is used for the blacklist lookup.
            
              prefix
                          string
                          64
            '' no                   The prefix that is matched for the blacklist.
            
              whitelist
                          char
                          1
            0 no                   Specify if this a blacklist (0) or a whitelist (1) entry.
            
    Table 26-2. Table "userblacklist" indexes
name type links description
              userblacklist_idx
            default username, domain, prefix                
            
    Table 26-3. Table "globalblacklist"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              prefix
                          string
                          64
            '' no                   The prefix that is matched for the blacklist.
            
              whitelist
                          char
                          1
            0 no                   Specify if this a blacklist (0) or a whitelist (1) entry.
            
              description
                          string
                          255
            NULL yes                   A comment for the entry.
            
    Table 26-4. Table "globalblacklist" indexes
name type links description
              globalblacklist_idx
            default prefix                
            
  
Chapter 27. User location
    
location
Persistent user location information for the usrloc module. More information can be found at: http://www.opensips.org/html/docs/modules/1.4.x/usrloc.html
        
  
    
Table 27-1. Table "location"
name type size default null key extra attributes description
              id
                          unsigned int
                          10
            default no primary autoincrement               unique ID
            
              username
                          string
                          64
            '' no                   Username / phone number 
            
              domain
                          string
                          64
            NULL yes                   Domain name
            
              contact
                          string
                          255
            '' no                   Contact header field value provides a URI whoses meaning depends on the type of request or response it is in.
            
              received
                          string
                          128
            NULL yes                   Received IP:PORT in the format SIP:IP:PORT
            
              path
                          string
                          128
            NULL yes                   Path Header(s) per RFC 3327
            
              expires
                          datetime
                          not specified
            '2020-05-28 21:32:15' no                   Date and time when this entry expires.
            
              q
                          float
                          10,2
            1.0 no                   Value used for preferential routing.
            
              callid
                          string
                          255
            'Default-Call-ID' no                   Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client.
            
              cseq
                          int
                          11
            13 no                   CSeq header field contains a single decimal sequence number and the request method.
            
              last_modified
                          datetime
                          not specified
            '1900-01-01 00:00:01' no                   Date and time when this entry was last modified.
            
              flags
                          int
                          11
            0 no                   Flags
            
              cflags
                          int
                          11
            0 no                   CFlags
            
              user_agent
                          string
                          255
            '' no                   User-Agent header field contains information about the UAC originating the request.
            
              socket
                          string
                          64
            NULL yes                   Socket used to connect to OpenSIPS. For example: UDP:IP:PORT
            
              methods
                          int
                          11
            NULL yes                   Flags that indicate the SIP Methods this contact will accept.
            
    Table 27-2. Table "location" indexes
name type links description
              account_contact_idx
            default username, domain, contact
From openSIPS

Documentation: DB schema - ver 1.4

Documentation -> Manuals -> Manual 1.4 -> DB schema

OpenSIPS database tables

OpenSIPS Development Team

Edited by

Henning Westerholt

Norman Brandinger

Chapter 1. Accounting

Chapter 2. alias db

Chapter 3. Subscriber

Chapter 4. AVP Operations

Chapter 5. carrierroute

Chapter 6. Call-processing language

Chapter 7. Dialog support

Chapter 8. Matching and translation rules

Chapter 9. Dispatcher

Chapter 10. Domain

Chapter 11. Domainpolicy

Chapter 12. Extensions

Chapter 13. Group checking

Chapter 14. Instant Message Conference

Chapter 15. Least-cost Routing

Chapter 16. Message Storage

Chapter 17. Prefix-Domain Translation

Chapter 18. Permissions

Chapter 19. Presence

Chapter 20. Registrar

Chapter 21. RLS

Chapter 22. SIPtrace

Chapter 23. Speed dial

Chapter 24. Version

Chapter 25. SIP URI checks

Chapter 26. User and global blacklists

Chapter 27. User location

name	type	size	default	null	key	extra attributes	description
`id`	`unsigned int`	`10`	default	no	primary	autoincrement	unique ID
`method`	`string`	`16`	''	no			A method is the primary function that a request is meant to invoke on a server.
`from_tag`	`string`	`64`	''	no			The tag parameter serves as a general mechanism to identify a dialog, which is the combination of the Call-ID along with two tags, one from participant in the dialog.
`to_tag`	`string`	`64`	''	no			The tag parameter serves as a general mechanism to identify a dialog, which is the combination of the Call-ID along with two tags, one from participant in the dialog.
`callid`	`string`	`64`	''	no			Call-ID header field uniquely identifies a particular invitation or all registrations of a particular client.
`sip_code`	`string`	`3`	''	no			SIP reply code
`sip_reason`	`string`	`32`	''	no			SIP reply reason
`time`	`datetime`	`not specified`	default	no			Date and time when this record was written.
name	type	links	description
`alias_idx`	unique	alias_username, alias_domain
`target_idx`	default	username, domain
name	type	links	description
`account_idx`	unique	username, domain
`username_idx`	default	username
name	type	links	description
`ua_idx`	default	uuid, attribute
`uda_idx`	default	username, domain, attribute
name	type	links
`prefix_idx`	default	prefix
`from_uri_idx`	default	from_uri
`grp_id_idx`	default	grp_id
name	type	links	description
`account_doc_type_idx`	unique	username, domain, doc_type, doc_uri
`source_idx`	default	source
name	type	links	description
`rls_presentity_idx`	unique	rlsubs_did, resource_uri
`updated_idx`	default	updated
name	type	links
`traced_user_idx`	default	traced_user
`date_idx`	default	time_stamp
`fromip_idx`	default	fromip
`callid_idx`	default	callid
name	type	size	default	null	key	extra attributes	description
`table_name`	`string`	`32`	default	no
`table_version`	`unsigned int`	`not specified`	0	no