Alert.png The wiki is deprecated and due to be decommissioned by the end of September 2022.
The content is being migrated to other supports, new updates will be ignored and lost.
If needed you can get in touch with EGI SDIS team using operations @


From EGIWiki
< GOCDB‎ | Release4‎ | Development
Revision as of 14:58, 5 August 2013 by Davidm (talk | contribs)
Jump to navigation Jump to search
Main operations services Support Documentation Tools Activities Performance Technology Catch-all Services Resource Allocation Security

GOC DB menu: Home Documentation Index

<< Back to GOCDB/Release4/Development

v5 Dropping PROM for Doctrine

By replacing the PROM model with the Doctrine ORM GOCDB will support RDBMSs other than Oracle. This will be released as GOCDB v5 (early Sept). Important changes to the Portal URLs and to the PI are detailed below.


  • Write code once, deploy to Oracle, MySQL, Postgres, SQLite.
  • Much simpler than the GOCDB/PROM model (see query comparison below)]
  • Easier for other projects to extend / modify
  • Easier for new developers to learn
  • Better performance
    • Reduced risk of failover performance issues
Doctrine SQL


  • Data will be deleted rather than marked as 'off'. We therefore require an audit table to record who/when performed data deletions/updates (this is on the requirements roadmap ).
  • Loose some flexiblity as the DB will manage the relationships (FKs) between entities rather than the application (but in turn we gain performance/simplicity/db-agnostic).
  • Changes to some PI methods (paging and carrying over v4 PKs)
  • Changes to Portal URLs and object IDs (below)


The move to Doctrine will introduce some important changes to the GOCDB portal URLs and to the PRIMARY KEY, ID and GOCDB_PORTAL_URL fields of the GOCDB PI.

Portal URLs

In PROM, each "entity" (site, service endpoint, downtime) was assigned an ID from a global pool. There is only one object 123, the GRIDOPS-GOCDB site. The following URL is used to access an entity regardless of type:

In Doctrine, each entity receives an ID unique only to that entity type. There is a site with ID 123, a service endpoint with ID 123 and a downtime with ID 123. The new URL will reflect the entity type:

(...and so on for each GOCDB entity type)


PI XML Output Values

In the GOCDB PI there are a number of PROM specific XML values that will change when we move to Doctrine: PRIMARY_KEY, ID and GOCDB_PORTAL_URL. These are highlighted in RED below:

Get Site Fields.png

The ID fields will NOT be consistent between v4 and v5 (each new object will get a new ID value).

Update Aug 2013 - Preserving v4 <PRIMARY_KEY> element values

  • v4 <PRIMARY_KEY> element values are carried over for Sites to maintain backward compatiblity (get_site, get_site_list)
  • v4 <PRIMARY_KEY> element values are carried over for Downtimes (get_downtime)
  • No preservation of v4 <PRIMARY_KEY> element values planned for:
    • get_service_endpoint (no report that v4 values are required)
    • get_ngi
    • get_service_group
    • Please check!

PI get_downtime method paging

  • The mandatory 'page' parameter has been introduced for the 'get_downtime' PI method. This is required to protect against server loading and maximum execution time issues. The 'page' parameter is now required when issuing this query except when specifying the new 'all_lastmonth' parameter which does not page the results.
  • The get_downtime method should be re-issued each time incrementing the page parameter by one until an empty
    element is returned indicating no more results. Currently each query will show 500 downtimes per page.

Request for Comments

If these changes affect a system that reads from the GOCDB-PI or links to the web portal please let us know.