Log In to Your HarperDB Studio Account

To log into your existing HarperDB Studio account:

1. Navigate to the HarperDB Studio.

2. Enter your email address.

3. Enter your password.

4. Click sign in.

Reset a Forgotten Password

To reset a forgotten password:

1. Navigate to the HarperDB Studio password reset page.

2. Enter your email address.

3. Click send password reset email.

4. If the account exists, you will receive an email with a temporary password.

5. Navigate back to the HarperDB Studio login page.

6. Enter your email address.

7. Enter your temporary password.

8. Click sign in.

9. You will be taken to a new screen to reset your account password. Enter your new password. Passwords must be a minimum of 8 characters with at least 1 lower case character, 1 upper case character, 1 number, and 1 special character.

10. Click the add account password button.

Change Your Password

If you are already logged into the Studio, you can change your password though the user interface.

1. Navigate to the HarperDB Studio profile page.

2. In the password section, enter:

   • Current password.

   • New password.

   • New password again (for verification).

3. Click the Update Password button.

HarperDB Studio is the web-based GUI for HarperDB. Studio enables you to administer, navigate, and monitor all of your HarperDB instances in a simple, user friendly interface without any knowledge of the underlying HarperDB API. It’s free to sign up, get started today!

Sign up for free!

How does Studio Work?

While HarperDB Studio is web based and hosted by us, all database interactions are performed on the HarperDB instance the studio is connected to. The HarperDB Studio loads in your browser, at which point you login to your HarperDB instances. Credentials are stored in your browser cache and are not transmitted back to HarperDB. All database interactions are made via the HarperDB Operations API directly from your browser to your instance.

What type of instances can I manage?

HarperDB Studio enables users to manage both HarperDB Cloud instances and privately hosted instances all from a single UI. All HarperDB instances feature identical behavior whether they are hosted by us or by you.

Start at the HarperDB Studio sign up page.

1. Provide the following information:

   • First Name

   • Last Name

   • Email Address

   • Subdomain

     Part of the URL that will be used to identify your HarperDB Cloud Instances. For example, with subdomain “demo” and instance name “c1” the instance URL would be: https://c1-demo.harperdbcloud.com.

   • Coupon Code (optional)

2. Review the Privacy Policy and Terms of Service.

3. Click the sign up for free button.

4. You will be taken to a new screen to add an account password. Enter your password. Passwords must be a minimum of 8 characters with at least 1 lower case character, 1 upper case character, 1 number, and 1 special character.

5. Click the add account password button.

You will receive a Studio welcome email confirming your registration.

Note: Your email address will be used as your username and cannot be changed.

Manage instance schemas/tables and browse data in tabular format with the following instructions:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization that the instance belongs to.

3. Select your desired instance.

4. Click browse in the instance control bar.

Once on the instance browse page you can view data, manage schemas and tables, add new data, and more.

Manage Schemas and Tables

Create a Schema

1. Click the plus icon at the top right of the schemas section.

2. Enter the schema name.

3. Click the green check mark.

Delete a Schema

Deleting a schema is permanent and irreversible. Deleting a schema removes all tables and data within it.

1. Click the minus icon at the top right of the schemas section.

2. Identify the appropriate schema to delete and click the red minus sign in the same row.

3. Click the red check mark to confirm deletion.

Create a Table

1. Select the desired schema from the schemas section.

2. Click the plus icon at the top right of the tables section.

3. Enter the table name.

4. Enter the primary key.

   The primary key is also often referred to as the hash attribute in the studio, and it defines the unique identifier for each row in your table.

5. Click the green check mark.

Delete a Table

Deleting a table is permanent and irreversible. Deleting a table removes all data within it.

1. Select the desired schema from the schemas section.

2. Click the minus icon at the top right of the tables section.

3. Identify the appropriate table to delete and click the red minus sign in the same row.

4. Click the red check mark to confirm deletion.

Manage Table Data

The following section assumes you have selected the appropriate table from the schema/table browser.

Filter Table Data

1. Click the magnifying glass icon at the top right of the table browser.

2. This expands the search filters.

3. The results will be filtered appropriately.

Load CSV Data

1. Click the data icon at the top right of the table browser. You will be directed to the CSV upload page where you can choose to import a CSV by URL or upload a CSV file.

2. To import a CSV by URL:

   1. Enter the URL in the CSV file URL textbox.

   2. Click Import From URL.

   3. The CSV will load, and you will be redirected back to browse table data.

