https://github.com/itpey/remo
in-memory key-value storage with expiration capabilities.
https://github.com/itpey/remo
database go high-performance in-memory in-memory-caching inmemory-db key-value memory redis storage ttl
Last synced: 4 months ago
JSON representation
in-memory key-value storage with expiration capabilities.
- Host: GitHub
- URL: https://github.com/itpey/remo
- Owner: itpey
- License: apache-2.0
- Created: 2023-10-20T09:58:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-26T19:28:24.000Z (about 1 year ago)
- Last Synced: 2025-01-15T15:00:23.069Z (5 months ago)
- Topics: database, go, high-performance, in-memory, in-memory-caching, inmemory-db, key-value, memory, redis, storage, ttl
- Language: Go
- Homepage: https://github.com/itpey/remo
- Size: 20.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[//]: # "Attendees: itpey"
[//]: # "Tags: #itpey #go #remo #golang #go-lang #n-memory #key-value #storage"
Remo
Remo is a Go package that provides in-memory key-value storage with expiration capabilities. It is designed to be a simple and efficient way to manage data with an optional time-to-live duration for keys.
# Features
- In-memory key-value storage with optional TTL (time-to-live).
- Thread-safe operations with efficient read and write locking.
- Automatic cleanup of expired keys.
- Simple and straightforward API.
# Installation
You can install Remo using the Go module system:
```bash
go get github.com/itpey/remo
```
# Usage
## Creating a Storage Instance
To get started, create a new instance of the Storage struct:
```go
store := remo.New()
```
## Setting and Retrieving Values
You can use the `Set` and `Get` methods to store and retrieve key-value pairs, with the option to set a time-to-live (TTL) duration for keys.
### Setting a Key with No Expiration
To set a key with no expiration, simply pass a TTL of 0:
```go
// Set a key with a value and no expiration
store.Set("myKey", "myValue", 0)
```
### Setting a Key with a Specific TTL
You can also set a key with a specific TTL duration, which represents the time the key will be retained in the storage. For example, to set a key that expires in 30 minutes:
```go
// Set a key with a value and a 30-minute TTL
store.Set("myKey", "myValue", 30 * time.Minute)
```
### Retrieving a Value
To retrieve a value by key, use the `Get` method. It returns the value associated with the key and an error if the key does not exist or has expired:
```go
value, err := store.Get("myKey")
if err != nil {
// Handle error (e.g., key not found or key has expired)
} else {
// Use the retrieved value
}
```
## Deleting Keys
You can delete keys using the `Delete` method:
```go
store.Delete("myKey")
```
## Automatic Cleanup
Remo includes an automatic cleanup feature that removes expired keys at a specified interval. You can start and stop this feature using the following methods:
```go
// Start automatic cleanup (e.g., every 10 minutes)
store.StartCleanup(10 * time.Minute)
// Stop automatic cleanup
store.StopCleanup()
```
## Resetting the Storage
Remo provides a convenient `Reset` method that allows you to clear all keys from the storage. This is useful when you need to start with an empty key-value store. Here's how to use the `Reset` method:
```go
store.Reset()
```
# Running Tests
To run tests for Remo, use the following command:
```bash
go test github.com/itpey/remo
```
# Running Benchmarks
To run benchmarks for Remo, use the following command:
```bash
go test -bench=. github.com/itpey/remo
```
# Feedback and Contributions
If you encounter any issues or have suggestions for improvement, please [open an issue](https://github.com/itpey/remo/issues) on GitHub.
We welcome contributions! Fork the repository, make your changes, and submit a pull request.
# License
Remo is open-source software released under the Apache License, Version 2.0. You can find a copy of the license in the [LICENSE](https://github.com/itpey/remo/blob/main/LICENSE) file.
# Author
Chunker was created by [itpey](https://github.com/itpey)