This documentation is for v4.x, you can find the documentation for previous versions here, Before upgrading please read the docs , this version includes breaking changes.
Harpee is a modeling tool for HarperDB which allows you to have a structured data for your tables (collections), it supports both callbacks and promises.
To use harpee, install with
npm i harpee --save
or
yarn add harpee
require it in your application.
// commonjs
const { harpee } = require("harpee");
// as ES6 module
import { harpee } from "harpee";
// as ES6 module
import { harpee,HType } from "harpee";
// create a connection.
harpee.createConnection({host:
// "https://localhost:9925" or https://xxxxxxxx.harperdbcloud.com,
user:"YOUR-DB-USERNAME",
pass:"YOUR-DB-PASSWORD",
token:xcxxxxxxxxxxx, // your JWT token, you should only use token if no `username` and `password`.
})
// create a Schema.
// `name` is optional , if not specified, a default schema with the name `defaultSchema` will be created.
const usersSchema = new harpee.Schema({
name:"usersSchema",
fields:{
username: HType.string().required(),
email: HType.string()
.email({ minDomainSegments: 2, tlds: { allow: ['com', 'net'] } }).required() ,
phone: HType.number(),
verified:HType.bool().default(false)
}
primaryKey:'user_id' // optional, alias for hash_attribute, default 'id'
silent:false // optional, when true turns off error throwing when `Schema.fields` doesn't match `Model.create` values, default is false
})
// create a model, the model name represents a table.
const UsersModel = new harpee.Model("users",usersSchema);
// Next, initialize it.
// Recommended: you should get rid of this method after running your app for the first time.
await UsersModel.init();
Now you can start using the model UsersModel to perform several operations.
// this will insert the following data in `users` table.
UsersModel.create(
{
username: "lucky",
email: "user@email.com",
phone: 1234567890,
},
callback
);
// this returns every data from the `users` table.
UsersModel.find({}, (err, result) => {
if (err) console.log(err);
console.log(result.data);
});
// or
UsersModel.find([]).then((result) => console.log(result.data));
// you can specify the columns to be returned.
const result = await UsersModel.find(["username"]);
// console.log(result.data)
// you can specify an object with options
UsersModel.find(
{
limit: 5,
offset: 10,
orderby: ["user_id"],
order: "desc",
where: 'username="lucky"',
getAttributes: ["username"],
},
(err, result) => {
if (err) console.log(err);
console.log(result.data);
}
); // this will return only usernames.
// this will return only data based on the specified `ids`,
UsersModel.findById(
{ ids: [1, 2], getAttributes: ["username", "email"] },
(err, result) => {
if (err) console.log(err);
console.log(result.data);
}
);
To better understand how Harpee works, you should check out HarperDB docs to learn more about HarperDB.
Harpee consist of the following function and classes,
createConnection function creates a connection with your harperDB instance. it takes in an object with the following props.
host Type - String : your HarperDB url, https://localhost:9925 or https://xxxxxxxxxx.harperdbcloud.com.username Type - String : your HarperDB username.user Type - String : same as username.password Type - String : your HarperDB password.pass Type - String : same as password.token Type - String : A generated JWT token, token is optional,you should only include it in place of username and password.Schema class creates a schema, it takes in an object with the following props,
name Type - String : optional, if not specified a default schema named defaultSchema will be created, but if you want your schema to have a different name, then you should specify this option.primaryKey Type - String optional: this option allows you to set a hash_attribute, if not specified, will default to id.silent Type - boolean : optional when true, turns off errors when Schema.fields types doesn't match Model.create() values, default is false.fields Type - Object : this option let's specify table columns and their types ,Note: the properties and data-types declared in fields must be same with properties and data-types that will be specified at
Model.create(object)orModel.createMany(object[]), otherwise an error will be thrown, you can turn this off by settingsilentoption inSchemaclass totrue.
const ArticleSchema = new harpee.Schema({ name:"MyArticlesSchema"},
fields:{
title: HType.string().required(),
author: HType.object({name: HType.string()}).required(),
body: HType.string().required(),
publishDate: HType.date().default(new Date()),
status:HType.string().equal('published','draft').default('published'),
tags:HType.array()
})
The Model class takes the following options.
modelName Type - String : this modelName represents a table that will be created.schemaConfig Type - Schema(Object) : this option takes in an instance of Schema .const Articles = new harpee.Model("Articles", ArticleSchema);
Model has the following methods. all methods supports both callbacks and promises, the callback function takes two parameters err and result.
inserts new data into the table, takes in an object of the data to be inserted.
// inserts new data into Articles table.
Articles.create({
id: 1,
title: "post 1",
author: { name: "lucky" },
body: "lorem ipsum dot set amor",
publishDate: new Date(),
tags: ["first"],
});
This methods let's you update values as well nested values, such as objects & arrays, by simply specifying a path.
// this will update the author's name, 'lucky' => 'lucky victory'
Articles.updateNested(
{
// the id of the data to be updated
id: 1,
path: "author.name",
// the new value
value: "lucky victory",
// returns the updated data
returnData: true,
},
(err, result) => {
console.log(result.data);
}
);
// exampme 2
Articles.updateNested(
{
// the id of the data to be updated
id: 1,
// this will update the tags
path: ".tags",
// the new value
value: (article) => {
article.tags.push("second");
return article.tags;
},
// returns the updated data
returnData: true,
},
(err, result) => {
console.log(result.data);
}
);
The find method returns all data from the table. to do this, pass an empty array [] or wildcard ["*"] as the first argument, you can also choose to return specific data,
for instance, in order to return only Article titles,
// this will return only Articles titles.
Articles.find(["title"], (err, result) => {
console.log(result.data);
});
the find method also takes an object with options, useful for advanced filtering.
limit: Type - Number optional:getAttributes:Type - Array optionallimit: Type - Number optional,offset: Type - Number optional,order: Type - String optionalorderby : Type - String[] optionalwhere : Type - String optionaland : Type - String|Number optionalYou can find more methods on the documentation page.
For bugs or feature request, please create an issue.