GORM relationships databases batches application configuration

1. Groovy: Efficiency Oriented Programming
Lecture 12
Master Proteomics & Bioinformatics - University of Geneva
Alexandre Masselot - summer 2011

2. Agenda
‣ Linux tip-of-the-day
‣ GORM relationships
‣ Database batches
‣ Application configuration

3. Linux tip-of-the-day: bash environment variables
‣ Set a variable to be read by further terminal process
export GRAILS_HOME=$HOME/local/grails-1.3.7

4. Linux tip-of-the-day: bash environment variables
‣ Set a variable to be read by further terminal process
export GRAILS_HOME=$HOME/local/grails-1.3.7
‣ Prepend the path to give priority:
export PATH=$GRAILS_HOME/bin:$PATH

5. Linux tip-of-the-day: bash environment variables
‣ Set a variable to be read by further terminal process
export GRAILS_HOME=$HOME/local/grails-1.3.7
‣ Prepend the path to give priority:
export PATH=$GRAILS_HOME/bin:$PATH
‣ Variables are not shared among “parallel” consoles

6. Linux tip-of-the-day: bash environment variables
‣ Set a variable to be read by further terminal process
export GRAILS_HOME=$HOME/local/grails-1.3.7
‣ Prepend the path to give priority:
export PATH=$GRAILS_HOME/bin:$PATH
‣ Variables are not shared among “parallel” consoles
‣ To set variable a bash startup, edit either
~/.bashrc
~/.profile

7. Objects dependancies ↔ domain relationships
(↔ foreign keys constraints)

8. Different type of relationships

9. Different type of relationships
‣ one-to-one

10. Different type of relationships
‣ one-to-one
‣ one-to-many

11. Different type of relationships
‣ one-to-one
‣ one-to-many
‣ many-to-many

12. The pedestrian one-to-many
‣Message.groovy
Person commiter

13. The pedestrian one-to-many
‣Message.groovy
Person commiter
‣ Person.groovy
Set<Messages> messages=[]
def addToMessages(msg){
msg.commiter=this
msg.save()
messages.add(msg)
}

14. The pedestrian one-to-many
‣Message.groovy
Person commiter
‣ Person.groovy
Set<Messages> messages=[]
def addToMessages(msg){
msg.commiter=this
msg.save()
messages.add(msg)
}
‣ And we do not mention
- added messages already has a commiter member
- cascade deletion

15. GORM: do not care about SQL/Hibernate

16. Dependency to a single bean: typed member

17. Dependency to a list of beans: hasMany

18. Dependency direction: belongsTo

19. One-to-one relationship

20. Example: a Profile object with details for a user
1 Person ↔ 0:1 Profile

21. one-to-one (cont’d)

22. one-to-one (cont’d)
class Profile {
String homePage
static constraints = {
homePage(url:true, blank:false)
}
}
class Person {
...
Profile profile
static constraints = {
...
profile(nullable:true)
}
}

23. one-to-one (cont’d)
class Profile {
String homePage
static belongsTo = Person
static constraints = {
homePage(url:true, blank:false)
}
}
class Person {
...
Profile profile
static constraints = {
...
profile(nullable:true)
}
}

