Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zio/zio-sqs
ZIO-powered client for AWS SQS
https://github.com/zio/zio-sqs
aws-sdk connector functional-programming scala sqs stream zio
Last synced: about 2 months ago
JSON representation
ZIO-powered client for AWS SQS
- Host: GitHub
- URL: https://github.com/zio/zio-sqs
- Owner: zio
- License: apache-2.0
- Created: 2019-05-01T09:30:45.000Z (over 5 years ago)
- Default Branch: series/2.x
- Last Pushed: 2024-05-08T13:55:33.000Z (4 months ago)
- Last Synced: 2024-05-20T22:15:01.370Z (4 months ago)
- Topics: aws-sdk, connector, functional-programming, scala, sqs, stream, zio
- Language: Scala
- Homepage: https://zio.dev/zio-sqs
- Size: 452 KB
- Stars: 82
- Watchers: 5
- Forks: 25
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- awesome-zio - ZIO SQS - powered client for AWS SQS (Official ZIO Libraries)
README
[//]: # (This file was autogenerated using `zio-sbt-website` plugin via `sbt generateReadme` command.)
[//]: # (So please do not edit it manually. Instead, change "docs/index.md" file or sbt setting keys)
[//]: # (e.g. "readmeDocumentation" and "readmeSupport".)
# ZIO SQS
[ZIO SQS](https://zio.dev/zio-sqs) is a ZIO-powered client for AWS SQS. It is built on top of the [AWS SDK for Java 2.0](https://docs.aws.amazon.com/sdk-for-java/v2/developer-guide/basics.html) via the automatically generated wrappers from [zio-aws](https://zio.dev/zio-aws).
[](https://github.com/zio/zio/wiki/Project-Stages)  [](https://oss.sonatype.org/content/repositories/releases/dev/zio/zio-sqs_2.13/) [](https://oss.sonatype.org/content/repositories/snapshots/dev/zio/zio-sqs_2.13/) [](https://javadoc.io/doc/dev.zio/zio-sqs_2.13) [](https://github.com/zio/zio-sqs)
## Introduction
ZIO SQS enables us to produce and consume elements to/from the Amazon SQS service. It is integrated with ZIO Streams, so we can produce and consume elements in a streaming fashion, element by element or micro-batching.
## Installation
In order to use this library, we need to add the following line in our `build.sbt` file:
```scala
libraryDependencies += "dev.zio" %% "zio-sqs" % "0.5.0"
```
## Example
In this example we produce a stream of events to the `MyQueue` and then consume them from that queue:
```scala
import zio._
import zio.aws.core.config.AwsConfig
import zio.aws.netty.NettyHttpClient
import zio.aws.sqs.Sqs
import zio.sqs.producer.{Producer, ProducerEvent}
import zio.sqs.serialization.Serializer
import zio.sqs.{SqsStream, SqsStreamSettings, Utils}
import zio.stream.ZStream
object ProducerConsumerExample extends ZIOAppDefault {
val queueName = "MyQueue"
val stream: ZStream[Any, Nothing, ProducerEvent[String]] =
ZStream.iterate(0)(_ + 1).map(_.toString).map(ProducerEvent(_))
val program: ZIO[Sqs, Throwable, Unit] = for {
_ <- Utils.createQueue(queueName)
queueUrl <- Utils.getQueueUrl(queueName)
producer = Producer.make(queueUrl, Serializer.serializeString)
_ <- ZIO.scoped(producer.flatMap(_.sendStream(stream).runDrain))
_ <- SqsStream(
queueUrl,
SqsStreamSettings(stopWhenQueueEmpty = true, waitTimeSeconds = Some(3))
).foreach(msg => Console.printLine(msg.body))
} yield ()
def run =
program.provide(
Sqs.live,
AwsConfig.default,
NettyHttpClient.default
)
}
```
## Documentation
Learn more on the [ZIO SQS homepage](https://zio.dev/zio-sqs)!
## Contributing
For the general guidelines, see ZIO [contributor's guide](https://zio.dev/about/contributing).
## Code of Conduct
See the [Code of Conduct](https://zio.dev/about/code-of-conduct)
## Support
Come chat with us on [![Badge-Discord]][Link-Discord].
[Badge-Discord]: https://img.shields.io/discord/629491597070827530?logo=discord "chat on discord"
[Link-Discord]: https://discord.gg/2ccFBr4 "Discord"
## License
[License](LICENSE)