3. To upload a CSV file:

   1. Click Click or Drag to select a .csv file (or drag your CSV file from your file browser).

   2. Navigate to your desired CSV file and select it.

   3. Click Insert X Records, where X is the number of records in your CSV.

   4. The CSV will load, and you will be redirected back to browse table data.

Add a Record

1. Click the plus icon at the top right of the table browser.

2. The Studio will pre-populate existing table attributes in JSON format.

   The primary key is not included, but you can add it in and set it to your desired value. Auto-maintained fields are not included and cannot be manually set. You may enter a JSON array to insert multiple records in a single transaction.

3. Enter values to be added to the record.

   You may add new attributes to the JSON; they will be reflexively added to the table.

4. Click the Add New button.

Edit a Record

1. Click the record/row you would like to edit.

2. Modify the desired values.

   You may add new attributes to the JSON; they will be reflexively added to the table.

3. Click the save icon.

Delete a Record

Deleting a record is permanent and irreversible. If transaction logging is turned on, the delete transaction will be recorded as well as the data that was deleted.

1. Click the record/row you would like to delete.

2. Click the delete icon.

3. Confirm deletion by clicking the check icon.

Browse Table Data

The following section assumes you have selected the appropriate table from the schema/table browser.

Browse Table Data

The first page of table data is automatically loaded on table selection. Paging controls are at the bottom of the table. Here you can:

• Page left and right using the arrows.

• Type in the desired page.

• Change the page size (the amount of records displayed in the table).

Refresh Table Data

Click the refresh icon at the top right of the table browser.

Automatically Refresh Table Data

Toggle the auto switch at the top right of the table browser. The table data will now automatically refresh every 15 seconds. Filters and pages will remain set for refreshed data.

HarperDB instance clustering and replication can be configured directly through the HarperDB Studio. It is recommended to read through the clustering documentation first to gain a strong understanding of HarperDB clustering behavior.

Instance user configuration is handled through the users page of the HarperDB Studio, accessed with the following instructions:

1. Navigate to the page.

2. Click the appropriate organization that the instance belongs to.

3. Select your desired instance.

4. Click users in the instance control bar.

Note, the users page will only be available to super users.

Add a User

HarperDB instance users can be added with the following instructions.

1. In the add user panel on the left enter:

   • New user username.

   • New user password.

   • Select a role.

     Learn more about role management here: .

2. Click Add User.

Edit a User

HarperDB instance users can be modified with the following instructions.

1. In the existing users panel, click the row of the user you would like to edit.

2. To change a user’s password:

   1. In the Change user password section, enter the new password.

   2. Click Update Password.

3. To change a user’s role:

   1. In the Change user role section, select the new role.

   2. Click Update Role.

4. To delete a user:

   1. In the Delete User section, type the username into the textbox.

      This is done for confirmation purposes.

   2. Click Delete User.

Resources (Marketplace, Drivers, Tutorials, & Example Code)

HarperDB Studio resources are available regardless of whether or not you are logged in.

HarperDB Marketplace

The is a collection of SDKs and connectors that enable developers to expand upon HarperDB for quick and easy solution development. Extensions are built and supported by the HarperDB Community. Each extension is hosted on the appropriate package manager or host.

To download a Marketplace extension:

1. Navigate to the page.

2. Identity the extension you would like to use.

3. Either click the link to the package.

4. Follow the extension’s instructions to proceed.

You can submit your rating for each extension by clicking on the stars.

HarperDB Drivers

HarperDB offers standard drivers to connect real-time HarperDB data with BI, analytics, reporting and data visualization technologies. Drivers are built and maintained by .

To download a driver:

1. Navigate to the page.

2. Identity the driver you would like to use.

3. Click the download link.

4. For additional instructions, visit the support link on the driver card.

Video Tutorials

Example Code

The HarperDB Studio allows you to administer all of your HarperDB instances in one place. HarperDB currently offers the following instance types:

• HarperDB Cloud Instance Managed installations of HarperDB, what we call HarperDB Cloud.

• 5G Wavelength Instance Managed installations of HarperDB running on the Verizon network through AWS Wavelength, what we call 5G Wavelength Instances. Note, these instances are only accessible via the Verizon network.

• User-Installed Instance Any HarperDB installation that is managed by you. These include instances hosted within your cloud provider accounts (for example, from the AWS or Digital Ocean Marketplaces), privately hosted instances, or instances installed locally.

