mirror of
https://github.com/swift-server/RediStack.git
synced 2026-06-02 07:37:33 +00:00
Nathan Harris
0131fe43ba
Motivation: The goal of the `Redis.makeConnection` factory method is to provide end users with a quick way to jump in and get started with Redis in Swift. Right now, users have to provide an `EventLoopGroup` instance, when a reasonable default is available for us to define. Modifications: - Add: `MultiThreadedEventLoopGroup` for 1 thread as a default argument to the `using:` label in `Redis.makeConnection` - Remove: The `with:` label for the password in `Redis.makeConnection` - Change: The project README to reflect the current state of the project Results: Users should be able to create `RedisConnections` by just defining an IP Address & Port to connect to - and possibly a password. In addition, the README should now properly direct users on how to use the latest version of the library.
58 lines
2.2 KiB
Markdown
58 lines
2.2 KiB
Markdown
[](https://www.apache.org/licenses/LICENSE-2.0.html)
|
|
[](https://circleci.com/gh/Mordil/nio-redis/tree/master)
|
|
[](https://swift.org)
|
|
[](https://redis.io/download)
|
|
|
|
# NIORedis
|
|
|
|
A non-blocking Swift driver for [Redis](https://redis.io/) built with [SwiftNIO](https://github.com/apple/swift-nio).
|
|
|
|
This package defines everything you need to work with Redis through the [**Re**dis **S**eralization **P**rotocol (RESP)](https://redis.io/topics/protocol).
|
|
|
|
* Pitch discussion: [Swift Server Forums](https://forums.swift.org/t/swiftnio-redis-client/19325)
|
|
* Proposal: [SSWG-0004](https://github.com/swift-server/sswg/blob/d391da355718a8f396ef86b3563910089d5e5992/proposals/0004-nio-redis.md)
|
|
* [Discussion Thread](https://forums.swift.org/t/discussion-nioredis-nio-based-redis-driver/22455/)
|
|
|
|
## Installation
|
|
|
|
To install `NIORedis`, just add the package as a dependency in your [**Package.swift**](https://github.com/apple/swift-package-manager/blob/master/Documentation/PackageDescriptionV4.md#dependencies)
|
|
|
|
```swift
|
|
dependencies: [
|
|
.package(url: "https://github.com/Mordil/nio-redis.git", .upToNextMinor(from: "0.7.0")
|
|
]
|
|
```
|
|
|
|
and run the following command: `swift package resolve`
|
|
|
|
## Getting Started
|
|
|
|
`NIORedis` is ready to use right after installation.
|
|
|
|
```swift
|
|
import NIORedis
|
|
|
|
let connection = Redis.makeConnection(
|
|
to: try .init(ipAddress: "127.0.0.1", port: 6379),
|
|
password: "my_pass"
|
|
).wait()
|
|
|
|
let result = try connection.set("my_key", to: "some value")
|
|
.flatMap { return connection.get("my_key" }
|
|
.wait()
|
|
|
|
print(result) // Optional("some value")
|
|
```
|
|
|
|
## Contributing
|
|
|
|
Check out [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to help with NIORedis.
|
|
|
|
It is highly recommended to use [Docker](https://docker.com) to install Redis locally.
|
|
|
|
```bash
|
|
docker run -d -p 6379:6379 --name nioredis redis:5
|
|
```
|
|
|
|
Otherwise, install Redis directly on your machine from [Redis.io](https://redis.io/download).
|