norm 2.0.0
simple ORM for D using DDBC
To use this package, run the following command in your project's root directory:
Manual usage
Put the following dependency into your project's dependences section:
norm
A simple ORM for use with D Language and SQLite (for now). Support for MYSQL, PGSQL etc may arrive later.
norm provides simple functions to get started quickly with saving/retrieving objects to/from SQL databases.
Getting Started:
Installation / Building
Run following to add norm to your project:
dub add norm
in debug mode, norm will print all exceptions in DB facing functions, they will
not appear when built using dub build -b=release
Connecting
Use the connect(connectionString)
function to create a NormConn
object.
auto conn = connect("ddbc:sqlite:xyz.sqlite");
Defining Objects
norm works on objects of classes inhering from DBObject
. All data members
that norm needs to access should be public. Use the following attributes to
work with norm:
@Val
- Belongs in database, members without this are not touched by norm@Size(length)
- tell length in cases of fixed length string.@Group(nameString)
- group together multiple@Val
s so fetching, updating, deleting, by matching them is possible.
DBObject
provides a public id
getter that returns the unique ulong
id
that norm assigns to all objects.
A @Val
field can by of type of another DBObject
derived class as well.
Creating Tables
class User : DBObject{
public:
enum Type{
Admin,
Moderator,
User
}
@Val @Group("identity") string firstname;
@Val @Group("identity") string lastname;
@Val @Len(6) string registration;
@Val Type type;
}
createTable!User(conn);
Inserting
auto user = new User();
user.x = y; // set values
insert(conn, user);
writefln!"user was assigned id: %d"(user.id);
Updating
user.type = User.Type.Admin;
// update this one user
update(conn, user);
// will turn all users into this one
updateAll(conn, user);
// match by group "identity" (firstname, lastname), turn them all into this one
update(User, "identity")(conn, user, "john", "doe");
Fetching
writeln("Enter user id");
ulong id = readln.chomp.to!string;
auto someone = fetch!User(conn, id);
// fetch all Users
auto allUsersRange = fetch!User(conn);
foreach (obj; allUsersRange)
writeln(obj.firstname);
// fetch all that match identity
auto identityRange = fetch!(User, "identity")(conn, "john", "doe");
User[] johnDoes;
foreach (john; identityRange)
johnDoes ~= john;
Deleting
// delete one user
drop(conn, user.id);
// delete by identity
drop!(User, "identity")(conn, "john", "doe");
// rm -rf them all
drop!User(conn);
Counting
// count all
auto userCount = count!User(conn);
writefln!"there are %d users"(userCount);
// count by id (will give 1 or 0)
userCount = count!User(conn, user.id);
writefln!"there are %d users with id %d"(userCount, user.id);
// alternatively, following work as well
if (exists!User(conn, user.id)) writeln(..);
if (exists(conn, user)) writeln(..);
// count by identity group
userCount = count!(User, "identity")(conn, "john", "doe");
writefln!"there are %d john does"(userCount);
Deleting Table
dropTable!User(conn);
- Registered by Nafees Hassan
- 2.0.0 released 7 months ago
- Nafees10/norm
- MIT
- Copyright © 2023-2024, nafees
- Authors:
- Dependencies:
- ddbc
- Versions:
-
2.0.0 2024-Mar-05 1.0.1 2023-Aug-04 1.0.0 2023-Aug-03 ~master 2024-Mar-17 - Download Stats:
-
-
0 downloads today
-
0 downloads this week
-
0 downloads this month
-
13 downloads total
-
- Score:
- 0.6
- Short URL:
- norm.dub.pm