diff --git a/docs/technical-details/reference/globals.md b/docs/technical-details/reference/globals.md index f0d57675..16863e21 100644 --- a/docs/technical-details/reference/globals.md +++ b/docs/technical-details/reference/globals.md @@ -304,7 +304,7 @@ 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: @@ -312,7 +312,7 @@ Parameters: - `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` diff --git a/release-notes/v4-tucker/4.3.0.md b/release-notes/v4-tucker/4.3.0.md index 83aeeca1..fdb0c7af 100644 --- a/release-notes/v4-tucker/4.3.0.md +++ b/release-notes/v4-tucker/4.3.0.md @@ -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). diff --git a/versioned_docs/version-4.1/install-harperdb/index.md b/versioned_docs/version-4.1/install-harperdb/index.md index 8ac8eb0c..8dfe4efc 100644 --- a/versioned_docs/version-4.1/install-harperdb/index.md +++ b/versioned_docs/version-4.1/install-harperdb/index.md @@ -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): -Download Install Package +[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: diff --git a/versioned_docs/version-4.2/developers/operations-api/logs.md b/versioned_docs/version-4.2/developers/operations-api/logs.md index d170b297..aaf0c893 100644 --- a/versioned_docs/version-4.2/developers/operations-api/logs.md +++ b/versioned_docs/version-4.2/developers/operations-api/logs.md @@ -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_ @@ -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_ @@ -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_ @@ -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_ @@ -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_ @@ -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_ diff --git a/versioned_docs/version-4.3/developers/operations-api/logs.md b/versioned_docs/version-4.3/developers/operations-api/logs.md index f8096408..56142466 100644 --- a/versioned_docs/version-4.3/developers/operations-api/logs.md +++ b/versioned_docs/version-4.3/developers/operations-api/logs.md @@ -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_ @@ -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_ @@ -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_ @@ -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_ @@ -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_ @@ -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_ diff --git a/versioned_docs/version-4.5/getting-started/harper-concepts.md b/versioned_docs/version-4.5/getting-started/harper-concepts.md index 4726fb85..bfa34f20 100644 --- a/versioned_docs/version-4.5/getting-started/harper-concepts.md +++ b/versioned_docs/version-4.5/getting-started/harper-concepts.md @@ -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 diff --git a/versioned_docs/version-4.6/technical-details/reference/globals.md b/versioned_docs/version-4.6/technical-details/reference/globals.md index ea7cede9..2de4859f 100644 --- a/versioned_docs/version-4.6/technical-details/reference/globals.md +++ b/versioned_docs/version-4.6/technical-details/reference/globals.md @@ -304,7 +304,7 @@ 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: @@ -312,7 +312,7 @@ Parameters: - `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`