All interactions between the Studio and your instances take place directly from your browser. HarperDB stores metadata about your instances, which enables the Studio to display these instances when you log in. Beyond that, all traffic is routed from your browser to the HarperDB instances using the standard HarperDB API.

Organization Instance List

A summary view of all instances within an organization can be viewed by clicking on the appropriate organization from the HarperDB Studio Organizations page. Each instance gets their own card. HarperDB Cloud and user-installed instances are listed together.

Create a New Instance

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization for the instance to be created under.

3. Click the Create New HarperDB Cloud Instance + Register User-Installed Instance card.

4. Select your desired Instance Type.

5. For a HarperDB Cloud Instance or a HarperDB 5G Wavelength Instance, click Create HarperDB Cloud Instance.

   1. Fill out Instance Info.

      1. Enter Instance Name

         This will be used to build your instance URL. For example, with subdomain “demo” and instance name “c1” the instance URL would be: https://c1-demo.harperdbcloud.com. The Instance URL will be previewed below.

      2. Enter Instance Username

         This is the username of the initial HarperDB instance super user.

      3. Enter Instance Password

         This is the password of the initial HarperDB instance super user.

   2. Click Instance Details to move to the next page.

   3. Select Instance Specs

      1. Select Instance RAM

         HarperDB Cloud Instances are billed based on Instance RAM, this will select the size of your provisioned instance. More on instance specs.

      2. Select Storage Size

         Each instance has a mounted storage volume where your HarperDB data will reside. Storage is provisioned based on space and IOPS. More on IOPS Impact on Performance.

      3. Select Instance Region

         The geographic area where your instance will be provisioned.

   4. Click Confirm Instance Details to move to the next page.

   5. Review your Instance Details, if there is an error, use the back button to correct it.

   6. Review the Privacy Policy and Terms of Service, if you agree, click the I agree radio button to confirm.

   7. Click Add Instance.

   8. Your HarperDB Cloud instance will be provisioned in the background. Provisioning typically takes 5-15 minutes. You will receive an email notification when your instance is ready.

Register User-Installed Instance

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization for the instance to be created under.

3. Click the Create New HarperDB Cloud Instance + Register User-Installed Instance card.

4. Select Register User-Installed Instance.

   1. Fill out Instance Info.

      1. Enter Instance Name

         This is used for descriptive purposes only.

      2. Enter Instance Username

         The username of a HarperDB super user that is already configured in your HarperDB installation.

      3. Enter Instance Password

         The password of a HarperDB super user that is already configured in your HarperDB installation.

      4. Enter Host

         The host to access the HarperDB instance. For example, harperdb.myhost.com or localhost.

      5. Enter Port

         The port to access the HarperDB instance. HarperDB defaults 9925.

      6. Select SSL

         If your instance is running over SSL, select the SSL checkbox. If not, you will need to enable mixed content in your browser to allow the HTTPS Studio to access the HTTP instance. If there are issues connecting to the instance, the Studio will display a red error message.

   2. Click Instance Details to move to the next page.

   3. Select Instance Specs

      1. Select Instance RAM

         HarperDB instances are billed based on Instance RAM. Selecting additional RAM will enable the ability for faster and more complex queries.

   4. Click Confirm Instance Details to move to the next page.

   5. Review your Instance Details, if there is an error, use the back button to correct it.

   6. Review the Privacy Policy and Terms of Service, if you agree, click the I agree radio button to confirm.

   7. Click Add Instance.

   8. The HarperDB Studio will register your instance and restart it for the registration to take effect. Your instance will be immediately available after this is complete.

Delete an Instance

Instance deletion has two different behaviors depending on the instance type.

• HarperDB Cloud Instance This instance will be permanently deleted, including all data. This process is irreversible and cannot be undone.

• User-Installed Instance The instance will be removed from the HarperDB Studio only. This does not uninstall HarperDB from your system and your data will remain intact.

An instance can be deleted as follows:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization that the instance belongs to.

3. Identify the proper instance card and click the trash can icon.

4. Enter the instance name into the text box.

   This is done for confirmation purposes to ensure you do not accidentally delete an instance.

5. Click the Do It button.

Upgrade an Instance

HarperDB instances can be resized on the Instance Configuration page.

Instance Log In/Log Out

The Studio enables users to log in and out of different database users from the instance control panel. To log out of an instance:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization that the instance belongs to.

3. Identify the proper instance card and click the lock icon.

