Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mbannour/zio-mongodb
ZIO wrapper for MongoDB Reactive Streams Java Driver and MongoDb scala Driver
https://github.com/mbannour/zio-mongodb
mongodb scala zio zio-streams
Last synced: 5 days ago
JSON representation
ZIO wrapper for MongoDB Reactive Streams Java Driver and MongoDb scala Driver
- Host: GitHub
- URL: https://github.com/mbannour/zio-mongodb
- Owner: mbannour
- License: apache-2.0
- Created: 2021-09-25T19:37:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-25T08:38:39.000Z (3 months ago)
- Last Synced: 2024-11-25T09:29:08.736Z (3 months ago)
- Topics: mongodb, scala, zio, zio-streams
- Language: Scala
- Homepage:
- Size: 114 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![Snapshots][ziomongo]][Scala version support]
[![Snapshots][ziomongo jvm]][Scala version support]
# zio-mongo
ZIO wrapper for MongoDB Reactive Streams Java Driver.
### Dependencies
Support scala `12.12` and `12.13`
```scala
libraryDependencies += "io.github.mbannour" %% "ziomongo" % "0.0.7"
```
### Link
[ZIO-HTTP-MongoDB](https://github.com/mbannour/ZIO-Http-MongoDB): A simple project using ZIO-mongoDB and ZIO-HTTP
### Documentation
#### Query the Collection
To return all the documents in the collection, you can use `find().fetch` without any parameters.
The query will return an Iterator of documents which allows to not load all the documents im memory.
The following example for getting all the documents.
```scala
val collection: Task[MongoZioCollection[Document]] = ???
val result : Task[Iterator[Document]] = collection.flatMap(_.find().fetch)
```
To return only the first document in the collection, you can either use `find().first().fetch` or `find().head`.
The first returned document can be null, for that you have the choice to get optional result with using either `find().first().headOption` or `find().headOption`
The following example for getting the first document.
```scala
val firstDocument : Task[Document] = collection.flatMap(_.find().first().fetch)
val head : Task[Document] = collection.flatMap(_.find().head)
val maybeFirstDocument : Task[Option[Document]] = collection.flatMap(_.find().first().headOption)
val maybeHead :Task[Option[Document]] = collection.flatMap(_.find().headOption)
```
Example of using mongoDB with ZIO
```scala
import io.github.mbannour.MongoZioClient
import zio._
import org.mongodb.scala.bson.codecs.Macros._
import org.bson.codecs.configuration.CodecRegistries.{ fromProviders, fromRegistries }
import org.mongodb.scala.MongoClient.DEFAULT_CODEC_REGISTRY
import org.mongodb.scala.bson.ObjectId
import org.mongodb.scala.model.Filters.equal
import org.mongodb.scala.model.Updates.set
object CaseClassExample extends zio.ZIOAppDefault {
case class Person(_id: ObjectId, name: String, lastName: String, age: Int)
val persons: Seq[Person] = Seq(
Person(new ObjectId(), "Charles", "Babbage", 34),
Person(new ObjectId(), "George", "Boole", 19),
Person(new ObjectId(), "Gertrude", "Blanch", 74),
Person(new ObjectId(), "Grace", "Hopper", 14),
Person(new ObjectId(), "Ida", "Rhodes", 30),
Person(new ObjectId(), "Jean", "Bartik", 22),
Person(new ObjectId(), "John", "Backus", 56),
Person(new ObjectId(), "Lucy", "Sanders", 51),
Person(new ObjectId(), "Tim", "Berners Lee", 46),
Person(new ObjectId(), "Zaphod", "Beeblebrox", 15)
)
val codecRegistry = fromRegistries(fromProviders(classOf[Person]), DEFAULT_CODEC_REGISTRY)
val collection = MongoZioClient.autoCloseableClient("mongodb://localhost:27017").map { client =>
val database = client.getDatabase("mydb").withCodecRegistry(codecRegistry)
database.getCollection[Person]("test")
}
val app = ZIO.scoped {
for {
col <- collection
_ <- col.insertMany(persons)
_ <- col.find().first().fetch
_ <- col.find(equal("name", "Ida")).first().fetch
_ <- col.updateOne(equal("name", "Jean"), set("lastName", "Bannour"))
_ <- col.deleteOne(equal("name", "Zaphod"))
count <- col.countDocuments()
person <- col.find(equal("name", "Jean")).first().headOption
_ <- ZIO.attempt(println(s"Persons count: $count"))
_ <- ZIO.attempt(println(s"The updated person with name Jean is: $person"))
} yield ()
}
override def run: URIO[Any, ExitCode] = app.exitCode
}
```
zio-mongo allows you to query a stream of document with using ZMongoSource:
Here an example of using mongoDB with ZIO streams:
```scala
import com.mongodb.reactivestreams.client.MongoClients
import io.github.mbannour.reactivestreams.ZMongoSource
import zio._
import org.mongodb.scala.bson.codecs.Macros._
import org.bson.codecs.configuration.CodecRegistries.{ fromProviders, fromRegistries }
import org.mongodb.scala.MongoClient.DEFAULT_CODEC_REGISTRY
import org.mongodb.scala.bson.ObjectId
import org.mongodb.scala.model.Filters.equal
import org.mongodb.scala.model.Updates.set
import zio.stream.{ ZSink, ZStream }
object ZIOSourceStreamExample extends zio.ZIOAppDefault {
case class Person(_id: ObjectId, name: String, lastName: String, age: Int)
val persons: Seq[Person] = Seq(
Person(new ObjectId(), "Charles", "Babbage", 34),
Person(new ObjectId(), "George", "Boole", 19),
Person(new ObjectId(), "Gertrude", "Blanch", 74),
Person(new ObjectId(), "Grace", "Hopper", 14),
Person(new ObjectId(), "Ida", "Rhodes", 30),
Person(new ObjectId(), "Jean", "Bartik", 22),
Person(new ObjectId(), "John", "Backus", 56),
Person(new ObjectId(), "Lucy", "Sanders", 51),
Person(new ObjectId(), "Tim", "Berners Lee", 46),
Person(new ObjectId(), "Zaphod", "Beeblebrox", 15)
)
val codecRegistry = fromRegistries(fromProviders(classOf[Person]), DEFAULT_CODEC_REGISTRY)
val zioCollection =
ZIO.fromAutoCloseable(ZIO.attempt(MongoClients.create("mongodb://localhost:27017"))).map { client =>
val db = client.getDatabase("mydb").withCodecRegistry(codecRegistry)
db.getCollection("test", classOf[Person])
}
//The bufferSize used as internal buffer. If possible, set to a power of 2 value for best performance.
val bufferSize = 16
val app = ZIO.scoped {
(for {
collection <- ZStream.fromZIO(zioCollection)
_ <- ZMongoSource.insertMany(collection, persons)
firstPerson <- ZMongoSource(collection.find().first(), bufferSize = 16)
_ <- ZStream.fromZIO(ZIO.attempt(println(s"First saved person: $firstPerson")))
_ <- ZMongoSource(collection.updateOne(equal("name", "Jean"), set("lastName", "Bannour")))
_ <- ZMongoSource(collection.deleteOne(equal("name", "Zaphod")))
count <- ZMongoSource(collection.countDocuments(), bufferSize = 16)
person <- ZMongoSource(collection.find(equal("name", "Jean")).first())
_ <- ZStream.fromZIO(ZIO.attempt(println(s"Persons count: $count")))
_ <- ZStream.fromZIO(ZIO.attempt(println(s"The updated person with name Jean is: $person")))
} yield ()).run(ZSink.head)
}
override def run: URIO[Any, ExitCode] = app.exitCode
}
```
[Scala version support]: https://index.scala-lang.org/mbannour/zio-mongodb/ziomongo
[ziomongo]: https://index.scala-lang.org/mbannour/zio-mongodb/ziomongo/latest.svg
[ziomongo jvm]: https://index.scala-lang.org/mbannour/zio-mongodb/ziomongo/latest-by-scala-version.svg?platform=jvm