Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adaiasmagdiel/deta-clojure
A Clojure library designed to simplify interactions with the Deta database. It provides a straightforward way to initialize a database connection and perform operations.
https://github.com/adaiasmagdiel/deta-clojure
api clojure deta deta-base deta-space web web-development
Last synced: about 2 months ago
JSON representation
A Clojure library designed to simplify interactions with the Deta database. It provides a straightforward way to initialize a database connection and perform operations.
- Host: GitHub
- URL: https://github.com/adaiasmagdiel/deta-clojure
- Owner: AdaiasMagdiel
- License: mit
- Created: 2024-03-11T20:33:03.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-03-25T22:28:54.000Z (9 months ago)
- Last Synced: 2024-11-13T16:45:51.037Z (about 2 months ago)
- Topics: api, clojure, deta, deta-base, deta-space, web, web-development
- Language: Clojure
- Homepage: https://adaiasmagdiel.github.io/deta-clojure/
- Size: 720 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Deta Clojure Library
[](https://clojars.org/com.adaiasmagdiel/deta)
[](https://opensource.org/licenses/MIT)
[](https://adaiasmagdiel.github.io/deta-clojure/)
Deta is a Clojure library designed to simplify interactions with the Deta Base and Deta Drive. It provides a straightforward way to initialize a service connection and perform operations. This library is ideal for developers looking to integrate Deta Space services functionality into their Clojure applications.
## Table of Contents
- [Project Progress](#project-progress)
- [Deta Base](#deta-base)
- [Deta Drive](#deta-drive)
- [Features](#features)
- [Documentation](#documentation)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Simple Usage](#simple-usage)
- [Initializing a Deta Base Connection](#initializing-a-deta-base-connection)
- [Inserting Data](#inserting-data)
- [Retrieving Data](#retrieving-data)
- [Deleting Data](#deleting-data)
- [Fetching Data](#deleting-data)
- [Updating Data](#updating-data)
- [Testing](#testing)
- [Windows](#windows)
- [Linux/MacOS](#linuxmacos)
- [Coverage](#coverage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Project Progress
The current focus is on implementing functions for Deta Base, with Deta Drive functionalities yet to be started.
### Deta Base
The Deta Base API provides a range of functionalities for data manipulation. The following functions have been implemented:
- [x] **Base Object**: Creation and configuration of the base object for API interaction.
- [x] **Put**: Insertion of an object into the database.
- [x] **Get**: Retrieval of a specific object from the database.
- [x] **Insert**: Insertion of a new object into the database.
- [x] **Fetch**: Retrieval of objects based on specific criteria.
- [x] **Delete**: Removal of an object from the database.
- [x] **Update**: Update of an existing object in the database.
The remaining functions to be implemented are:
- [ ] **Put Many**: Insertion of multiple objects into the database at once.
### Deta Drive
Deta Drive offers functionalities for file storage and manipulation. As of now, work on Deta Drive functionalities has not yet begun. The planned functionalities include:
- [ ] **Drive Object**: Creation and configuration of the drive object for API interaction.
- [ ] **Put**: Upload of a file to Deta Drive.
- [ ] **Get**: Download of a specific file from Deta Drive.
- [ ] **Delete**: Removal of a file from Deta Drive.
- [ ] **List**: Listing of available files in Deta Drive.
- [ ] **Delete Many**: Removal of multiple files from Deta Drive at once.
This project is under continuous development, with the goal of providing a robust and efficient solution for interacting with the Deta Space API in Clojure. Follow the progress and contribute with suggestions or implementations of new functionalities.
## Features
- **Database Initialization**: Easily establish a connection to a Deta database with a straightforward function call.
- **Data Insertion**: Insert data into the Deta database, supporting various data types.
- **Data Update**: Update existing data in the Deta database or insert new data if the key does not exist.
- **Data Retrieval**: Fetch data from the Deta database by specifying a key.
- **Data Deletion**: Remove data from the Deta database by specifying a key.
- **Testing**: A comprehensive test suite is essential to ensure reliability and accuracy.
## Documentation
To fully understand how to use this software, referring to the comprehensive documentation available at [https://adaiasmagdiel.github.io/deta-clojure/](https://adaiasmagdiel.github.io/deta-clojure/).
## Getting Started
### Prerequisites
- Clojure 1.10 or later
- Leiningen 2.9.1 or later
### Installation
This library is now available as a dependency. You can add it to your project using Leiningen/Boot by including the following in your `project.clj` dependencies:
```clojure
[com.adaiasmagdiel/deta "0.0.6"]
```
For more installation methods, such as `Clojure CLI/deps.edn`, `Gradle`, and `Maven`, please refer to the [installation](https://adaiasmagdiel.github.io/deta-clojure/#installation) section of our documentation.
### Simple Usage
#### Initializing a Deta Base Connection
```clojure
(def db (base/base "your_collection_key" "your_basename"))
```
#### Inserting Data
```clojure
(base/put db {:a 1 :b 2} "item-key")
(base/put db {:c 3 :d 4}) ; The key is automatically generated on the server
```
```clojure
(base/insert db {:a 1 :b 2} "item-key")
(base/insert db {:c 3 :d 4}) ; The key is automatically generated on the server
```
Please refer to the [documentation](https://adaiasmagdiel.github.io/deta-clojure/usage/#data-insertion) to understand the distinction between "put" and "insert".
#### Retrieving Data
```clojure
(base/get db "item-key")
```
#### Deleting Data
```clojure
(base/delete db "item-key")
```
#### Fetching Data
```clojure
(base/fetch db) ; Fetch all records
(base/fetch db {:name "Jane Doe"}) ; Fetch only records with name = "Jane Doe"
(base/fetch db {:name "Jane Doe"} {:limit 1 :desc true}) ; Use parameters to modify fetching
```
#### Updating Data
```clojure
(base/update db "key" {:set {:name "John" :age 31 :books []}})
(base/update db "key" {:increment {:age 1}})
(base/update db "key" {:append {:books ["A Book by John Doe", "Another Book By John Doe"]}})
```
For information on the update payload for the `base/update` function, please refer to the [Deta Base documentation](https://deta.space/docs/en/build/reference/http-api/base#update-item).
For more detailed usage instructions and examples, please refer to the [usage](https://adaiasmagdiel.github.io/deta-clojure/usage/#getting-started) section of our documentation.
## Testing
The library includes a test suite that covers various scenarios. To run the tests, set the `DETA_KEY` environment variable with a valid Deta key beforehand.
### Windows
```cmd
set DETA_KEY=your_deta_key_here
lein test
```
### Linux/MacOS
```bash
export DETA_KEY=your_deta_key_here
lein test
```
Replace `your_deta_key_here` with your actual Deta key.
### Coverage
This project includes a coverage tool that allows you to easily run test coverage reports. To generate coverage reports for tests, simply enter the following command:
```bash
lein cloverage
```
## Contributing
Contributions are always welcome! Please review the code and send suggestions or pull requests to improve the library.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
For any questions or suggestions, please open an issue on GitHub.