Getting Started

HarperDB was built by developers for developers, which means getting started should be simple.

 

The quickest way to get up and running with HarperDB is with HarperDB Cloud, our database-as-a-service offering, which this guide will utilize.

Set Up a HarperDB Instance

Before you can start using HarperDB you need to set up an instance. Note, if you would prefer to install HarperDB locally, check out the installation guides including Linux, Mac, and many other options.

 

  1. Sign up for the HarperDB Studio (Additional instructions)
  2. Create a new HarperDB Cloud instance
    HarperDB Cloud instance provisioning typically takes 5-15 minutes. You will receive an email notification when your instance is ready.

Using the HarperDB Studio

Now that you have a HarperDB instance, you can do pretty much everything you’d like through the Studio. This section links to appropriate articles to get you started interacting with your data.

  1. Create a schema
  2. Create a table
  3. Load CSV data and/or add a record
    Here’s a sample CSV of the HarperDB team’s dogs [hash_attribute id]
  4. Query data via SQL

Using the HarperDB API

Complete HarperDB API documentation is available at docs.harperdb.io. The HarperDB Studio features a example code builder that generates API calls in the programming language of your choice. For example purposes, a basic cURL command is shown below to create a schema called dev.

curl --location --request POST 'https://instance-subdomain.harperdbcloud.com' \
--header 'Authorization: Basic YourBase64EncodedInstanceUser:Pass' \
--header 'Content-Type: application/json' \
--data-raw '{
  "operation": "create_schema",
  "schema": "dev"
}'

Breaking it down, there are only a few requirements for interacting with HarperDB:

  • Using the HTTP POST method.
  • Providing the URL of the HarperDB instance.
  • Providing the Authorization header (more on using Basic authentication).
  • Providing the Content-Type header, HarperDB only accepts application/json.
  • Providing a JSON body with the desired operation and any additional operation properties (shown in the --data-raw parameter). This is the only parameter that needs to be changed to execute alternative operations on HarperDB.

Video Tutorials

HarperDB video tutorials are available within the HarperDB Studio. (HarperDB and the HarperDB Studio are constantly changing, as such, there may be small discrepancies in UI/UX).