Liking cljdoc? Tell your friends :D

Deta Base Clojure Library

Deta Base is a Clojure library designed to simplify interactions with the Deta database. It provides a straightforward way to initialize a database connection and perform basic operations such as inserting data. This library is ideal for developers looking to integrate Deta database functionality into their Clojure applications.

Features

  • Base Initialization: Easily initialize a database connection with a simple function call.
  • Data Insertion: Insert data into the Deta database with support for various data types.
  • Testing: Comprehensive test suite to ensure reliability and correctness.

Getting Started

Prerequisites

  • Clojure 1.10 or later
  • Leiningen 2.9.1 or later

Installation

Currently, this library is not available as a dependency. However, I am working on it.

Usage

Initializing a Database Connection

To initialize a database connection, use the base function:

(def db (base/base "your_collection_key" "your_basename"))

Inserting Data

To insert data into the Deta database, use the put function:

(base/put db {:a 1 :b 2} "item-key")

Testing

The library includes a test suite that covers various scenarios. To run the tests, execute the following command in your project directory:

lein test

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md for details on how to contribute to this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

  • Deta for providing a powerful and scalable database solution.
  • The Clojure community for their support and contributions.

Future Plans

  • Publish the library as a dependency for easier integration.
  • Expand the library with more advanced database operations.

Contact

For any questions or suggestions, please open an issue on GitHub.

Can you improve this documentation?Edit on GitHub

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close