Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/simerplaha/SwayDB

Persistent and in-memory key-value storage engine for JVM that scales on a single machine.
https://github.com/simerplaha/SwayDB

database embeddable in-memory java jvm key-value-store kotlin multiple-disks persistent scala storage-engine type-safe

Last synced: 3 months ago
JSON representation

Persistent and in-memory key-value storage engine for JVM that scales on a single machine.

Host: GitHub
URL: https://github.com/simerplaha/SwayDB
Owner: simerplaha
License: apache-2.0
Created: 2018-02-11T13:33:26.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2023-09-23T15:47:00.000Z (about 1 year ago)
Last Synced: 2024-05-20T22:14:59.034Z (6 months ago)
Topics: database, embeddable, in-memory, java, jvm, key-value-store, kotlin, multiple-disks, persistent, scala, storage-engine, type-safe
Language: Scala
Homepage: https://swaydb.simer.au
Size: 19.9 MB
Stars: 290
Watchers: 16
Forks: 15
Open Issues: 83
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-zio - SwayDB - memory database](http://www.SwayDB.io) (NoSQL)

README

        #  SwayDB [![Gitter Chat][gitter-badge]][gitter-link] [![Build status][build-badge]][build-link] [![Maven central][maven-badge]][maven-link]

[gitter-badge]: https://badges.gitter.im/Join%20Chat.svg

[gitter-link]: https://gitter.im/SwayDB-chat/Lobby

[maven-badge]: https://img.shields.io/maven-central/v/io.swaydb/swaydb_2.12.svg

[maven-link]: https://search.maven.org/search?q=g:io.swaydb%20AND%20a:swaydb_2.12

[build-badge]: https://github.com/simerplaha/SwayDB/workflows/Build/badge.svg

[build-link]: https://github.com/simerplaha/SwayDB/actions

**Persistent** and **in-memory** key-value storage engine for the JVM aimed at high performance & resource efficiency.

**Small footprint**: around 7.1 MB jar size. No external core

dependency ([#307](https://github.com/simerplaha/SwayDB/issues/307)).

**Scalable on a single machine**: Distribute data on multiple local SSDs. Allocate single or multiple `Threads`

for reads, caching & compaction.

**Branches**: This is the `master` branch. See [`develop`](https://github.com/simerplaha/SwayDB/tree/develop) for

latest (unstable).

**Status**: Under testing & performance optimisations. See [project status](#Project-status).

[Documentation](https://swaydb.simer.au)

# Sponsors

Thank you [JetBrains](https://www.jetbrains.com/?from=SwayDB)

& [JProfiler](https://www.ej-technologies.com/products/jprofiler/overview.html)

for full-featured open-source licences to their awesome development tools!

  

    

    

    [Become a sponsor]

  

## Overview

- Simple data types - `Map`, `Set`, `Queue`, `SetMap` & `MultiMap` with native Java and Scala collections support.

- Conditional updates using any pure [JVM function](https://swaydb.simer.au/api/pure-functions/?language=java) - **No query

  language**.

- Atomic updates and inserts with `Transaction` API.

- **Non-blocking core** with configurable APIs for blocking, non-blocking and/or reactive use-cases.

- Single or multiple disks persistent, in-memory or eventually persistent.

- [Streams](https://swaydb.simer.au/api/stream/?language=java) - Async & sync forward and reverse data streaming/iteration.

- TTL - non-blocking, non-polling asynchronous auto [expiring](https://swaydb.simer.au/api/expire/?language=java) key-values.

- Range operations to update, remove & expire a range of key-values.

- Key only iterations (Lazily fetched values).

- [Configurable compression](https://swaydb.simer.au/configuration/compressions/?language=scala) with LZ4 & Snappy

- Configurable core internals to support custom workloads.

- Duplicate values elimination

  with [compressDuplicateValues](https://swaydb.simer.au/configuration/valuesConfig/?language=scala).

## Use cases

Highly configurable to suit **different workloads**. Some known use-cases are:

- General key-value storage

- Message queues

- Time-series or Events data

- Caching

- Application logs

- Archiving data or cold storage with high file level compression

## Quick start

- [Java - Quick start](https://swaydb.simer.au/quick-start/?language=java&data-type=map&functions=off)

- [Scala - Quick start](https://swaydb.simer.au/quick-start/?language=scala&data-type=map&functions=off)

- [Kotlin - Quick start](https://github.com/simerplaha/SwayDB.kotlin.examples/blob/master/src/main/kotlin/quickstart/QuickStartMapSimple.kt)

## Contributing

Contributions are encouraged and welcomed. We are here to help and answer any questions.

**Code of conduct** - Be nice, welcoming, friendly & supportive of each other. Follow the Apache

foundation's [COC](https://www.apache.org/foundation/policies/conduct.html).

- **Contributing to data management API**

    - Build new data structures extending existing data structures.

      See [MultiMap](https://github.com/simerplaha/SwayDB/blob/master/swaydb/src/main/scala/swaydb/MultiMap.scala)

      for example which is an extension

      of [Map](https://github.com/simerplaha/SwayDB/blob/master/swaydb/src/main/scala/swaydb/Map.scala).

        - Graph

        - List

        - Geospatial

        - Logs

        - Observables

        - Full-text search

        - etc

    - Add support for external serialising, streaming & compression libraries.

    - Test and improve existing data structures.

- **Contributing to core API**

    - See issues

      labelled [good first issue](https://github.com/simerplaha/SwayDB/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)

      .

- **Contributing to core internals**

    - See code marked `TODO`.

    - Pick any small section to improve. You will find that everything is a function and can be unit-tested

      independently, so you can easily pick anything to work on.

## Project status

Under testing & performance optimisations.

Your feedback and support is very important to get to production. Please get involved

via [chat](https://gitter.im/SwayDB-chat/Lobby), [discussion](https://github.com/simerplaha/SwayDB/discussions),

[issues](https://github.com/simerplaha/SwayDB/issues)

or by [becoming a sponsor](https://github.com/sponsors/simerplaha).

Future releases might not be backward compatible until we are production ready.

See tasks labelled [Production release](https://github.com/simerplaha/SwayDB/labels/Production%20release)

that are required before becoming production ready.

## Related GitHub projects

- [SwayDB.java.examples](https://github.com/simerplaha/SwayDB.java.examples) - Java examples demonstrating features and

  APIs.

- [SwayDB.kotlin.examples](https://github.com/simerplaha/SwayDB.kotlin.examples) - Kotlin examples demonstrating

  features and APIs.

- [SwayDB.scala.examples](https://github.com/simerplaha/SwayDB.scala.examples) - Scala examples demonstrating features

  and APIs.

- [SwayDB.benchmark](https://github.com/simerplaha/SwayDB.benchmark) - Performance benchmarks.