2 stable releases
1.2.5 | Oct 26, 2024 |
---|
#1116 in Database interfaces
51KB
744 lines
π Features
- JSON Data Handling: Efficiently store and manipulate JSON documents.
- Structured Management: Organize documents into collections for better management.
- Cross-Platform: Compatible across multiple operating systems.
- Extensible: Easily extend the functionality to meet your specific use cases.
- ROBUST: Leveraging Serde for powerful serialization and deserialization.
π¦ Installation
To set up Alice DBMS, ensure you have Rust and Cargo installed. You can then add it to your project by including it in your Cargo.toml
.
[dependencies]
Alice-Database_DBMS = "=0.1.0"
Then, run:
cargo build
π Getting Started
Here's a brief example of how to use the Alice DBMS module:
fn main() -> std::io::Result<()> {
// Define the root path for data storage
let root_path = Path::new("path_to_your_database");
let mut manager = CollectionManager::new(&root_path);
// Add a new collection
manager.add_collection("example_collection").unwrap();
// Prepare document content
let doc_content = json!({"key": "value"}).to_string();
// Add a new document to the collection
manager.get_collection_mut("example_collection").unwrap()
.add_document("example_doc.json", &doc_content).unwrap();
println!("Document added successfully!");
Ok(())
}
π Testing
Alice DBMS comes with a suite of tests to ensure functionality. You can run the tests using:
cargo test
Example Tests
These tests cover the creation, updating, and deletion of documents and collections. For example:
#[test]
fn test_create_and_add_document() {
// Test implementation here...
}
π€ Contributing
Contributions are welcome! Hereβs how you can help:
- Open an issue if you have a bug to report or a suggestion.
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Submit a pull request.
π License
This project is licensed under the MIT License. See the LICENSE file for details.
π§ Contact
For questions or feedback, please reach out to blcklptn@icloud.com.
Happy coding with Alice DBMS! π
Dependencies
~15β25MB
~459K SLoC