Simple key-value storage with support for multiple backends

How to Use the Keyv Mono Repo

Keyv and its storage adapters are in this mono repo and there are details below on how to use this repository. In addtion we have a couple of other documents for review:

• CODE_OF_CONDUCT - Our code of conduct
• CONTRIBUTING - How to contribute to this project
• SECURITY - Security guidelines and supported versions

Getting Started

Keyv is a simple key-value storage system that supports multiple backends. It's designed to be a simple and consistent way to work with key-value stores.

To learn how to use Keyv, check out the keyv README. To learn how to use a specific storage adapter, check out the README for that adapter under Storage Adapters.

Open a Pull Request

You can contribute changes to this repo by opening a pull request:

1. After forking this repository to your Git account, make the proposed changes on your forked branch.
2. Run tests and linting locally.
   • Install and run Docker if you aren't already. NOTE: on docker set enable host networking to true as it is required for the tests in redis clustering.
   • Run pnpm test:services:start, allow for the services to come up.
   • Run pnpm test.
3. Commit your changes and push them to your forked repository.
4. Navigate to the main keyv repository and select the Pull Requests tab.
5. Click the New pull request button, then select the option "Compare across forks"
6. Leave the base branch set to main. Set the compare branch to your forked branch, and open the pull request.
7. Once your pull request is created, ensure that all checks have passed and that your branch has no conflicts with the base branch. If there are any issues, resolve these changes in your local repository, and then commit and push them to git.
8. Similarly, respond to any reviewer comments or requests for changes by making edits to your local repository and pushing them to Git.
9. Once the pull request has been reviewed, those with write access to the branch will be able to merge your changes into the keyv repository.

If you need more information on the steps to create a pull request, you can find a detailed walkthrough in the Github documentation

Post an Issue

To post an issue, navigate to the "Issues" tab in the main repository, and then select "New Issue." Enter a clear title describing the issue, as well as a description containing additional relevant information. Also select the label that best describes your issue type. For a bug report, for example, create an issue with the label "bug." In the description field, Be sure to include replication steps, as well as any relevant error messages.

If you're reporting a security violation, be sure to check out the project's security policy.

Please also refer to our Code of Conduct for more information on how to report issues.

Ask a Question

To ask a question, create an issue with the label "question." In the issue description, include the related code and any context that can help us answer your question.

Request the Addition of a Storage Adapter

To request a new storage adapter, create an issue with the label "storage adapter." In the issue description, include any relevant information about the storage adapter that you would like to be added.

Once this request has been submitted in "issues" we will give it 30-60 days for any upvotes to take place. If there is little interest in the request, it will be closed.

If there is already an adapter that you would like to add, please post an issue with the label "storage adapter" and include the name of the adapter you would like to add with the description and any relevant information.

Packages in this Repository

• keyv: Simple key-value storage with support for multiple backends
• test-suite: Test suite for Keyv API compliance

Storage Adapters

• etcd: Etcd storage adapter
• memcache: Memcache storage adapter
• mongo: MongoDB storage adapter
• mysql: MySQL/MariaDB storage adapter
• postgres: PostgreSQL storage adapter
• redis: Redis storage adapter
• valkey: Valkey (Open Source Redis) storage adapter
• sqlite: SQLite storage adapter
• tiered: Tiered storage adapter to manage local and remote storage as one

Compression Adapters

• brotli: Brotli compression adapter
• Gzip: Gzip compression adapter

Third-party Storage Adapters

Here are the storage adapters that are not in this repository but compatible with Keyv.

• quick-lru - Simple "Least Recently Used" (LRU) cache
• keyv-file - File system storage adapter for Keyv
• keyv-dynamodb - DynamoDB storage adapter for Keyv
• keyv-lru - LRU storage adapter for Keyv
• keyv-null - Null storage adapter for Keyv
• keyv-firestore – Firebase Cloud Firestore adapter for Keyv
• keyv-mssql - Microsoft Sql Server adapter for Keyv
• keyv-azuretable - Azure Table Storage/API adapter for Keyv
• keyv-arango - ArangoDB storage adapter for Keyv
• keyv-momento - Momento storage adapter for Keyv
• keyv-upstash - Upstash Redis adapter for Keyv
• @resolid/keyv-sqlite - A new SQLite storage adapter for Keyv

License

MIT © Jared Wray