zrm/README.md

ZRM

Documentation | API

Zig relational mapper

ZRM is part of zedd, a collection of useful libraries for zig.

ZRM

ZRM provides a simple interface to relational databases in Zig. Define your repositories and easily write queries to retrieve and save complex Zig structures.

Versions

ZRM 0.1.0 is made and tested with zig 0.13.0.

How to use

Install

In your project directory:

$ zig fetch --save https://code.zeptotech.net/zedd/zrm/archive/v0.1.0.tar.gz

In build.zig:

// Add zrm dependency.
const zrm = b.dependency("zrm", .{
	.target = target,
	.optimize = optimize,
});
exe.root_module.addImport("zrm", zrm.module("zrm"));

Examples

Full examples can be found in tests directory:

• tests/repository.zig
• tests/composite.zig