Typesafe Activator

Using a customized Slick code generator

Using a customized Slick code generator

slick
Source
July 27, 2014
scala slick database relational

This code example shows how to setup sbt to use a customized Slick code-generator for working with an existing database schema.

How to get "Using a customized Slick code generator" on your computer

There are several ways to get this template.

Option 1: Choose slick-codegen-customization-example in the Typesafe Activator UI.

Already have Typesafe Activator (get it here)? Launch the UI then search for slick-codegen-customization-example in the list of templates.

Option 2: Download the slick-codegen-customization-example project as a zip archive

If you haven't installed Activator, you can get the code by downloading the template bundle for slick-codegen-customization-example.

  1. Download the Template Bundle for "Using a customized Slick code generator"
  2. Extract the downloaded zip file to your system
  3. The bundle includes a small bootstrap script that can start Activator. To start Typesafe Activator's UI:

    In your File Explorer, navigate into the directory that the template was extracted to, right-click on the file named "activator.bat", then select "Open", and if prompted with a warning, click to continue:

    Or from a command line:

     C:\Users\typesafe\slick-codegen-customization-example> activator ui 
    This will start Typesafe Activator and open this template in your browser.

Option 3: Create a slick-codegen-customization-example project from the command line

If you have Typesafe Activator, use its command line mode to create a new project from this template. Type activator new PROJECTNAME slick-codegen-customization-example on the command line.

Option 4: View the template source

The creator of this template maintains it at https://github.com/slick/slick-codegen-customization-example#master.

Option 5: Preview the tutorial below

We've included the text of this template's tutorial below, but it may work better if you view it inside Activator on your computer. Activator tutorials are often designed to be interactive.

Preview the tutorial

Using a customized Slick code generator

This code example shows how to setup sbt to use a customized Slick code-generator for working with an existing database schema. project/Build.scala enables automatically as well as manually triggered code-generation. codegen/CustomizedCodeGenerator.scala contains the code customizing Slick's code-generator. codegen/Config.scala contains some shared configuration code between the code-generator and the main project. src/main/scala/Example.scala uses the generated code. The code is generated into file target/scala-2.10/src_managed/slick/demo/Tables.scala. The location can be changed in the sbt script. It is usally wise to keep the generated Slick code under version control.

More info about Slick on http://slick.typesafe.com/docs/

comments powered by Disqus