HarperDB
HarperDB is a database and application development platform that is focused on performance and ease of use. With flexible user-defined APIs, simple HTTP/S interface, and a high-performance single-model data store that accommodates both NoSQL and SQL workloads, HarperDB scales with your application from proof of concept to production. ToolJet integrates with HarperDB, providing a streamlined interface for reading and writing data.
![Marketplace: HarperDB](/img/marketplace/plugins/harperdb/harperconnect.gif)
Before following this guide, it is recommended to check the following doc: Using Marketplace plugins.
Connection
To establish a connection with HarperDB, you need the following credentials:
- Host: The hostname or IP address of your HarperDB instance (e.g.,
162.156.250.74
ormyinstance.harperdbcloud.com
). - Port: The port number configured for your server (default is
9925
). If you are using HarperDB Studio(cloud), leave the field empty or set it to443
. - SSL: Indicates whether the connection requires SSL encryption.
- Username: Your authentication username for HarperDB instance.
- Password: Your password for authentication (hidden for security purposes).
![Marketplace: HarperDB](/img/marketplace/plugins/harperdb/creds.png)
Querying HarperDB
To perform queries on HarperDB, click the +Add
button in the query manager located at the bottom panel of the app builder. Select the HarperDB from the Global Datasource section in the query editor.
![Marketplace: HarperDB](/img/marketplace/plugins/harperdb/query.png)
SQL Mode
SQL mode enables you to perform various operations on the database using SQL statements.
Select
The SELECT statement is used to query data from the database.
Syntax:
SELECT * FROM sampleorg.people WHERE id = 1
![Marketplace: HarperDB](/img/marketplace/plugins/harperdb/select.png)
Insert
The INSERT statement is used to add one or more rows to a database table.
Syntax:
INSERT INTO sampleorg.people (id, name, age, country, hobby) VALUE (5, 'Shubh', 26, 'India', 'Football')
![Marketplace: HarperDB](/img/marketplace/plugins/harperdb/insert.png)
Update
The UPDATE statement is used to change the values of specified attributes in one or more rows in a database table.
Syntax:
UPDATE sampleorg.people SET hobby = 'chess' WHERE id = 5
![Marketplace: HarperDB](/img/marketplace/plugins/harperdb/update.png)
Delete
The DELETE statement is used to remove one or more rows of data from a database table.
Syntax:
DELETE FROM sampleorg.people WHERE id = 5
![Marketplace: HarperDB](/img/marketplace/plugins/harperdb/delete.png)
NoSQL Mode
NoSQL mode enables you to perform schema-less storage and retrieval of JSON documents.
Insert (NoSQL)
Insert operation allows to add one or more rows of data to a database table.
Parameters | Description |
---|---|
Schema (required) | schema where the table you are inserting records into lives |
Table (required) | table name where you want to insert records |
Records (required) | array of one or more records for insert |
Example Records:
[{id: 22, name: "James Scott", age: 26, country:"Italy", hobby: "football"},...]
![Marketplace: HarperDB](/img/marketplace/plugins/harperdb/nosql_insert.png)
Update (NoSQL)
The Update operation modifies the values of specified attributes in one or more rows of a database table based on the hash attribute(primary key) that identifies the rows.
Parameters | Description |
---|---|
Schema (required) | schema where the table you are updating records into lives |
Table (required) | table name where you want to update records |
Records (required) | array of one or more records for update |
Example Records:
[{id:12, name:"Jeff Hannistor"},...] // Record having 12 as Primary key value will be updated
![Marketplace: HarperDB](/img/marketplace/plugins/harperdb/nosql_update.png)
Delete (NoSQL)
Removes one or more rows of data from a specified table.
Parameters | Description |
---|---|
Schema (required) | schema where the table you are deleting records into lives |
Table (required) | table name where you want to delete records |
Hash Values (required) | array of one or more hash attribute (primary key) values, which identifies records to delete |
Example Hash Values:
[6, 15] // Records having 6 and 15 as Primary key value will be deleted
![Marketplace: HarperDB](/img/marketplace/plugins/harperdb/nosql_delete.png)