Code Monkey home page Code Monkey logo

mongo4cats's Introduction

mongo4cats

Cats friendly

Mongo DB client wrapper compatible with Cats Effect ans Fs2. Available for Scala 2.12, 2.13 and 3.0.

Dependencies

Add this to your build.sbt (depends on cats-effect and FS2):

libraryDependencies += "io.github.kirill5k" %% "mongo4cats-core" % "0.2.9"
libraryDependencies += "io.github.kirill5k" %% "mongo4cats-circe" % "0.2.9" // circe support

Quick Start Examples

Working with plain JSON

import cats.effect.{IO, IOApp}
import com.mongodb.client.model.{Filters, Updates}
import mongo4cats.client.MongoClientF
import org.bson.Document

object DocumentFindAndUpdate extends IOApp.Simple {

  val json =
    """{
      |"firstName": "John",
      |"lastName": "Bloggs",
      |"dob": "1970-01-01"
      |}""".stripMargin

  val run: IO[Unit] =
    MongoClientF.fromConnectionString[IO]("mongodb://localhost:27017").use { client =>
      for {
        db      <- client.getDatabase("testdb")
        coll    <- db.getCollection("jsoncoll")
        _       <- coll.insertOne[IO](Document.parse(json))
        filterQuery = Filters.eq("lastName", "Bloggs")
        updateQuery = Updates.set("dob", "2020-01-01")
        old     <- coll.findOneAndUpdate[IO](filterQuery, updateQuery)
        updated <- coll.find.first[IO]
        _       <- IO.println(s"old: ${old.toJson()}\nupdated: ${updated.toJson()}")
      } yield ()
    }
}

Working with documents

import cats.effect.{IO, IOApp}
import com.mongodb.client.model.{Filters, Sorts}
import mongo4cats.client.MongoClientF
import org.bson.Document

object FilteringAndSorting extends IOApp.Simple {

  def genDocs(n: Int): Seq[Document] =
    (0 to n).map(i => new Document("name", s"doc-$i"))

  override val run: IO[Unit] =
    MongoClientF.fromConnectionString[IO]("mongodb://localhost:27017").use { client =>
      for {
        db   <- client.getDatabase("testdb")
        coll <- db.getCollection("docs")
        _    <- coll.insertMany[IO](genDocs(10))
        docs <- coll.find
          .filter(Filters.regex("name", "doc-[2-7]"))
          .sort(Sorts.descending("name"))
          .limit(5)
          .all[IO]
        _ <- IO.println(docs)
      } yield ()
    }
}

Using circe for encoding and decoding documents into case classes

Only mongo4cats-circe is required for basic interop with circe:

libraryDependencies += "io.github.kirill5k" %% "mongo4cats-circe" % "0.2.9"

In order to obtain mongo collection with circe codecs, the following import is required:

import mongo4cats.circe._

The complete working example is presented below

import cats.effect.{IO, IOApp}
import io.circe.generic.auto._
import mongo4cats.client.MongoClientF
import mongo4cats.circe._

import java.time.Instant

object Example extends IOApp.Simple {

  final case class Address(city: String, country: String)
  final case class Person(firstName: String, lastName: String, address: Address, registrationDate: Instant)

  val run: IO[Unit] =
    MongoClientF.fromConnectionString[IO]("mongodb://localhost:27017").use { client =>
      for {
        db   <- client.getDatabase("testdb")
        coll <- db.getCollectionWithCirceCodecs[Person]("people")
        _    <- coll.insertOne[IO](Person("John", "Bloggs", Address("New-York", "USA"), Instant.now()))
        docs <- coll.find.stream[IO].compile.toList
        _    <- IO.println(docs)
      } yield ()
    }
}

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.