Getting Started

This guide will take you through the minimum required steps to get up and running with HarperDB.

Contents

1. Installation
2. Running HarperDB
3. Stopping HarperDB
4. Restarting HarperDB
5. Check HarperDB Version
6. CRUD Samples
7. HarperDB Studio
8. Need Help?

Installation

Download the latest version of HarperDB here: https://products.harperdb.io/download.

After downloading the compressed file, extract the files to your desired location. This location is referred to as HDB_HOME further in the documentation.

Two important things to keep in mind:

1. All HarperDB commands must be run in the bin directory from within HDB_HOME.
2. The operating system user who installed HarperDB is the only user that can start and run the HarperDB service.

HarperDB can be installed in one of two ways:

• ./harperdb install
• ./harperdb run

The process is the same; however, ./harperdb run will also start HarperDB.

From the HarperDB root directory execute the following:

cd HDB_HOME/bin
./harperdb install

or run

cd HDB_HOME/bin
./harperdb run

• You will need read and write access to the HDB_ROOT (location of the root directory of the database) directory, default path is your current working directory.

• You will be prompted for a database username and password during the install.

• If HarperDB is already installed ./harperdb run will NOT run the installer.

• Logs for installation are found in the HarperDB home directory (HDB_HOME). Other logs are located at HDB_ROOT/log/.

Running HarperDB

To run HarperDB after it is installed from the HarperDB home (HDB_HOME) directory; run the following commands:

cd HDB_HOME/bin
./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 commands:

cd HDB_HOME/bin
./harperdb stop

Restarting HarperDB

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

cd HDB_HOME/bin
./harperdb restart

Check HarperDB Version

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

cd HDB_HOME/bin
./harperdb version

CRUD Samples

We really like Postman. We like it so much, we have created a series of examples that can be run to create and access sample data in HarperDB.

Get Postman here: https://www.getpostman.com/.

Our Postman 'Getting Started' samples can be found on our examples page: http://examples.harperdb.io/. Click the "Run in Postman" button then run the samples from top to bottom to learn how to create, populate, and query our sample 'dog' database.

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. See the Postman documentation on supported languages here: https://www.getpostman.com/docs/postman/sending_api_requests/generate_code_snippets

HarperDB Studio

Need a UI? HarperDB Studio is a web based UI for managing users, roles, and schemas. The HarperDB Studio also enables you to run NoSQL & SQL queries, create charts, save your favorite queries & charts and share them via live links to your organization.
http://harperdb.io/studio

Need Help?

You're in the right place. This is our documentation and support portal. Navigate this site for answers to any questions you may have. If you can't find an answer here, submit a support request and we'll make sure to get your questions answered.