Release 0.9.0

[michaelvlach]

Hi,

the release 0.9.0 is out and it contains some major improvements focused on usability and ergonomics:

agdb website

We now have dedicated website for agdb: https://agdb.agnesoft.com/

All the documentation has been moved there as it offers more rich experience than pure markdown here on GitHub. Links from the main readme now leads to the website where you can find documentation, API references, blogs and more.

search ergonomics

Searching is the fundamental part of the querying system. Previously it was possible to use search as a nested query in ids() part of a query. Since 0.9.0 it is possible to use search() instead and seamlessly embed search queries that way. Examples:

QueryBuilder::insert().values([("key", "value").into()]).search().from("a").where_().node().query();
QueryBuilder::remove().search().from("a").query();
QueryBuilder::select().search().index("key").value(20).query();
QueryBuilder::select().elements::<T>().search().to("a").query()
//...

This is purely ergnomic improvement and does not change the underlying query objects in any way. I also applies to all available apis - Typescript, Rust & PHP.

value ergonomics [breaking change, Rust only]

Previously it was necessary to use exact type when passing values to queries (in Rust), i.e. QueryBuilder::insert().values(vec![vec![("k", 1).into()]]).ids(1).query(). This was never an issue in the dynamically typed apis (Typescript & PHP) and it is no longer needed in Rust as well:

QueryBuilder::insert().values([[("key", 1).into()]]).ids("a").query();
QueryBuilder::select().values("key").ids("a").query();
QueryBuilder::select().values(["key"]).ids("a").query();

Please note that this is a breaking change in few places because the original syntax when passing keys is now ambiguous, i.e. QueryBuilder::select().values(vec!["key".into()]).ids("a").query(). The fix is to remove both the .into() because the builder now accepts generic argument which cannot be inferred (previously there was a concerete type which is why .into() worked). You can also remove the vec! as single arguments can now be passed directly and beside vectors you can also pass arrays or slices or references.

optional & vectorized user values [rust only]

The derive macro agdb::UserValue now supports Option types. If the value is None it is omitted when inserting to the database. Additionally there is a new empty trait DbUserValueMarker and a derive macro for it agdb::UserValueMarker. This is needed for vectorized user types to work in the database. Both of these changes greatly expand the usability of the user types in the database:

#[derive(Clone, Debug, UserValueMarker)]
struct Attribute { 
    name: String,
    value: String,
}

#[derive(Default, Debug, Clone, UserValueMarker)]
enum Status {
    Active,
    #[default]
    Inactive,
}

#[derive(UserValue)]
struct MyType {
    vec: Vec<Status>,
    attribtues: Vec<Attribute>,
    value: Option<u64>,
}

You can now use both vectorized user values and optional values.

query ergnomics [rust only]

Another item that was never an issue in the non-Rust apis is that the queries needed to be passed to the database as a reference. It is now possible to pass them by value as well:

db.exec(&QueryBuilder::insert().index("key").query())?; // previous syntax, still works
db.exec(QueryBuilder::insert().index("key").query())?; //new option without reference

Full release notes can be found at: https://github.com/agnesoft/agdb/releases/tag/v0.9.0

Thank you all for your support and keep reporting any issues or experiences or requests that you have so we make agdb one of the greatest databases there is.

@pinghe @teodosin @nerdachse