Difference between revisions of "Explanation of Registry Tables"

From FMR Knowledge Base
Jump to navigation Jump to search
(Created page with " The following lists some of the tables that the Registry creates with a description of the tables purpose. '''Note:''' the database tables are primarily used for persistence...")
 
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
+
__NOTOC__
 +
[[Category:Concepts_Reference_V11]]
 
The following lists some of the tables that the Registry creates with a description of the tables purpose.
 
The following lists some of the tables that the Registry creates with a description of the tables purpose.
  
'''Note:''' the database tables are primarily used for persistence of Registry information. Do not expect modifying database values to have any effect on a running Registry. Metadata Technology does not recommend modifying database tables unless explicitly instructed to do so.
+
'''Note:''' the database tables are primarily used for persistence of Registry information. Do not expect modifying database values to have any effect on a running Registry. It is recommended to NOT modify database tables unless explicitly instructed to do so.
  
 
==== Structural Metadata Persistence ====
 
==== Structural Metadata Persistence ====
Line 50: Line 51:
 
|registry_settings_ser
 
|registry_settings_ser
 
|Serialised Registry settings. This is used for when the the setting to be stored cannot be described as a string in the registry_settings table and its serialised form needs to be persisted.
 
|Serialised Registry settings. This is used for when the the setting to be stored cannot be described as a string in the registry_settings table and its serialised form needs to be persisted.
 +
|}
 +
 +
==== Auditing and Logging ====
 +
{| class="wikitable"
 +
!|Table Name
 +
!| Description
 +
|-
 +
|registry_audit
 +
|Stores Audit information from HTTP requests, such as the requested Web Service, information about the requesting machine and the associated transaction_id (if appropriate)
 +
|-
 +
|registry_logs
 +
|For every recorded log event in the Registry, a row is stored with the time taken and Transaction Id (if appropriate)
 +
|-
 +
|registry_logs_zip
 +
|The zipped up store of the logging information for a particular log event. This information is usually sent to the Apache Tomcat "Registry.log" file, but for any particular request, the same information is stored in a zipped form.
 
|}
 
|}

Latest revision as of 03:58, 30 March 2024

The following lists some of the tables that the Registry creates with a description of the tables purpose.

Note: the database tables are primarily used for persistence of Registry information. Do not expect modifying database values to have any effect on a running Registry. It is recommended to NOT modify database tables unless explicitly instructed to do so.

Structural Metadata Persistence

Table Name Description
registry_maintainables A list of all the maintainables in the Registry.
registry_maintainable_sdmx Each maintainable in the Registry stored in its SDMX form.
registry_maintainable_ser Each maintainable in the Registry stored as a Java serialised object. This is used for performance purposes as de-serialising a serialised object is faster than recreating it from its SDMX form.

Transactional Information

Table Name Description
tx_backup Stores the transaction number for each individual structure submission / modification. Note a single transaction can be for multiple metadata structures
sdmx_transaction Stores information about each transaction, such as the user who performed it, the date and event type (Replace, Delete, etc)
sdmx_transaction_item Links the URN of a individual structural metadata to a transaction number.
sdmx_backup Stores a binary image of the transaction in gzipped format of the XML

Registry Settings

Table Name Description
registry_settings Persists most of the registry settings in a key / value format where the column "name" identifies the setting and the column "value" its value.
registry_settings_dv Persists the data validation settings of the Registry
registry_settings_ser Serialised Registry settings. This is used for when the the setting to be stored cannot be described as a string in the registry_settings table and its serialised form needs to be persisted.

Auditing and Logging

Table Name Description
registry_audit Stores Audit information from HTTP requests, such as the requested Web Service, information about the requesting machine and the associated transaction_id (if appropriate)
registry_logs For every recorded log event in the Registry, a row is stored with the time taken and Transaction Id (if appropriate)
registry_logs_zip The zipped up store of the logging information for a particular log event. This information is usually sent to the Apache Tomcat "Registry.log" file, but for any particular request, the same information is stored in a zipped form.