Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/technical-details/reference/globals.md
Original file line number Diff line number Diff line change
Expand Up @@ -304,15 +304,15 @@ server.resources.getMatch('/NewResource/some-id', 'my-protocol');

### `server.operation(operation: Object, context?: Object, authorize?: boolean)`

Execute an operation from the [Operations API](https://docs.harperdb.io/developers/operations-api)
Execute an operation from the [Operations API](../../developers/operations-api)

Parameters:

- `operation` - `Object` - Object matching desired operation's request body
- `context` - `Object` - `{ username: string}` - _optional_ - The specified user
- `authorize` - `boolean` - _optional_ - Indicate the operation should authorize the user or not. Defaults to `false`

Returns a `Promise` with the operation's response as per the [Operations API documentation](https://docs.harperdb.io/developers/operations-api).
Returns a `Promise` with the operation's response as per the [Operations API documentation](../../developers/operations-api).

### `server.nodes`

Expand Down
2 changes: 1 addition & 1 deletion release-notes/v4-tucker/4.3.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ In addition to storage improvements, HarperDB now includes functionality for [co

Compression is now enabled by default for all records over 4KB.

To learn more on how to configure compression visit [configuration](https://docs.harperdb.io/docs/v/4.3/deployments/configuration).
To learn more on how to configure compression visit [configuration](/docs/deployments/configuration).
2 changes: 1 addition & 1 deletion versioned_docs/version-4.1/install-harperdb/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Once Docker Desktop or Docker Engine is installed, visit our [Docker Hub page](h

If you need to install HarperDB on a device that doesn't have an Internet connection, you can choose your version and download the npm package and install it directly (you’ll still need Node.js and NPM):

<a href="[https://products-harperdb-io.s3.us-east-2.amazonaws.com/index.html](https://products-harperdb-io.s3.us-east-2.amazonaws.com/index.html)" style={{background: '#403b8a', color: 'white', border: 'none', outline: 'none', width: '100%', cursor: 'pointer', marginTop: '1.5rem', marginBottom: '3rem', bsBtnPaddingX: '.75rem', '--bs-btn-padding-y': '.375rem', '--bs-btn-font-family': '', '--bs-btn-font-size': '1rem', '--bs-btn-font-weight': '400', '--bs-btn-line-height': '1.5', '--bs-btn-color': '#212529', '--bs-btn-bg': 'transparent', '--bs-btn-border-width': '1px', '--bs-btn-border-color': 'transparent', '--bs-btn-border-radius': '.375rem', '--bs-btn-hover-border-color': 'transparent', '--bs-btn-box-shadow': 'inset 0 1px 0 rgba(255,255,255,.15),0 1px 1px rgba(0,0,0,.075)', '--bs-btn-disabled-opacity': '.65', '--bs-btn-focus-box-shadow': '0 0 0 .25rem rgba(var(--bs-btn-focus-shadow-rgb),.5)', display: 'inline-block', padding: 'var(--bs-btn-padding-y) var(--bs-btn-padding-x)', fontFamily: 'var(--bs-btn-font-family)', fontSize: 'var(--bs-btn-font-size)', fontWeight: 'var(--bs-btn-font-weight)', lineHeight: 'var(--bs-btn-line-height)', color: 'var(--bs-btn-color)', textAlign: 'center', textDecoration: 'none', verticalAlign: 'middle', userSelect: 'none', border: 'var(--bs-btn-border-width) solid var(--bs-btn-border-color)', borderRadius: 'var(--bs-btn-border-radius)', backgroundColor: 'var(--bs-btn-bg)', transition: 'color .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out', WebkitAppearance: 'button', textTransform: 'none'}}>Download Install Package</a>
[Download Install Package](https://products-harperdb-io.s3.us-east-2.amazonaws.com/index.html)

Once you’ve downloaded the .tgz file, run the following command from the directory where you’ve placed it:

Expand Down
12 changes: 6 additions & 6 deletions versioned_docs/version-4.2/developers/operations-api/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Logs

## Read HarperDB Log

Returns log outputs from the primary HarperDB log based on the provided search criteria. Read more about HarperDB logging here: [https://docs.harperdb.io/docs/logging#read-logs-via-the-api](https://docs.harperdb.io/docs/logging#read-logs-via-the-api).
Returns log outputs from the primary HarperDB log based on the provided search criteria. Read more about HarperDB logging here: [https://docs.harperdb.io/docs/4.2/administration/logging#read-logs-via-the-api](../../administration/logging#read-logs-via-the-api).

_Operation is restricted to super_user roles only_

Expand Down Expand Up @@ -64,7 +64,7 @@ _Operation is restricted to super_user roles only_

## Read Transaction Log

Returns all transactions logged for the specified database table. You may filter your results with the optional from, to, and limit fields. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/transaction-logging#read_transaction_log](https://docs.harperdb.io/docs/transaction-logging#read_transaction_log).
Returns all transactions logged for the specified database table. You may filter your results with the optional from, to, and limit fields. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/4.2/administration/logging/transaction-logging#read_transaction_log](../../administration/logging/transaction-logging#read_transaction_log).

_Operation is restricted to super_user roles only_

Expand Down Expand Up @@ -299,7 +299,7 @@ _Operation is restricted to super_user roles only_

## Read Audit Log

AuditLog must be enabled in the HarperDB configuration file to make this request. Returns a verbose history of all transactions logged for the specified database table, including original data records. You may filter your results with the optional search_type and search_values fields. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/transaction-logging#read_audit_log](https://docs.harperdb.io/docs/transaction-logging#read_audit_log).
AuditLog must be enabled in the HarperDB configuration file to make this request. Returns a verbose history of all transactions logged for the specified database table, including original data records. You may filter your results with the optional search_type and search_values fields. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/4.2/administration/logging/transaction-logging#read_audit_log](../../administration/logging/transaction-logging#read_audit_log).

_Operation is restricted to super_user roles only_

Expand Down Expand Up @@ -394,7 +394,7 @@ _Operation is restricted to super_user roles only_

## Read Audit Log by timestamp

AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table between the specified time window. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/transaction-logging#read_audit_log](https://docs.harperdb.io/docs/transaction-logging#read_audit_log).
AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table between the specified time window. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/4.2/administration/logging/transaction-logging#read_audit_log](../../administration/logging/transaction-logging#read_audit_log).

_Operation is restricted to super_user roles only_

Expand Down Expand Up @@ -515,7 +515,7 @@ _Operation is restricted to super_user roles only_

## Read Audit Log by username

AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table which were committed by the specified user. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/transaction-logging#read_audit_log](https://docs.harperdb.io/docs/transaction-logging#read_audit_log).
AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table which were committed by the specified user. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/4.2/administration/logging/transaction-logging#read_audit_log](../../administration/logging/transaction-logging#read_audit_log).

_Operation is restricted to super_user roles only_

Expand Down Expand Up @@ -635,7 +635,7 @@ _Operation is restricted to super_user roles only_

## Read Audit Log by hash_value

AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table which were committed to the specified hash value(s). Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/transaction-logging#read_audit_log](https://docs.harperdb.io/docs/transaction-logging#read_audit_log).
AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table which were committed to the specified hash value(s). Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/4.2/administration/logging/transaction-logging#read_audit_log](../../administration/logging/transaction-logging#read_audit_log).

_Operation is restricted to super_user roles only_

Expand Down
12 changes: 6 additions & 6 deletions versioned_docs/version-4.3/developers/operations-api/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: Logs

## Read HarperDB Log

Returns log outputs from the primary HarperDB log based on the provided search criteria. Read more about HarperDB logging here: [https://docs.harperdb.io/docs/logging#read-logs-via-the-api](https://docs.harperdb.io/docs/logging#read-logs-via-the-api).
Returns log outputs from the primary HarperDB log based on the provided search criteria. Read more about HarperDB logging here: [https://docs.harperdb.io/docs/4.3/administration/logging#read-logs-via-the-api](../../administration/logging#read-logs-via-the-api).

_Operation is restricted to super_user roles only_

Expand Down Expand Up @@ -64,7 +64,7 @@ _Operation is restricted to super_user roles only_

## Read Transaction Log

Returns all transactions logged for the specified database table. You may filter your results with the optional from, to, and limit fields. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/transaction-logging#read_transaction_log](https://docs.harperdb.io/docs/transaction-logging#read_transaction_log).
Returns all transactions logged for the specified database table. You may filter your results with the optional from, to, and limit fields. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/4.3/administration/logging/transaction-logging#read_transaction_log](../../administration/logging/transaction-logging#read_transaction_log).

_Operation is restricted to super_user roles only_

Expand Down Expand Up @@ -299,7 +299,7 @@ _Operation is restricted to super_user roles only_

## Read Audit Log

AuditLog must be enabled in the HarperDB configuration file to make this request. Returns a verbose history of all transactions logged for the specified database table, including original data records. You may filter your results with the optional search_type and search_values fields. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/transaction-logging#read_audit_log](https://docs.harperdb.io/docs/transaction-logging#read_audit_log).
AuditLog must be enabled in the HarperDB configuration file to make this request. Returns a verbose history of all transactions logged for the specified database table, including original data records. You may filter your results with the optional search_type and search_values fields. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/4.3/administration/logging/transaction-logging#read_audit_log](../../administration/logging/transaction-logging#read_audit_log).

_Operation is restricted to super_user roles only_

Expand Down Expand Up @@ -394,7 +394,7 @@ _Operation is restricted to super_user roles only_

## Read Audit Log by timestamp

AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table between the specified time window. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/transaction-logging#read_audit_log](https://docs.harperdb.io/docs/transaction-logging#read_audit_log).
AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table between the specified time window. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/4.3/administration/logging/transaction-logging#read_audit_log](../../administration/logging/transaction-logging#read_audit_log).

_Operation is restricted to super_user roles only_

Expand Down Expand Up @@ -515,7 +515,7 @@ _Operation is restricted to super_user roles only_

## Read Audit Log by username

AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table which were committed by the specified user. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/transaction-logging#read_audit_log](https://docs.harperdb.io/docs/transaction-logging#read_audit_log).
AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table which were committed by the specified user. Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/4.3/administration/logging/transaction-logging#read_audit_log](../../administration/logging/transaction-logging#read_audit_log).

_Operation is restricted to super_user roles only_

Expand Down Expand Up @@ -635,7 +635,7 @@ _Operation is restricted to super_user roles only_

## Read Audit Log by hash_value

AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table which were committed to the specified hash value(s). Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/transaction-logging#read_audit_log](https://docs.harperdb.io/docs/transaction-logging#read_audit_log).
AuditLog must be enabled in the HarperDB configuration file to make this request. Returns the transactions logged for the specified database table which were committed to the specified hash value(s). Read more about HarperDB transaction logs here: [https://docs.harperdb.io/docs/4.3/administration/logging/transaction-logging#read_audit_log](../../administration/logging/transaction-logging#read_audit_log).

_Operation is restricted to super_user roles only_

Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-4.5/getting-started/harper-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ As you begin your journey with Harper, there are a few concepts and definitions

## Components

Harper components are a core Harper concept defined as flexible JavaScript based extensions of the highly extensible core Harper platform. They are executed by Harper directly and have complete access to the Harper [Global APIs](https://docs.harperdb.io/technical-details/reference/globals) (such as Resource, databases, and tables).
Harper components are a core Harper concept defined as flexible JavaScript based extensions of the highly extensible core Harper platform. They are executed by Harper directly and have complete access to the Harper [Global APIs](../technical-details/reference/globals) (such as Resource, databases, and tables).

A key aspect to components are their extensibility; components can be built on other components. For example, a [Harper Application](https://docs.harperdb.io/developers/applications) is a component that uses many other components. The [application template](https://github.com/HarperDB/application-template) demonstrates many of Harper's built-in components such as [rest](https://docs.harperdb.io/developers/components/built-in#rest) (for automatic REST endpoint generation), [graphqlSchema](https://docs.harperdb.io/developers/components/built-in#graphqlschema) (for table schema definitions), and many more.
A key aspect to components are their extensibility; components can be built on other components. For example, a [Harper Application](../developers/applications) is a component that uses many other components. The [application template](https://github.com/HarperDB/application-template) demonstrates many of Harper's built-in components such as [rest](../developers/components/built-in#rest) (for automatic REST endpoint generation), [graphqlSchema](../developers/components/built-in#graphqlschema) (for table schema definitions), and many more.

## Applications

Applications are a subset of components that cannot be used directly and must depend on other extensions. Examples include defining schemas (using [graphqlSchema](https://docs.harperdb.io/developers/components/built-in#graphqlschema) built-in extension), defining custom resources (using [jsResource](https://docs.harperdb.io/developers/components/built-in#jsresource) built-in extension), hosting static files (using [static](https://docs.harperdb.io/developers/components/built-in#static) built-in extension), enabling REST querying of resources (using [rest](https://docs.harperdb.io/developers/components/built-in#rest) built-in extension), and running [Next.js](https://github.com/HarperDB/nextjs), [Astro](https://github.com/HarperDB/astro), or [Apollo](https://github.com/HarperDB/apollo) applications through their respective extensions.
Applications are a subset of components that cannot be used directly and must depend on other extensions. Examples include defining schemas (using [graphqlSchema](../developers/components/built-in#graphqlschema) built-in extension), defining custom resources (using [jsResource](../developers/components/built-in#jsresource) built-in extension), hosting static files (using [static](../developers/components/built-in#static) built-in extension), enabling REST querying of resources (using [rest](../developers/components/built-in#rest) built-in extension), and running [Next.js](https://github.com/HarperDB/nextjs), [Astro](https://github.com/HarperDB/astro), or [Apollo](https://github.com/HarperDB/apollo) applications through their respective extensions.

## Resources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -304,15 +304,15 @@ server.resources.getMatch('/NewResource/some-id', 'my-protocol');

### `server.operation(operation: Object, context?: Object, authorize?: boolean)`

Execute an operation from the [Operations API](https://docs.harperdb.io/developers/operations-api)
Execute an operation from the [Operations API](../../developers/operations-api)

Parameters:

- `operation` - `Object` - Object matching desired operation's request body
- `context` - `Object` - `{ username: string}` - _optional_ - The specified user
- `authorize` - `boolean` - _optional_ - Indicate the operation should authorize the user or not. Defaults to `false`

Returns a `Promise` with the operation's response as per the [Operations API documentation](https://docs.harperdb.io/developers/operations-api).
Returns a `Promise` with the operation's response as per the [Operations API documentation](../../developers/operations-api).

### `server.nodes`

Expand Down