Skip to content

Commit

Permalink
fix: renovate + docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vincent-herlemont committed Dec 19, 2023
1 parent c772364 commit 428237e
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<!-- ALL-CONTRIBUTORS-BADGE:END -->


Blazing-fast, embedded database for multi-platform apps (server, desktop, mobile) - a Rust project's dream! 🚀 Sync Rust types effortlessly. Simple, effective, and ready to elevate your project. Get started and thrive! 😌🍃
Here's a drop-in, fast, embedded database for multi-platform apps (server, desktop, mobile). Sync Rust types effortlessly. Enjoy! 😌🍃.

# Features

Expand All @@ -30,7 +30,7 @@ Add this to your `Cargo.toml`:
```toml
[dependencies]
native_db = "0.5.0"
native_model = "0.3.30"
native_model = "0.4.2"
```

NOTE: `native_db` requires `native_model` to work.
Expand All @@ -47,11 +47,11 @@ Active development. The API is not stable yet and may change in the future.
- [**Database**](https://docs.rs/native_db/latest/native_db/struct.Database.html)
- [**snapshot**](https://docs.rs/native_db/latest/native_db/struct.Database.html#method.snapshot) the database.
- **rw_transaction** open a read-write transaction.
- [**insert**](https://docs.rs/native_db/latest/native_db/native_db/transaction/struct.RwTransaction.html#method.insert) a new item.
- [**update**](https://docs.rs/native_db/latest/native_db/native_db/transaction/struct.RwTransaction.html#method.update) an existing item.
- [**remove**](https://docs.rs/native_db/latest/native_db/native_db/transaction/struct.RwTransaction.html#method.remove) an existing item.
- [**commit**](https://docs.rs/native_db/latest/native_db/native_db/transaction/struct.RwTransaction.html#method.commit) the transaction.
- [**min**](https://docs.rs/native_db/latest/native_db/native_db/transaction/struct.RwTransaction.html#method.min) the minimum primary key.
- [**insert**](https://docs.rs/native_db/latest/native_db/transaction/struct.RwTransaction.html#method.insert) a new item.
- [**update**](https://docs.rs/native_db/latest/native_db/transaction/struct.RwTransaction.html#method.update) an existing item.
- [**remove**](https://docs.rs/native_db/latest/native_db/transaction/struct.RwTransaction.html#method.remove) an existing item.
- [**commit**](https://docs.rs/native_db/latest/native_db/transaction/struct.RwTransaction.html#method.commit) the transaction.
- [**migrate**](https://docs.rs/native_db/latest/native_db/transaction/struct.RwTransaction.html#method.migrate) a model.
- plus all read-only transaction APIs.
- **r_transaction** open a read-only transaction.
- **get**
Expand Down
2 changes: 1 addition & 1 deletion renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@
"matchStrings": [
"\"native_model\" = \"(?<currentValue>.*?)\""
],
"datasource": "crate",
"depNameTemplate": "native_model",
"datasourceTemplate": "crate",
"versioningTemplate": "semver"
}
]
Expand Down
4 changes: 2 additions & 2 deletions src/transaction/query/get.rs
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ impl RGet<'_, '_> {

/// Get a value from the database by secondary key.
///
/// /!\ The secondary key **must** be [`unique`](struct.DatabaseBuilder.html#unique) else this method will return an error [`SecondaryKeyConstraintMismatch`](db_type/enum.Error.html#variant.SecondaryKeyConstraintMismatch).
/// If the secondary key is not unique, use [`scan()`](transaction/struct.RTransaction.html#method.scan) instead.
/// /!\ The secondary key **must** be [`unique`](crate::DatabaseBuilder#unique) else this method will return an error [`SecondaryKeyConstraintMismatch`](crate::db_type::Error::SecondaryKeyConstraintMismatch).
/// If the secondary key is not unique, use [`scan()`](crate::transaction::RTransaction::scan) instead.
///
/// Anatomy of a secondary key it is a `enum` with the following structure: `<table_name>Key::<name>`.
///
Expand Down

0 comments on commit 428237e

Please sign in to comment.