4. You will immediately be logged out of the instance.

To log in to an instance:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization that the instance belongs to.

3. Identify the proper instance card, it will have an unlocked icon and a status reading PLEASE LOG IN, and click the center of the card.

4. Enter the database username.

   The username of a HarperDB user that is already configured in your HarperDB instance.

5. Enter the database password.

   The password of a HarperDB user that is already configured in your HarperDB instance.

6. Click Log In.

HarperDB Custom Functions are enabled by default and can be configured further through the HarperDB Studio. It is recommended to read through the Custom Functions documentation first to gain a strong understanding of HarperDB Custom Functions behavior.

All Custom Functions configuration is handled through the functions page of the HarperDB Studio, accessed with the following instructions:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization that the instance belongs to.

3. Select your desired instance.

4. Click functions in the instance control bar.

Note, the functions page will only be available to super users.

Manage Projects

On the functions page of the HarperDB Studio you are presented with a functions management screen with the following properties:

• projects

  Displays a list of Custom Functions projects residing on this instance.

• /project_name/routes

  Only displayed if there is an existing project. Displays the routes files contained within the selected project.

• /project_name/helpers

  Only displayed if there is an existing project. Displays the helper files contained within the selected project.

• /project_name/static

  Only displayed if there is an existing project. Displays the static file count and a link to the static files contained within the selected project. Note, static files cannot currently be deployed through the Studio and must be deployed via the HarperDB API or manually to the server (not applicable with HarperDB Cloud).

• Root File Directory

  Displays the root file directory where the Custom Functions projects reside on this instance.

• Custom Functions Server URL

  Displays the base URL in which all Custom Functions are accessed for this instance.

Create a Project

HarperDB Custom Functions Projects can be initialized with the following instructions.

1. If this is your first project, skip this step. Click the plus icon next to the projects heading.

2. Enter the project name in the text box located under the projects heading.

3. Click the check mark icon next the appropriate instance.

4. The Studio will take a few moments to provision a new project based on the Custom Functions template.

5. The Custom Functions project is now created and ready to modify.

Modify a Project

Custom Functions routes and helper functions can be modified directly through the Studio. From the functions page:

1. Select the appropriate project.

2. Select the appropriate route or helper.

3. Modify the code with your desired changes.

4. Click the save icon at the bottom right of the screen.

   Note, saving modifications will restart the Custom Functions server on your HarperDB instance and may result in up to 60 seconds of downtime for all Custom Functions.

Create Additional Routes/Helpers

To create an additional route to your Custom Functions project. From the functions page:

1. Select the appropriate Custom Functions project.

2. Click the plus icon to the right of the routes header.

3. Enter the name of the new route in the textbox that appears.

4. Click the check icon to create the new route.

   Note, adding a route will restart the Custom Functions server on your HarperDB instance and may result in up to 60 seconds of downtime for all Custom Functions.

To create an additional helper to your Custom Functions project. From the functions page:

1. Select the appropriate Custom Functions project.

2. Click the plus icon to the right of the helpers header.

3. Enter the name of the new helper in the textbox that appears.

4. Click the check icon to create the new helper.

   Note, adding a helper will restart the Custom Functions server on your HarperDB instance and may result in up to 60 seconds of downtime for all Custom Functions.

Delete a Project/Route/Helper

To delete a Custom Functions project from the functions page:

1. Click the minus icon to the right of the projects header.

2. Click the red minus icon to the right of the Custom Functions project you would like to delete.

3. Confirm deletion by clicking the red check icon.

   Note, deleting a project will restart the Custom Functions server on your HarperDB instance and may result in up to 60 seconds of downtime for all Custom Functions.

To delete a Custom Functions project route from the functions page:

1. Select the appropriate Custom Functions project.

2. Click the minus icon to the right of the routes header.

3. Click the red minus icon to the right of the Custom Functions route you would like to delete.

4. Confirm deletion by clicking the red check icon.

   Note, deleting a route will restart the Custom Functions server on your HarperDB instance and may result in up to 60 seconds of downtime for all Custom Functions.

To delete a Custom Functions project helper from the functions page:

1. Select the appropriate Custom Functions project.

2. Click the minus icon to the right of the helper header.

3. Click the red minus icon to the right of the Custom Functions header you would like to delete.

4. Confirm deletion by clicking the red check icon.

   Note, deleting a header will restart the Custom Functions server on your HarperDB instance and may result in up to 60 seconds of downtime for all Custom Functions.

