komsit37/finatra-thrift-quill-example

Finatra-quill project template

Mainly taken from https://github.com/twitter/finatra/tree/develop/examples/thrift-server while adding quill db example code

Prerequisite

you'll need flyway command-line https://flywaydb.org/documentation/commandline/

C:\Users\pkomsit.FOLIO-SEC\dev\scala\folio\finatra-quill-template>flyway -v
Flyway 4.0.3 by Boxfuse

Setup

update db config in

• flyway.conf

then run below from command line

> flyway migrate //to create initial db schema
> sbt compile

to run server

sbt "thriftExampleServer/run"

to run test client

sbt "thriftExampleServer/test:runMain com.twitter.calculator.example.CalculatorClientExample"

to run unit test

> sbt test

Dependencies

• flyway - database versioning and migration
• finatra - framework for thrift server
  • guice - library for dependency injection
  • finagle - underlying RPC library used by finatra
• quill - library to generate sql from case class at compile time
• finagle-mysql - asynchronous mysql database connection library (kind of like jdbc, but it's asynchronous)
• scrooge-sbt-plugin - sbt plugin to generate scala code from thrift

Useful Docs

• finatra/finagle
  • https://github.com/twitter/finatra
  • https://github.com/twitter/finatra/tree/develop/examples/thrift-server
  • Futures in https://twitter.github.io/scala_school/finagle.html
  • https://twitter.github.io/finagle/guide/Quickstart.html
  • scrooge https://twitter.github.io/scrooge/SBTPlugin.html
• guice https://github.com/google/guice/wiki/Motivation
• scalatest
  • http://www.scalatest.org/user_guide/selecting_a_style we mainly use wordSpec style
  • http://www.scalatest.org/user_guide/using_matchers
• quill
  • http://getquill.io/
  • https://github.com/getquill/quill/tree/master/quill-finagle-mysql/src/test
• sbt http://www.scala-sbt.org/0.13/docs/Multi-Project.html
• flyway https://flywaydb.org/documentation/commandline/