Skip to content

Documentation for Operations API #332

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Documentation for Operations API #332

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
bdb328d
Documentation for Operations API
nenharper Sep 30, 2025
2c46b04
Documentation for Operations API
nenharper Sep 30, 2025
0ed27a3
Documentation for Operations API
nenharper Sep 30, 2025
48fcef3
Fix broken links
nenharper Oct 3, 2025
1e61f51
Fix broken links
nenharper Oct 3, 2025
6e78987
Fix broken links
nenharper Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 27 additions & 4 deletions redirects.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,27 @@ function generateDocsRedirects(basePath: string): RedirectRule[] {
// Operations API
{
from: withBase('/developers/operations-api/utilities'),
to: withBase('/developers/operations-api/system-operations'),
to: withBase('/reference/operations-api/system-operations'),
},
{ from: withBase('/developers/operations-api'), to: withBase('/developers/applications/operations-api') },
{
from: withBase('/developers/operations-api/databases-and-tables'),
to: withBase('/reference/operations-api/databases-and-tables'),
},
{
from: withBase('/developers/operations-api/system-operations'),
to: withBase('/reference/operations-api/system-operations'),
},
{ from: withBase('/developers/operations-api/clustering'), to: withBase('/reference/operations-api/clustering') },
{ from: withBase('/developers/operations-api/components'), to: withBase('/reference/operations-api/components') },
{ from: withBase('/developers/operations-api/logs'), to: withBase('/reference/operations-api/logs') },
{
from: withBase('/developers/operations-api/bulk-operations'),
to: withBase('/reference/operations-api/bulk-operations'),
},
{
from: withBase('/developers/operations-api/advanced-json-sql-examples'),
to: withBase('/reference/operations-api/advanced-json-sql-examples'),
},

// Installation paths
Expand Down Expand Up @@ -142,7 +162,10 @@ function generateDocsRedirects(basePath: string): RedirectRule[] {
from: [withBase('/custom-functions/using-npm-git'), withBase('/developers/custom-functions/create-project')],
to: withBase('/developers/applications/'),
},
{ from: withBase('/custom-functions/custom-functions-operations'), to: withBase('/developers/operations-api/') },
{
from: withBase('/custom-functions/custom-functions-operations'),
to: withBase('/developers/applications/operations-api/'),
},
{
from: withBase('/custom-functions/debugging-custom-function'),
to: withBase('/developers/applications/debugging'),
Expand All @@ -162,9 +185,9 @@ function generateDocsRedirects(basePath: string): RedirectRule[] {
{ from: withBase('/audit-logging'), to: withBase('/administration/logging/audit-logging') },
{ from: withBase('/jobs'), to: withBase('/administration/jobs') },
{ from: withBase('/upgrade-hdb-instance'), to: withBase('/deployments/upgrade-hdb-instance') },
{ from: withBase('/operations-api'), to: withBase('/developers/operations-api/') },
{ from: withBase('/operations-api'), to: withBase('/developers/applications/operations-api/') },
{ from: withBase('/rest'), to: withBase('/developers/rest') },
{ from: withBase('/api'), to: withBase('/developers/operations-api/') },
{ from: withBase('/api'), to: withBase('/developers/applications/operations-api/') },

// File rename redirect
{ from: withBase('/administration/logging/logging'), to: withBase('/administration/logging/standard-logging') },
Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-4.6/administration/administration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ As a distributed database, data protection and recovery can benefit from differe

- Availability: As a distributed database Harper is intrinsically built for high-availability and a cluster will continue to run even with complete server(s) failure. This is the first and primary defense for protecting against any downtime or data loss. Harper provides fast horizontal scaling functionality with node cloning, which facilitates ease of establishing high availability clusters.
- [Audit log](administration/logging/audit-logging): Harper defaults to tracking data changes so malicious data changes can be found, attributed, and reverted. This provides security-level defense against data loss, allowing for fine-grained isolation and reversion of individual data without the large-scale reversion/loss of data associated with point-in-time recovery approaches.
- Snapshots: When used as a source-of-truth database for crucial data, we recommend using snapshot tools to regularly snapshot databases as a final backup/defense against data loss (this should only be used as a last resort in recovery). Harper has a [`get_backup`](./developers/operations-api/databases-and-tables#get-backup) operation, which provides direct support for making and retrieving database snapshots. An HTTP request can be used to get a snapshot. Alternatively, volume snapshot tools can be used to snapshot data at the OS/VM level. Harper can also provide scripts for replaying transaction logs from snapshots to facilitate point-in-time recovery when necessary (often customization may be preferred in certain recovery situations to minimize data loss).
- Snapshots: When used as a source-of-truth database for crucial data, we recommend using snapshot tools to regularly snapshot databases as a final backup/defense against data loss (this should only be used as a last resort in recovery). Harper has a [`get_backup`](../reference/operations-api/databases-and-tables#get-backup) operation, which provides direct support for making and retrieving database snapshots. An HTTP request can be used to get a snapshot. Alternatively, volume snapshot tools can be used to snapshot data at the OS/VM level. Harper can also provide scripts for replaying transaction logs from snapshots to facilitate point-in-time recovery when necessary (often customization may be preferred in certain recovery situations to minimize data loss).

### Horizontal Scaling with Node Cloning

Expand All @@ -23,8 +23,8 @@ Harper provides rapid horizontal scaling capabilities through [node cloning func
Harper provides robust capabilities for analytics and observability to facilitate effective and informative monitoring:

- Analytics provides statistics on usage, request counts, load, memory usage with historical tracking. The analytics data can be [accessed through querying](./reference/analytics).
- A large variety of real-time statistics about load, system information, database metrics, thread usage can be retrieved through the [`system_information` API](./developers/operations-api/system-operations).
- Information about the current cluster configuration and status can be found in the [cluster APIs](./developers/operations-api/clustering).
- A large variety of real-time statistics about load, system information, database metrics, thread usage can be retrieved through the [`system_information` API](../reference/operations-api/system-operations).
- Information about the current cluster configuration and status can be found in the [cluster APIs](../reference/operations-api/clustering).
- Analytics and system information can easily be exported to Prometheus with our [Prometheus exporter component](https://github.com/HarperDB-Add-Ons/prometheus_exporter), making it easy visualize and monitor Harper with Graphana.

### Replication Transaction Logging
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-4.6/administration/harper-studio/instances.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Harper Studio allows you to administer all of your HarperDinstances in one p
- **5G Wavelength Instance** Managed installations of Harper running on the Verizon network through AWS Wavelength, what we call 5G Wavelength Instances. _Note, these instances are only accessible via the Verizon network._
- **Enterprise Instance** Any Harper 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. Harper 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 Harper instances using the standard [Harper API](../../developers/operations-api/).
All interactions between the Studio and your instances take place directly from your browser. Harper 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 Harper instances using the standard [Harper API](../../developers/applications/operations-api).

## Organization Instance List

Expand Down
18 changes: 9 additions & 9 deletions versioned_docs/version-4.6/administration/jobs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ The job status can be **COMPLETE** or **IN_PROGRESS**.

Example job operations include:

[csv data load](../developers/operations-api/bulk-operations#csv-data-load)
[csv data load](../reference/operations-api/bulk-operations#csv-data-load)

[csv file load](../developers/operations-api/bulk-operations#csv-file-load)
[csv file load](../reference/operations-api/bulk-operations#csv-file-load)

[csv url load](../developers/operations-api/bulk-operations#csv-url-load)
[csv url load](../reference/operations-api/bulk-operations#csv-url-load)

[import from s3](../developers/operations-api/bulk-operations#import-from-s3)
[import from s3](../reference/operations-api/bulk-operations#import-from-s3)

[delete_records_before](../developers/operations-api/bulk-operations#delete-records-before)
[delete_records_before](../reference/operations-api/bulk-operations#delete-records-before)

[export_local](../developers/operations-api/bulk-operations#export-local)
[export_local](../reference/operations-api/bulk-operations#export-local)

[export_to_s3](../developers/operations-api/bulk-operations#export-to-s3)
[export_to_s3](../reference/operations-api/bulk-operations#export-to-s3)

Example Response from a Job Operation

Expand All @@ -42,7 +42,7 @@ Whenever one of these operations is initiated, an asynchronous job is created an

## Managing Jobs

To check on a job's status, use the [get_job](../developers/operations-api/jobs#get-job) operation.
To check on a job's status, use the [get_job](../reference/operations-api/jobs#get-job) operation.

Get Job Request

Expand Down Expand Up @@ -77,7 +77,7 @@ Get Job Response

## Finding Jobs

To find jobs (if the ID is not known) use the [search_jobs_by_start_date](../developers/operations-api/jobs#search-jobs-by-start-date) operation.
To find jobs (if the ID is not known) use the [search_jobs_by_start_date](../reference/operations-api/jobs#search-jobs-by-start-date) operation.

Search Jobs Request

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-4.6/administration/logging/audit-logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Audit log is enabled by default. To disable the audit log, set `logging.auditLog

#### read_audit_log

The `read_audit_log` operation is flexible, enabling users to query with many parameters. All operations search on a single table. Filter options include timestamps, usernames, and table hash values. Additional examples found in the [Harper API documentation](../../developers/operations-api/logs).
The `read_audit_log` operation is flexible, enabling users to query with many parameters. All operations search on a single table. Filter options include timestamps, usernames, and table hash values. Additional examples found in the [Harper API documentation](../../reference/operations-api/logs).

**Search by Timestamp**

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-4.6/deployments/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The configuration elements in `harperdb-config.yaml` use camelcase, such as `ope

To change a configuration value, edit the `harperdb-config.yaml` file and save any changes. **HarperDB must be restarted for changes to take effect.**

Alternatively, all configuration values can also be modified using environment variables, command line arguments, or the operations API via the [`set_configuration` operation](../developers/operations-api/configuration#set-configuration).
Alternatively, all configuration values can also be modified using environment variables, command line arguments, or the operations API via the [`set_configuration` operation](../reference/operations-api/configuration#set-configuration).

For nested configuration elements, use underscores to represent parent-child relationships. When accessed this way, elements are case-insensitive.

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-4.6/deployments/upgrade-hdb-instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ replication:
- Disable NATS by setting `clustering.enabled` to `false`.
- Stop the instance and upgrade it.
- Start the instance.
- Call [`add_node`](../developers/operations-api/clustering#add-node) on the upgraded instance. In this call, omit `subscriptions` so that a fully replicating cluster is built. The target node for this call should be the bridge node. _Note: depending on your setup, you may need to expand this `add_node` call to include_ [_authorization and/or tls information_](../developers/operations-api/clustering#add-node)_._
- Call [`add_node`](../reference/operations-api/clustering#add-node) on the upgraded instance. In this call, omit `subscriptions` so that a fully replicating cluster is built. The target node for this call should be the bridge node. _Note: depending on your setup, you may need to expand this `add_node` call to include_ [_authorization and/or tls information_](../reference/operations-api/clustering#add-node)_._

```json
{
Expand Down
Loading
Loading