24. one-to-one (cont’d)
‣ Setting a profile
joe.profile=new Profile(url=‘http://www.example.com’)
joe.save()

25. one-to-one (cont’d)
‣ Setting a profile
joe.profile=new Profile(url=‘http://www.example.com’)
joe.save()
‣ Deleting cascades:
joe.delete()

26. one-to-one (end)
void testProfile(){
assert Person.count() == 0
assert Profile.count() == 0
}

27. one-to-one (end)
void testProfile(){
assert Person.count() == 0
assert Profile.count() == 0
Person p=new Person(firstName:'Lucky', lastName:'Luke',
email:'lucky.luke@morris.com',
username:'lucky_luke'
).save(failOnError:true)
assert Person.count() == 1
assert Profile.count() == 0
}

28. one-to-one (end)
void testProfile(){
assert Person.count() == 0
assert Profile.count() == 0
Person p=new Person(firstName:'Lucky', lastName:'Luke',
email:'lucky.luke@morris.com',
username:'lucky_luke'
).save(failOnError:true)
assert Person.count() == 1
assert Profile.count() == 0
p.profile = new Profile(homePage:'http://www.morris.com/~lucky-luke')
p.save(failOnError:true)
assert Person.count() == 1
assert Profile.count() == 1
}

29. one-to-one (end)
void testProfile(){
assert Person.count() == 0
assert Profile.count() == 0
Person p=new Person(firstName:'Lucky', lastName:'Luke',
email:'lucky.luke@morris.com',
username:'lucky_luke'
).save(failOnError:true)
assert Person.count() == 1
assert Profile.count() == 0
p.profile = new Profile(homePage:'http://www.morris.com/~lucky-luke')
p.save(failOnError:true)
assert Person.count() == 1
assert Profile.count() == 1
p.delete()
assert Person.count() == 0
assert Profile.count() == 0
}

30. One-to-many relationship

31. Example
1 Person ↔ n Message

32. one-to-many
‣ Person.groovy
static hasMany = [messages: Message]

33. one-to-many
‣ Person.groovy
static hasMany = [messages: Message]
‣ Message.groovy
static belongsTo = [commiter:Person]

34. one-to-many
‣ Person.groovy
static hasMany = [messages: Message]
‣ Message.groovy
static belongsTo = [commiter:Person]
‣ Add one message
joe.addToMessages(new Message(...)).save()

35. one-to-many
‣ Person.groovy
static hasMany = [messages: Message]
‣ Message.groovy
static belongsTo = [commiter:Person]
‣ Add one message
joe.addToMessages(new Message(...)).save()
‣ Delete on message
joe.removeFromMessages(my_msg).save()

36. one-to-many
‣ Person.groovy
static hasMany = [messages: Message]
‣ Message.groovy
static belongsTo = [commiter:Person]
‣ Add one message
joe.addToMessages(new Message(...)).save()
‣ Delete on message
joe.removeFromMessages(my_msg).save()
‣ Delete person + all messages
joe.delete()

37. many-to-many relationships

38. Example: a Message contains many Tag
and vice-versa
n Message ↔ m Tag

39. many-to-many
‣ Message.groovy:
static hasMany = [tags:Tag]

40. many-to-many
‣ Message.groovy:
static hasMany = [tags:Tag]
‣ Tag.groovy:
class Tag{
String name
static hasMany = [messages:Message]
constraints = { name(unique:true) }
}

41. many-to-many
‣ Message.groovy:
static hasMany = [tags:Tag]
‣ Tag.groovy:
class Tag{
String name
belongsTo = Message
static hasMany = [messages:Message]
constraints = { name(unique:true) }
}

42. belongsTo: who adds who?

43. my_msg.addToTags(my_tag).save()

44. Self referencing domain

45. Twitter example: a Person is following others

46. static hasMany = [
messages: Message,
followings: Person
]

48. Application configuration: beyond default

49. Three environments:
development (run-app)
test (test-app -integration)
production (war deployment)

50. Goal: a persistent development database

51. DataSource.groovy
‣ All database configuration is stored under
grails-app/conf/DataSource.groovy

52. DataSource.groovy
‣ All database configuration is stored under
grails-app/conf/DataSource.groovy
‣ Global vs environment configuration
dataSource {
pooled = true
driverClassName = "org.hsqldb.jdbcDriver"
username = "sa"
password = ""
}

53. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
url = "jdbc:hsqldb:mem:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

54. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
url = "jdbc:hsqldb:mem:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

55. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
url = "jdbc:hsqldb:mem:devDB"
"jdbc:hsqldb:file:devDb:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

56. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
url = "jdbc:hsqldb:mem:devDB"
"jdbc:hsqldb:file:devDb:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

57. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
"update"
url = "jdbc:hsqldb:mem:devDB"
"jdbc:hsqldb:file:devDb:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

58. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
"update"
url = "jdbc:hsqldb:mem:devDB"
"jdbc:hsqldb:file:devDb:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

59. hsqldb on file
‣ Database is saved in 3 flat files

60. hsqldb on file
‣ Database is saved in 3 flat files
‣ e.g. devDb.script
CREATE SCHEMA PUBLIC AUTHORIZATION DBA
CREATE MEMORY TABLE MESSAGE(ID BIGINT GENERATED ...
CREATE MEMORY TABLE PERSON(ID BIGINT GENERATED ...
ALTER TABLE MESSAGE ADD CONSTRAINT FK38EB0007D6D0B12 FOREIGN
KEY(COMMITER_ID) REFERENCES PERSON(ID)
ALTER TABLE MESSAGE ALTER COLUMN ID RESTART WITH 3
ALTER TABLE PERSON ALTER COLUMN ID RESTART WITH 2
CREATE USER SA PASSWORD ""
GRANT DBA TO SA
SET WRITE_DELAY 10
SET SCHEMA PUBLIC
INSERT INTO MESSAGE VALUES(1,1,'I''m coming',1)
INSERT INTO MESSAGE VALUES(2,0,'on Jolly Jumper',1)
INSERT INTO PERSON VALUES(1,0,'Luke','lucky_luke',
'lucky.luke@morris.com','2010-05-17 01:18:16.607000000','Lucky')

61. More configuration
‣ All configuration files reside into grails-app/conf

62. More configuration
‣ All configuration files reside into grails-app/conf
‣ Config.groovy handles much

63. More configuration
‣ All configuration files reside into grails-app/conf
‣ Config.groovy handles much
‣ For example, to set failOnError:true by default on
all .save() calls
grails.gorm.save.failOnError = true

64. Populating the database with batch

65. Inserting elements at application start:
BootStrap.groovy

66. grails-app/conf/BootStrap.groovy
class BootStrap {
def init = { servletContext ->
}
def destroy = {
}
}

67. grails-app/conf/BootStrap.groovy
class BootStrap {
def init = { servletContext ->
environments {
test {
}
development {
}
production {
}
}
}
def destroy = {
}
}

68. grails-app/conf/BootStrap.groovy
import eop.lec12.twitter.Person
import eop.lec12.twitter.Profile
class BootStrap {
def init = { servletContext ->
environments {
test {
}
development {
if(!Person.findByUsername('sci_am')){
def p=new Person(firstName:'Scientific', lastName:'American',
email:'info@sciam.com', username:'sci_am')
p.save()
p.profile=new Profile(homePage:'http://www.sciam.com').save()
}
}
production {
}
}
}
def destroy = {
}
}

69. grails-app/conf/BootStrap.groovy
import eop.lec12.twitter.Person
import eop.lec12.twitter.Profile
class BootStrap {
def init = { servletContext ->
environments {
test {
}
development {
if(!Person.findByUsername('sci_am')){
def p=new Person(firstName:'Scientific', lastName:'American',
email:'info@sciam.com', username:'sci_am')
p.save()
p.profile=new Profile(homePage:'http://www.sciam.com').save()
}
}
production {
}
}
}
def destroy = {
}
}

70. Another batch: uploading a list of messages

71. Uploading a file

72. Uploading a file
1. a local file with a list of contents convertible into messages
(rss feed with publication update from Scientific American & Nature)

73. Uploading a file
1. a local file with a list of contents convertible into messages
(rss feed with publication update from Scientific American & Nature)
2. file is uploaded through a web page with a form

74. Uploading a file
1. a local file with a list of contents convertible into messages
(rss feed with publication update from Scientific American & Nature)
2. file is uploaded through a web page with a form
3. a controller/action receive data + params

75. Uploading a file
1. a local file with a list of contents convertible into messages
(rss feed with publication update from Scientific American & Nature)
2. file is uploaded through a web page with a form
3. a controller/action receive data + params
4. launch a service action to parse file & insert into database

76. Uploading a file
1. a local file with a list of contents convertible into messages
(rss feed with publication update from Scientific American & Nature)
2. file is uploaded through a web page with a form
3. a controller/action receive data + params
4. launch a service action to parse file & insert into database

77. Input file

78. Input file
‣ Download Scientific American’s feed
http://rss.sciam.com/ScientificAmerican-Global

79. Input file
‣ Download Scientific American’s feed
http://rss.sciam.com/ScientificAmerican-Global
‣ Nature’s feed
http://feeds.nature.com/nature/rss/current?format=xml

80. Input file
‣ Download Scientific American’s feed
http://rss.sciam.com/ScientificAmerican-Global
‣ Nature’s feed
http://feeds.nature.com/nature/rss/current?format=xml
‣ Stored locally in
test/data/

81. Input file
‣ Download Scientific American’s feed
http://rss.sciam.com/ScientificAmerican-Global
‣ Nature’s feed
http://feeds.nature.com/nature/rss/current?format=xml
‣ Stored locally in
test/data/
‣ Two loader classes (with tests) to convert rss item into
temporary MessageToLoad class
src/groovy

82. http://localhost:8080/eop.lec12.twitter/message/loadList
grails-app/controllers/MessageController.groovy :
loadList = {...}
grails-app/views/message/loadList.gsp

83. loadList.gsp
enable the form
to upload file
<g:form controller="message" action="loadList"
method="post”
enctype="multipart/form-data">
<input type="file" name="messagefile"/>
<g:select name="type"
from="${['sciam', 'nature'] }"/>
<input type="submit"/>
</g:form>
form field
with file data

84. MessageController.groovy
def loadList = {
}

85. MessageController.groovy
def loadList = {
if(!params.type){
// the controller is called without parameter
// thus we just display the form
return
}
}

86. MessageController.groovy
def loadList = {
if(!params.type){
// the controller is called without parameter
// thus we just display the form
return
}
def loaders=[
sciam:new ScientificAmericanMessageLoader(),
nature:new NatureMessageLoader()
]
def loader=loaders[params.type]
}

87. MessageController.groovy
def loadList = {
if(!params.type){
// the controller is called without parameter
// thus we just display the form
return
}
def loaders=[
sciam:new ScientificAmericanMessageLoader(),
nature:new NatureMessageLoader()
]
def loader=loaders[params.type]
def input=request.getFile("messagefile").inputStream
}

88. MessageController.groovy
def loadList = {
if(!params.type){
// the controller is called without parameter
// thus we just display the form
return
}
def loaders=[
sciam:new ScientificAmericanMessageLoader(),
nature:new NatureMessageLoader()
]
def loader=loaders[params.type]
def input=request.getFile("messagefile").inputStream
def n=messageService.loadMessages(loader, input)
}

89. MessageController.groovy
def loadList = {
if(!params.type){
// the controller is called without parameter
// thus we just display the form
return
}
def loaders=[
sciam:new ScientificAmericanMessageLoader(),
nature:new NatureMessageLoader()
]
def loader=loaders[params.type]
def input=request.getFile("messagefile").inputStream
def n=messageService.loadMessages(loader, input)
flash.uploadedMessage=
"file was correctly uploaded with $n entries"
}

90. MessageService
‣ generate grails-app/services/MessageService.groovy
create-service message

91. MessageService
‣ generate grails-app/services/MessageService.groovy
create-service message
‣ In MessageController.groovy, service is referred simply with
def messageService

92. MessageService
‣ generate grails-app/services/MessageService.groovy
create-service message
‣ In MessageController.groovy, service is referred simply with
def messageService
‣ See project source for actual bean insertion

93. Extracting a bean list

94. All messages: Message.list()

95. Exact Match
retList=Message.findAllByCommiter(
Person.findByUsername(params.username)
)

96. Text with wildcard: %
retList=Message.findAllByTextLike("%$params.text%")

97. Match with comparator
retList=Message.findAllByDateGreaterThan(params.date)

98. Multiple constraints
retList=Message.findAllByTextLikeAndDateGreaterThan(
"%$params.text%", params.date
)

99. Pagination
retList=Message.findAllByTextLike("%$params.text%",
[max:10, offset:19, sort:‘date’, order:‘desc’]
)

100. More power:
Hibernate criteria & HQL

101. Application configuration: beyond default

102. Three environments:
development (run-app)
test (test-app -integration)
production (war deployment)

103. Goal: a persistent development database

104. DataSource.groovy
‣ All database configuration is stored under
grails-app/conf/DataSource.groovy

105. DataSource.groovy
‣ All database configuration is stored under
grails-app/conf/DataSource.groovy
‣ Global vs environment configuration
dataSource {
pooled = true
driverClassName = "org.hsqldb.jdbcDriver"
username = "sa"
password = ""
}

106. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
url = "jdbc:hsqldb:mem:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

107. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
url = "jdbc:hsqldb:mem:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

108. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
url = "jdbc:hsqldb:mem:devDB"
"jdbc:hsqldb:file:devDb:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

109. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
url = "jdbc:hsqldb:mem:devDB"
"jdbc:hsqldb:file:devDb:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

110. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
"update"
url = "jdbc:hsqldb:mem:devDB"
"jdbc:hsqldb:file:devDb:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

111. DataSource.groovy
(cont’d)
environments {
development {
dataSource {
// one of 'create', 'create-drop','update'
dbCreate = "create-drop"
"update"
url = "jdbc:hsqldb:mem:devDB"
"jdbc:hsqldb:file:devDb:devDB"
}
}
test {
//skipped
}
production {
dataSource {
dbCreate = "update"
url = "jdbc:hsqldb:file:prodDb;shutdown=true"
}
}
}

112. hsqldb on file
‣ Database is saved in 3 flat files

113. hsqldb on file
‣ Database is saved in 3 flat files
‣ e.g. devDb.script
CREATE SCHEMA PUBLIC AUTHORIZATION DBA
CREATE MEMORY TABLE MESSAGE(ID BIGINT GENERATED ...
CREATE MEMORY TABLE PERSON(ID BIGINT GENERATED ...
ALTER TABLE MESSAGE ADD CONSTRAINT FK38EB0007D6D0B12 FOREIGN
KEY(COMMITER_ID) REFERENCES PERSON(ID)
ALTER TABLE MESSAGE ALTER COLUMN ID RESTART WITH 3
ALTER TABLE PERSON ALTER COLUMN ID RESTART WITH 2
CREATE USER SA PASSWORD ""
GRANT DBA TO SA
SET WRITE_DELAY 10
SET SCHEMA PUBLIC
INSERT INTO MESSAGE VALUES(1,1,'I''m coming',1)
INSERT INTO MESSAGE VALUES(2,0,'on Jolly Jumper',1)
INSERT INTO PERSON VALUES(1,0,'Luke','lucky_luke',
'lucky.luke@morris.com','2010-05-17 01:18:16.607000000','Lucky')

114. More configuration
‣ All configuration files reside into grails-app/conf

115. More configuration
‣ All configuration files reside into grails-app/conf
‣ Config.groovy handles much

116. More configuration
‣ All configuration files reside into grails-app/conf
‣ Config.groovy handles much
‣ For example, to set failOnError:true by default on
all .save() calls
grails.gorm.save.failOnError = true