https://github.com/aselab/scala-activerecord

ActiveRecord-like ORM library for Scala
https://github.com/aselab/scala-activerecord

activerecord orm scala scala-activerecord

Last synced: 6 days ago
JSON representation

ActiveRecord-like ORM library for Scala

• Host: GitHub
• URL: https://github.com/aselab/scala-activerecord
• Owner: aselab
• License: mit
• Created: 2012-04-10T04:26:31.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2021-01-08T00:05:38.000Z (almost 4 years ago)
• Last Synced: 2024-10-22T14:39:11.948Z (14 days ago)
• Topics: activerecord, orm, scala, scala-activerecord
• Language: Scala
• Homepage:
• Size: 6.65 MB
• Stars: 322
• Watchers: 35
• Forks: 31
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: MIT-LICENSE.txt

Awesome Lists containing this project

• awesome-scala - Scala ActiveRecord ★ 297 ⧗ 3 - ORM library for scala, inspired by ActiveRecord of Ruby on Rails. (Database)
• awesome-scala - scala-activerecord - like ORM library for Scala |   (Table of Contents / Database)

README

        
# Scala ActiveRecord [![maven central](https://maven-badges.herokuapp.com/maven-central/com.github.aselab/scala-activerecord_2.13/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.aselab/scala-activerecord_2.13) [![javadoc](http://javadoc-badge.appspot.com/com.github.aselab/scala-activerecord_2.13.svg?label=scaladoc)](http://javadoc-badge.appspot.com/com.github.aselab/scala-activerecord_2.13/com/github/aselab/activerecord/index.html?javadocio=true)

scala-activerecord is an ORM library for Scala.

This library is inspired by ActiveRecord of Ruby on Rails.

It is designed following the CoC(Convention over Configuration), DRY(Don't Repeat Yourself) principles.

## Minimal example

* Sample snippet: **[Scastie](https://scastie.scala-lang.org/N5fy1pUZRWWqq8cwLHCgeQ)**

Model implementation:

```scala

package models

import com.github.aselab.activerecord._

import com.github.aselab.activerecord.dsl._

case class Person(name: String, age: Int) extends ActiveRecord

object Person extends ActiveRecordCompanion[Person]

```

Schema definition:

```scala

package models

import com.github.aselab.activerecord._

import com.github.aselab.activerecord.dsl._

object Tables extends ActiveRecordTables {

  val people = table[Person]

}

```

ActiveRecord model usage:

```scala

import com.github.aselab.activerecord.dsl._

import models._

import scala.language.postfixOps

object App extends App {

  Tables.initialize

  

  Person("person1", 25).save()

  Person("person2", 18).save()

  Person("person3", 40).save()

  Person("person4", 18).save()

  Person.findBy("name", "person1") //=> Some(Person("person1", 25))

  Person.findBy("age", 55) //=> None

  Person.findAllBy("age", 18).toList //=> List(Person("person2", 18), Person("person4", 18))

  Person.where(_.age.~ >= 20).orderBy(_.age desc).toList //=> List(Person("person3", 40), Person("person1", 25))

  

  Tables.cleanup

}

```

Schema and query DSL is based on [Squeryl](http://squeryl.org/).

## Features

* Auto connection management

* Composable query operation

* Callback

* Validation

* Association

## Documents and other resources

* [Wiki](https://github.com/aselab/scala-activerecord/wiki)

* [Documentation(WIP) 日本語/English](https://aselab.github.io/docs/scala-activerecord/)

* [ScalaDoc](http://javadoc-badge.appspot.com/com.github.aselab/scala-activerecord_2.13/com/github/aselab/activerecord/index.html?javadocio=true)

* [Sample project](https://github.com/aselab/scala-activerecord-sample)

## Web framework support

* [Play 2.x plugin](https://github.com/aselab/scala-activerecord/tree/master/play2)

* [Scalatra 2.7.x plugin](https://github.com/aselab/scala-activerecord/tree/master/scalatra)

## License

MIT