Nut/README.md

55 lines
1012 B
Markdown

# Nut
## Advanced, Powerful and easy to use ORM for Qt5
## Features:
- Easy to use
- Automatically create and update database
- IDE auto complete support
- Table join detect
## Sample Codes
### Read data from database:
```cpp
autoq = FROM(db.posts())
WHERE(Post::id() == %1)
BIND(postId);
auto posts = q->toList();
// now posts is a QList<Post*> contain all posts in
// database that has id equal to postId variable
```
### Adding to database:
```cpp
Post*newPost = new Post;
newPost->setTitle("post title");
db.posts()->append(newPost);
for(int i = 0 ; i < 3; i++){
Comment *comment = new Comment;
comment->setMessage("comment #" + QString::number(i));
newPost->comments()->append(comment);
}
db.saveChanges();
```
### Modify database data:
```cpp
auto q = FROM(db.posts())
WHERE(Post::id() == %1)
BIND(postId);
Post *post = q->first();
if(post) {
post->setTitle("new name");
db.saveChanges();
} else {
qWarning("No post found!");
}
```