https://github.com/dimensional-fun/kedis

🗃️ kotlin multi-platform redis client.
https://github.com/dimensional-fun/kedis

kotlin kotlin-coroutines kotlin-multiplatform ktor redis redis-client

Last synced: 3 months ago
JSON representation

🗃️ kotlin multi-platform redis client.

• Host: GitHub
• URL: https://github.com/dimensional-fun/kedis
• Owner: dimensional-fun
• License: apache-2.0
• Created: 2022-03-26T20:08:26.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-14T05:15:33.000Z (over 2 years ago)
• Last Synced: 2025-02-19T16:51:57.743Z (3 months ago)
• Topics: kotlin, kotlin-coroutines, kotlin-multiplatform, ktor, redis, redis-client
• Language: Kotlin
• Homepage: https://discord.gg/8R4d8RydT4
• Size: 134 KB
• Stars: 8
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🗃️ Kedis - A Kotlin Redis client.

A very experimental Redis client that is written in [Kotlin](https://kotlinlang.org/)

- [**Discord Server**](https://mixtape.systems/development)

## 🚀 Installation

#### 🐘 Install w/ Gradle

```kt

repositories {

    maven("https://maven.dimensional.fun/releases")

}

dependencies {

    implementation("mixtape.oss.kedis:kedis-core:{VERSION}")

}

```

#### 🪶 Install w/ Maven

```xml

    

        dimensional-maven

        Dimensional Maven

        https://maven.dimensional.fun/releases

    

    

        mixtape.oss.kedis

        kedis-core

        {VERSION}

    

```

## 💻 Usage

#### Getting a Redis client

You can get a Redis client in two ways:

1. Creating an instance of `RedisClient` yourself:

```kt

val client = RedisClient("redis://127.0.0.1")

```

2. Using a `RedisPool`:

```kt

val pool = RedisPool(

    uri = "redis://127.0.0.1",

    initialSize = 5,

    maxSize = 10,

    maxWaitTime = 5000

)

pool.use { redis: RedisClient ->

    // do stuff with the RedisClient

}

```

---

Mixtape Bot 2019-2022