Deploy Custom Functions Project to Other Instances

The HarperDB Studio provides the ability to deploy Custom Functions projects to additional HarperDB instances within the same Studio Organization. To deploy Custom Functions projects to additional instances, starting from the functions page:

1. Select the project you would like to deploy.

2. Click the deploy button at the top right.

3. A list of instances (excluding the current instance) within the organization will be displayed in tabular with the following information:

   • Instance Name: The name used to describe the instance.

   • Instance URL: The URL used to access the instance.

   • CF Capable: Describes if the instance version supports Custom Functions (yes/no).

   • CF Enabled: Describes if Custom Functions are configured and enabled on the instance (yes/no).

   • Has Project: Describes if the selected Custom Functions project has been previously deployed to the instance (yes/no).

   • Deploy: Button used to deploy the project to the instance.

   • Remote: Button used to remove the project from the instance. Note, this will only be visible if the project has been previously deployed to the instance.

4. In the appropriate instance row, click the deploy button.

   Note, deploying a project will restart the Custom Functions server on the HarperDB instance receiving the deployment and may result in up to 60 seconds of downtime for all Custom Functions.

HarperDB instance clustering and replication can be configured directly through the HarperDB Studio. It is recommended to read through the clustering documentation first to gain a strong understanding of HarperDB clustering behavior.

All clustering configuration is handled through the cluster page of the HarperDB Studio, accessed with the following instructions:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization that the instance belongs to.

3. Select your desired instance.

4. Click cluster in the instance control bar.

Note, the cluster page will only be available to super users.

Initial Configuration

HarperDB instances do not have clustering configured by default. The HarperDB Studio will walk you through the initial configuration. Upon entering the cluster screen for the first time you will need to complete the following configuration. Configurations are set in the enable clustering panel on the left while actions are described in the middle of the screen.

1. Create a cluster user, read more about this here: Clustering Users and Roles.

   • Enter username.

   • Enter password.

   • Click Create Cluster User.

2. Click Set Cluster Node Name.

3. Click Enable Instance Clustering.

At this point the Studio will restart your HarperDB Instance, required for the configuration changes to take effect.

Manage Clustering

Once initial clustering configuration is completed you a presented with a clustering management screen with the following properties:

• connected instances

  Displays all instances within the Studio Organization that this instance manages a connection with.

• unconnected instances

  Displays all instances within the Studio Organization that this instance does not manage a connection with.

• unregistered instances

  Displays all instances outside of the Studio Organization that this instance manages a connection with.

• manage clustering

  Once instances are connected, this will display clustering management options for all connected instances and all schemas and tables.

Connect an Instance

HarperDB Instances can be clustered together with the following instructions.

1. Ensure clustering has been configured on both instances and a cluster user with identical credentials exists on both.

2. Identify the instance you would like to connect from the unconnected instances panel.

3. Click the plus icon next the appropriate instance.

4. If configurations are correct, all schemas will sync across the cluster, then appear in the manage clustering panel. If there is a configuration issue, a red exclamation icon will appear, click it to learn more about what could be causing the issue.

Disconnect an Instance

HarperDB Instances can be disconnected with the following instructions.

1. Identify the instance you would like to disconnect from the connected instances panel.

2. Click the minus icon next the appropriate instance.

Manage Replication

Subscriptions must be configured in order to move data between connected instances. Read more about subscriptions here: Creating A Subscription. The manage clustering panel displays a table with each row representing an channel per instance. Cells are bolded to indicate a change in the column. Publish and subscribe replication can be configured per table with the following instructions:

1. Identify the instance, schema, and table for replication to be configured.

2. For publish, click the toggle switch in the publish column.

3. For subscribe, click the toggle switch in the subscribe column.

HarperDB Studio organizations provide the ability to group HarperDB Cloud Instances. Organization behavior is as follows:

• Billing occurs at the organization level to a single credit card.

• Organizations retain their own unique HarperDB Cloud subdomain.

• Cloud instances reside within an organization.

• Studio users can be invited to organizations to share instances.

An organization is automatically created for you when you sign up for HarperDB Studio. If you only have one organization, the Studio will automatically bring you to your organization’s page.

List Organizations

A summary view of all organizations your user belongs to can be viewed on the HarperDB Studio Organizations page. You can navigate to this page at any time by clicking the all organizations link at the top of the HarperDB Studio.

