Skip to content

Bard domain objects for grails

ddurkin edited this page Jun 29, 2012 · 7 revisions

The BardDomainModel plug-in

This plug-in, named "BardDomainModel", provides a uniform way to access the Bard schema from within Grails programs. You can find the source for this plug-in in the root Bard directory on GitHub. You are encouraged to modify the code to keep it up-to-date with the latest schema changes.

Using the plug-in

Depend on the prebuilt version in the bard-repo maven repository.

##Add the bard-repo to BuildConfig.groovy:

repositories{
    mavenRepo  "http://bard-repo.broadinstitute.org:8081/artifactory/bard-virtual-repo"
    grailsRepo("http://bard-repo.broadinstitute.org:8081/artifactory/bard-virtual-repo", "grailsCentral")
}
//declare the dependency in the plugins block of BuildConfig.groovy
plugins {
    compile ":bard-domain-model:0.1.7"
}

Database Migration Plugin

The bard-domain-model plugin includes a dependency on the database-migration plugin, we're using this to manage schema changes and ensure they're in sync with the domain model. Projects including the bard-domain-model get the database migration as a transitive dependency. Therefore database migration plugin commands like dbm-update can be run from the including project.

See: Grails-database-migrations-bard

Tip if in doubt grails refresh-dependencies will fetch any required dependencies, you can verify the dependencies with grails dependency-report.

Note that the plug-in contains **only ** references to the domain object. You still need to provide your own DataSource.groovy, Config.groovy, Bootstrap.groovy and any other configuration files.

Further note: this plug-in requires Grails 2.0.4 or better. It will not work with version 2.0.3