https://github.com/stariy95/cayenne-gradle-playground
https://github.com/stariy95/cayenne-gradle-playground
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/stariy95/cayenne-gradle-playground
- Owner: stariy95
- License: apache-2.0
- Created: 2017-05-16T12:32:30.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-24T12:09:39.000Z (over 8 years ago)
- Last Synced: 2025-01-05T04:43:40.531Z (9 months ago)
- Language: Java
- Size: 142 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Cayenne Gradle plugin api demo
## Including Cayenne
Here is example of how you can easily setup cayenne in your project:
```groovy
buildscript {
// add maven repository
repositories {
mavenLocal()
}
// add Cayenne Gradle Plugin
dependencies {
classpath group: 'org.apache.cayenne.plugins', name: 'cayenne-gradle-plugin', version: '4.0.M6-SNAPSHOT'
}
}
// apply Cayenne plugin
apply plugin: 'org.apache.cayenne'
// set default DataMap
cayenne.defaultDataMap 'datamap.map.xml'
// add required dependencies to your project
dependencies {
compile cayenne.dependency('server')
compile cayenne.dependency('java8')
}
```
## DSL
Cayenne Gradle plugin exports object ``cayenne`` that you can call in your `build.gradle` script.
This object have following methods:
- ``dependency(String module)`` create dependency for the Cayenne module
- property``defaultDataMap`` set DataMap that will be used in all tasks by default
## Tasks
### cgen: class generation task
Configure default `cgen` task:
```groovy
cgen {
client = false
mode = 'all'
overwrite = true
createPropertiesNames = true
}
```
Define additional cgen task (e.g. for client classes):
```groovy
task clientCgen(type: cayenne.cgen) {
client = true
}
```
### cdbgen: database generation task
Configure default `cdbgen` task:
```groovy
cdbgen {
dataSource {
driver 'org.apache.derby.jdbc.EmbeddedDriver'
url 'jdbc:derby:build/testdb;create=true'
username 'sa'
password ''
}
dropTables true
dropPk true
createTables true
createPk false
createFk true
}
```
### cdbimport: database reverse engineering task
Sample configuration:
```groovy
cdbimport {
map 'datamap.map.xml'
dataSource {
driver 'com.mysql.cj.jdbc.Driver'
url 'jdbc:mysql://127.0.0.1:3306/test?useSSL=false'
username 'root'
password 'root'
}
dbImport {
catalog 'catalog-1'
schema 'schema-1'
catalog {
name 'catalog-3'
includeTable 'table0', {
excludeColumns '_column_'
}
includeTables 'table1', 'table2', 'table3'
includeTable 'table4', {
includeColumns 'id', 'type', 'data'
}
excludeTable '^GENERATED_.*'
}
catalog {
name 'catalog-2'
schema {
name 'schema-2'
includeTable 'test_table'
includeTable {
name 'test_table2'
excludeColumn '__excluded'
}
}
}
includeProcedure 'procedure_test_1'
includeColumns 'id', 'version'
tableTypes 'TABLE', 'VIEW'
}
}
```
### Bind tasks to project's build lifecycle
To run Cayenne tasks with your project build, just link them in your `build.gradle` file:
```groovy
cgen.dependsOn cdbimport
compileJava.dependsOn cgen
```