Create a New Organization

A new organization can be created as follows:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the Create a New Organization card.

3. Fill out new organization details

   • Enter Organization Name This is used for descriptive purposes only.

   • Enter Organization Subdomain Part of the URL that will be used to identify your HarperDB Cloud Instances. For example, with subdomain “demo” and instance name “c1” the instance URL would be: https://c1-demo.harperdbcloud.com.

4. Click Create Organization.

Delete an Organization

An organization cannot be deleted until all instances have been removed. An organization can be deleted as follows:

1. Navigate to the HarperDB Studio Organizations page.

2. Identify the proper organization card and click the trash can icon.

3. Enter the organization name into the text box.

   This is done for confirmation purposes to ensure you do not accidentally delete an organization.

4. Click the Do It button.

Manage Users

HarperDB Studio organization owners can manage users including inviting new users, removing users, and toggling ownership.

Inviting a User

A new user can be invited to an organization as follows:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization card.

3. Click users at the top of the screen.

4. In the add user box, enter the new user’s email address.

5. Click Add User.

Users may or may not already be HarperDB Studio users when adding them to an organization. If the HarperDB Studio account already exists, the user will receive an email notification alerting them to the organization invitation. If the user does not have a HarperDB Studio account, they will receive an email welcoming them to HarperDB Studio.

Toggle a User’s Organization Owner Status

Organization owners have full access to the organization including the ability to manage organization users, create, modify, and delete instances, and delete the organization. Users must have accepted their invitation prior to being promoted to an owner. A user’s organization owner status can be toggled owner as follows:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization card.

3. Click users at the top of the screen.

4. Click the appropriate user from the existing users section.

5. Toggle the Is Owner switch to the desired status.

Remove a User from an Organization

Users may be removed from an organization at any time. Removing a user from an organization will not delete their HarperDB Studio account, it will only remove their access to the specified organization. A user can be removed from an organization as follows:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization card.

3. Click users at the top of the screen.

4. Click the appropriate user from the existing users section.

5. Type DELETE in the text box in the Delete User row.

   This is done for confirmation purposes to ensure you do not accidentally delete a user.

6. Click Delete User.

Manage Billing

Billing is configured per organization and will be billed to the stored credit card at appropriate intervals (monthly or annually depending on the registered instance). Billing settings can be configured as follows:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization card.

3. Click billing at the top of the screen.

Here organization owners can view invoices, manage coupons, and manage the associated credit card.

HarperDB billing and payments are managed via Stripe.

Add a Coupon

Coupons are applicable towards any paid tier or user-installed instance and you can change your subscription at any time. Coupons can be added to your Organization as follows:

1. In the coupons panel of the billing page, enter your coupon code.

2. Click Add Coupon.

3. The coupon will then be available and displayed in the coupons panel.

HarperDB users can be managed directly through the HarperDB Studio. It is recommended to read through the users & roles documentation to gain a strong understanding of how they operate.

Instance role configuration is handled through the roles page of the HarperDB Studio, accessed with the following instructions:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization that the instance belongs to.

3. Select your desired instance.

4. Click rules in the instance control bar.

Note, the roles page will only be available to super users.

The roles management screen consists of the following panels:

• super users

  Displays all super user roles for this instance.

• cluster users

  Displays all cluster user roles for this instance.

• standard roles

  Displays all standard roles for this instance.

• role permission editing

  Once a role is selected for editing, permissions will be displayed here in JSON format.

Note, when new tables are added that are not configured, the Studio will generate configuration values with permissions defaulting to false.

Role Management

Create a Role

1. Click the plus icon at the top right of the appropriate role section.

2. Enter the role name.

3. Click the green check mark.

4. Configure the role permissions in the role permission editing panel.

   Note, to have the Studio generate attribute permissions JSON, toggle show all attributes at the top right of the role permission editing panel.

5. Click Update Role Permissions.

Modify a Role

1. Click the appropriate role from the appropriate role section.

2. Modify the role permissions in the role permission editing panel.

   Note, to have the Studio generate attribute permissions JSON, toggle show all attributes at the top right of the role permission editing panel.

3. Click Update Role Permissions.

Delete a Role

Deleting a role is permanent and irreversible. A role cannot be remove if users are associated with it.

1. Click the minus icon at the top right of the schemas section.

2. Identify the appropriate role to delete and click the red minus sign in the same row.

3. Click the red check mark to confirm deletion.

