harperdbjs v0.1.0

HarperDB.js 🚀

A Javascript helper library written in Typescript to work with HarperDB easily.

Installation 📥

Install with npm

  npm i harperdbjs

Install with yarn

  yarn add harperdbjs

Why use HarperDBjs?

Without using HarperDBjs, for working with HarperDB you will need to write the following code for every operation you wanna execute:

// to insert a record using axios

import axios from "axios"

const url = "https://janedoe-test.harperdbcloud.com"
const token = "djsjdksh..."

const schema = "my-company"
const table = "users"

const user = {
  name: "Jane Doe",
  contact: 9999999999,
  email: "jane@doe.com",
}

const data = {
  operation: "insert",
  schema,
  table,
  records: [user],
}

const headers = {
  Authorization: `Basic ${token}`,
}

axios.post(url, data, { headers })

With HarperDBjs, you will do the same job but with lesser lines of code which will be a lot more readable and understandable and type safe.

import { HarperDB } from "harperdbjs"

const url = "https://janedoe-test.harperdbcloud.com"
const token = "djsjdksh..."

// you won't have to initialize the harperdb class again for each operation

// initialize it once with the url and token or username/password
// and use the same instance for every operation.
const harperdb = new HarperDB({ url, token })

const schema = "my-company"
const table = "users"

const user = {
  name: "Jane Doe",
  contact: 9999999999,
  email: "jane@doe.com",
}

harperdb.insert(user, { schema, table })

Usage 🛠

See complete documentation

Authentication 🛡

First you need to initialize the HarperDB class with either your username & password or your token.

See documentation for more details on authentication.

• with username and password

import { HarperDB } from "harperdbjs"

const db = new HarperDB({
  url: "http://localhost:9925", // your local or cloud harperdb instance's url
  username: "jane-doe", // username for your harperdb instance
  password: "secure-password", // password for your harperdb instance
})

• with token

import { HarperDB } from "harperdbjs"

const db = new HarperDB({
  url: "http://localhost:9925", // your local or cloud harperdb instance's url
  token: "HHJSjddnnss=", // your username and password buffer token
})

Now you can use the db methods like db.createSchema, db.insert, etc.

Example 📚

Creating a schema

const schema = "dev"

await db.createSchema(schema)

Creating a table

const schema = "dev"
const table = "test"

await db.createTable({ schema, table })

Inserting a record into a table

const schema = "my-company"
const table = "users"
const user = {
  name: "Jane Doe",
  contact: 9999999999,
  email: "jane@doe.com",
}

await db.insert(user, { schema, table })

Deleting a record from a table

const schema = "my-company"
const table = "users"
const userId = "user-1"

await db.deleteOne(userId, { schema, table })

Searching for records with conditions

const schema = "my-company"
const table = "users"

await db.searchByConditions(
  [
    {
      searchAttribute: "name",
      searchType: "contains",
      searchValue: "Jane",
    },
    {
      searchAttribute: "name",
      searchType: "contains",
      searchValue: "Doe",
    },
  ],
  { schema, table, operator: "or" }
)

Support 💯

For support, create an issue or email.

Contributing 🙏

Contributions are always welcome!

See contributing.md for ways to get started.

Authors 👋

• @webdevavi

License 📃

MIT License

Copyright (c) 2021 Avinash Sinha

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.