We built HarperDB around the idea that storing data well shouldn’t be as hard as it has been. We also thought installing, running, and managing a database was harder than it needed to be. Below you’ll find the instructions for getting HarperDB up and running in as little as 15 seconds (depending on how fast you type).

 

If you’re not using our Docker container, HarperDB requires NodeJS/NPM, available here.


Want HarperDB to host and manage your database for you? Learn more about HarperDB Cloud:

 

Installing HarperDB

Via NPM

npm install -g harperdb
harperdb install

Offline Install

 

npm install -g harperdb-2.0.8-BETA.tgz
harperdb install

Docker Container

docker run -d -p harperdb/hdb

 

Add A Volume To Persist Data:

 

-v <host-data-path>:/opt/harperdb/hdb

 

Add Initial Config Arguments (default):

 

--INIT_HDB_USERNAME ("HDB_ADMIN")
--INIT_HDB_PASSWORD ("password")
--INIT_CLUSTER_USERNAME ("cluster_user")
--INIT_CLUSTER_PASSWORD("password")
--INIT_NODE_NAME ("docker_node")


Starting HarperDB

To run HarperDB after it is installed; run the following command:

 

harperdb run

 

You may need to update your firewall if you are not running locally, by default HarperDB runs on port 9925. If you are unsure see your properties file at HDB_ROOT/config/settings.js.


Stopping HarperDB

To stop HarperDB once it is running from the HarperDB home (HDB_HOME) directory run the following command:

 

harperdb stop


Restarting HarperDB

To restart HarperDB once it is running from the HarperDB home (HDB_HOME) directory run the following command:

 

harperdb restart


Getting The HarperDB Version

To check the version you are running of HarperDB from the HarperDB home (HDB_HOME) directory run the following command:

 

harperdb version


Using the Built-In API

Using HarperDB’s built-in API is as easy as making an http call to the URL and PORT of your HarperDB instance. To make it even easier, we’ve created a series of example http calls as a Postman Collection. These calls show you how to create and access sample data in HarperDB.

 

 

Sample code is also available in many common languages in the sample code pane. Select the language you want from the drop down and paste the code.


Using the Built-In Studio

Once HarperDB is installed and running you can get instant gratification by using our built in administration studio.

 

  • Open a browser and navigate to: <Your-Harper-DB-IP-Address>:<Your-Harper-DB-Port>
    • For a local install, this is most often http://localhost:9925
    • For hosted instances, please use the IP address and port specified in your welcome email.
  • Login with the user name and password you created during install.
  • Add a schema, then add a table with hash attribute (akin to a primary key in a traditional RDBMS).
  • Add content to the table
    • Use the plus (+) button to add an individual record
    • Use the document icon to upload bulk data via CSV
    • Use the API via Postman or your application code to add data via the built-in API

 

Sample code is also available in many common languages in the sample code pane. Select the language you want from the drop down and paste the code.