The HarperDB Studio includes a charting feature within an instance. They are generated in real time based on your existing data and automatically refreshed every 15 seconds. Instance charts can be accessed with the following instructions:

1. Navigate to the HarperDB Studio Organizations page.

2. Click the appropriate organization that the instance belongs to.

3. Select your desired instance.

4. Click charts in the instance control bar.

Creating a New Chart

Charts are generated based on SQL queries, therefore to build a new chart you first need to build a query. Instructions as follows (starting on the charts page described above):

1. Click query in the instance control bar.

2. Enter the SQL query you would like to generate a chart from.

   For example, using the dog demo data from the API Docs, we can get the average dog age per owner with the following query: SELECT AVG(age) as avg_age, owner_name FROM dev.dog GROUP BY owner_name.

3. Click Execute.

4. Click create chart at the top right of the results table.

5. Configure your chart.

   1. Choose chart type.

      HarperDB Studio offers many standard charting options like line, bar, etc.

   2. Choose a data column.

      This column will be used to plot the data point. Typically, this is the values being calculated in the SELECT statement. Depending on the chart type, you can select multiple data columns to display on a single chart.

   3. Depending on the chart type, you will need to select a grouping.

      This could be labeled as x-axis, label, etc. This will be used to group the data, typically this is what you used in your GROUP BY clause.

   4. Enter a chart name.

      Used for identification purposes and will be displayed at the top of the chart.

   5. Choose visible to all org users toggle.

      Leaving this option off will limit chart visibility to just your HarperDB Studio user. Toggling it on will enable all users with this Organization to view this chart.

   6. Click Add Chart.

   7. The chart will now be visible on the charts page.

The example query above, configured as a bar chart, results in the following chart:

Downloading Charts

HarperDB Studio charts can be downloaded in SVG, PNG, and CSV format. Instructions as follows (starting on the charts page described above):

1. Identify the chart you would like to export.

2. Click the three bars icon.

3. Select the appropriate download option.

4. The Studio will generate the export and begin downloading immediately.

Delete a Chart

Delete a chart as follows (starting on the charts page described above):

1. Identify the chart you would like to delete.

2. Click the X icon.

3. Click the confirm delete chart button.

4. The chart will be deleted.

Deleting a chart that is visible to all Organization users will delete it for all users.

Enabling mixed content is required in cases where you would like to connect the HarperDB Studio to HarperDB Instances via HTTP. This should not be used for production systems, but may be convenient for development and testing purposes. Doing so will allow your browser to reach HTTP traffic, which is considered insecure, through an HTTPS site like the Studio.

A comprehensive guide is provided by Adobe .

HarperDB instance configuration can be viewed and managed directly through the HarperDB Studio. HarperDB Cloud instances can be resized in two different ways via this page, either by modifying machine RAM or by increasing drive storage. User-installed instances can have their licenses modified by modifying licensed RAM.

All instance configuration is handled through the config page of the HarperDB Studio, accessed with the following instructions:

1. Navigate to the page.

2. Click the appropriate organization that the instance belongs to.

3. Select your desired instance.

4. Click config in the instance control bar.

Note, the config page will only be available to super users and certain items are restricted to Studio organization owners.

Instance Overview

The instance overview panel displays the following instance specifications:

• Instance URL

• Instance Node Name (for clustering)

• Instance API Auth Header (this user)

  The Basic authentication header used for the logged in HarperDB database user

• Created Date (HarperDB Cloud only)

• Region (HarperDB Cloud only)

  The geographic region where the instance is hosted.

• Total Price

• RAM

• Storage (HarperDB Cloud only)

• Disk IOPS (HarperDB Cloud only)

Update Instance RAM

HarperDB Cloud instance size and user-installed instance licenses can be modified with the following instructions. This option is only available to Studio organization owners.

Note: For HarperDB Cloud instances, upgrading RAM may add additional CPUs to your instance as well. Click here to see how many CPUs are provisioned for each instance size.

1. In the update ram panel at the bottom left:

   • Select the new instance size.

   • If you do not have a credit card associated with your account, an Add Credit Card To Account button will appear. Click that to be taken to the billing screen where you can enter your credit card information before returning to the config tab to proceed with the upgrade.

   • If you do have a credit card associated, you will be presented with the updated billing information.

   • Click Upgrade.

2. The instance will shut down and begin reprovisioning/relicensing itself. The instance will not be available during this time. You will be returned to the instance dashboard and the instance status will show UPDATING INSTANCE.

