Categorygithub.com/albanul/go-logdb
repository
0.0.0-20240406080816-5d34004c6bdd
Repository: https://github.com/albanul/go-logdb.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

go-logdb

License

After reading Mark Kleppmann's book, "Designing Data-Intensive Applications", I felt inspired to develop my own append-only file-based database. This database is designed to efficiently store and retrieve key-value pairs.

Features

  • Store key-value data in database
  • Fetch data by a key
  • In-memory index
  • Binary format
  • Database compaction
  • Delete a record
  • Store index on a disk
  • Index rebuild
  • Partially written records
  • Concurrency control

Installation [WIP]

Instructions for how to install the project and any necessary dependencies go here.

Usage [WIP]

Instructions for how to use the project and example code snippets go here.

// Example code snippet

Documentation [WIP]

Detailed documentation and API reference can be found here.

Contributing

Contributions are welcome! If you'd like to contribute to this project, please follow these steps:

  1. Fork the repository.
  2. Create a new branch.
  3. Make your changes.
  4. Write tests for your changes if applicable.
  5. Run the tests and ensure they pass.
  6. Commit your changes and push them to your forked repository.
  7. Open a pull request, describing the changes you've made.

Please follow the project's code of conduct while contributing.

Issues

If you encounter any issues or have suggestions for improvements, please create an issue.

License

This project is licensed under the MIT License.