3. Once your instance upgrade is complete, it will appear on the instance dashboard as status OK with your newly selected instance size.

Note, if HarperDB Cloud instance reprovisioning takes longer than 20 minutes, please submit a support ticket here: https://harperdbhelp.zendesk.com/hc/en-us/requests/new.

Update Instance Storage

The HarperDB Cloud instance storage size can be increased with the following instructions. This option is only available to Studio organization owners.

Note: Instance storage can only be upgraded once every 6 hours.

1. In the update storage panel at the bottom left:

   • Select the new instance storage size.

   • If you do not have a credit card associated with your account, an Add Credit Card To Account button will appear. Click that to be taken to the billing screen where you can enter your credit card information before returning to the config tab to proceed with the upgrade.

   • If you do have a credit card associated, you will be presented with the updated billing information.

   • Click Upgrade.

2. The instance will shut down and begin reprovisioning itself. The instance will not be available during this time. You will be returned to the instance dashboard and the instance status will show UPDATING INSTANCE.

3. Once your instance upgrade is complete, it will appear on the instance dashboard as status OK with your newly selected instance size.

Note, if this process takes longer than 20 minutes, please submit a support ticket here: https://harperdbhelp.zendesk.com/hc/en-us/requests/new.

Remove Instance

The HarperDB instance can be deleted/removed from the Studio with the following instructions. Once this operation is started it cannot be undone. This option is only available to Studio organization owners.

1. In the remove instance panel at the bottom left:

   • Enter the instance name in the text box.

   • The Studio will present you with a warning.

   • Click Remove.

2. The instance will begin deleting immediately.

Restart Instance

The HarperDB Cloud instance can be restarted with the following instructions.

1. In the restart instance panel at the bottom right:

   • Enter the instance name in the text box.

   • The Studio will present you with a warning.

   • Click Restart.

2. The instance will begin restarting immediately.

Example code prepopulated with the instance URL and authorization token for the logged in database user can be found on the example code page of the HarperDB Studio. Code samples are generated based on the HarperDB API Documentation Postman collection. Code samples accessed with the following instructions:

1. Navigate to the page.

2. Click the appropriate organization that the instance belongs to.

3. Select your desired instance.

4. Click example code in the instance control bar.

5. Select the appropriate category from the left navigation.

6. Select the appropriate operation from the left navigation.

7. Select your desired language/variant from the Choose Programming Language dropdown.

8. Copy code from the sample code panel using the copy icon.

Supported Languages

Sample code uses two identifiers: language and variant.

• language is the programming language that the sample code is generated in.

• variant is the methodology or library used by the language to send HarperDB requests.

The list of available language/variants are as follows:

The HarperDB Studio display instance status and metrics on the instance status page, which can be accessed with the following instructions:

1. Navigate to the page.

2. Click the appropriate organization that the instance belongs to.

3. Select your desired instance.

4. Click status in the instance control bar.

Once on the instance browse page you can view host system information, , and (if it is a cloud instance).

Note, the status page will only be available to super users.

SQL queries can be executed directly through the HarperDB Studio with the following instructions:

1. Navigate to the page.

2. Click the appropriate organization that the instance belongs to.

3. Select your desired instance.

4. Click query in the instance control bar.

5. Enter your SQL query in the SQL query window.

6. Click Execute.

Please note, the Studio will execute the query exactly as entered. For example, if you attempt to SELECT * from a table with millions of rows, you will most likely crash your browser.

Browse Query Results Set

Browse Results Set Data

The first page of results set data is automatically loaded on query execution. Paging controls are at the bottom of the table. Here you can:

• Page left and right using the arrows.

• Type in the desired page.

• Change the page size (the amount of records displayed in the table).

Refresh Results Set

Click the refresh icon at the top right of the results set table.

Automatically Refresh Results Set

Toggle the auto switch at the top right of the results set table. The results set will now automatically refresh every 15 seconds. Filters and pages will remain set for refreshed data.

Query History

Query history is stored in your local browser cache. Executed queries are listed with the most recent at the top in the query history section.

Rerun Previous Query

• Identify the query from the query history list.

• Click the appropriate query. It will be loaded into the sql query input box.

• Click Execute.

Clear Query History

Click the trash can icon at the top right of the query history section.

Create Charts

The HarperDB Studio includes a charting feature where you can build charts based on your specified queries. Visit the Charts documentation for more information.