Skip to content

Commit c8249b8

Browse files
jcohen-hdbgitbook-bot
authored andcommitted
GITBOOK-14: No subject
1 parent 1139c85 commit c8249b8

File tree

7 files changed

+77
-38
lines changed

7 files changed

+77
-38
lines changed

docs/developers/miscellaneous/google-data-studio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Get started by selecting the Harper connector from the [Google Data Studio Partn
1717
3. Authorize the connector to access other servers on your behalf (this allows the connector to contact your database).
1818
4. Enter the Web URL to access your database (preferably with HTTPS), as well as the Basic Auth key you use to access the database. Just include the key, not the word “Basic” at the start of it.
1919
5. Check the box for “Secure Connections Only” if you want to always use HTTPS connections for this data source; entering a Web URL that starts with https:// will do the same thing, if you prefer.
20-
6. Check the box for “Allow Bad Certs” if your Harper instance does not have a valid SSL certificate. [Harper Cloud](deployments/harper-cloud/) always has valid certificates, and so will never require this to be checked. Instances you set up yourself may require this, if you are using self-signed certs. If you are using [Harper Cloud](deployments/harper-cloud/) or another instance you know should always have valid SSL certificates, do not check this box.
20+
6. Check the box for “Allow Bad Certs” if your Harper instance does not have a valid SSL certificate. [Harper Cloud](../../deployments/harper-cloud/) always has valid certificates, and so will never require this to be checked. Instances you set up yourself may require this, if you are using self-signed certs. If you are using [Harper Cloud](../../deployments/harper-cloud/) or another instance you know should always have valid SSL certificates, do not check this box.
2121
7. Choose your Query Type. This determines what information the configuration will ask for after pressing the Next button.
2222
* Table will ask you for a Schema and a Table to return all fields of using `SELECT *`.
2323
* SQL will ask you for the SQL query you’re using to retrieve fields from the database. You may `JOIN` multiple tables together, and use Harper specific SQL functions, along with the usual power SQL grants.

docs/developers/rest.md

Lines changed: 69 additions & 30 deletions
Large diffs are not rendered by default.

docs/developers/security/certificate-management.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document is information on managing certificates for Harper external facing
44

55
## Development
66

7-
An out of the box install of Harper does not have HTTPS enabled (see [configuration](../../developers/configuration.md) for relevant configuration file settings.) This is great for local development. If you are developing using a remote server and your requests are traversing the Internet, we recommend that you enable HTTPS.
7+
An out of the box install of Harper does not have HTTPS enabled (see [configuration](../../deployments/configuration.md#http) for relevant configuration file settings.) This is great for local development. If you are developing using a remote server and your requests are traversing the Internet, we recommend that you enable HTTPS.
88

99
To enable HTTPS, set `http.securePort` in `harperdb-config.yaml` to the port you wish to use for HTTPS connections and restart Harper.
1010

docs/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Now that you have a Harper instance, if you want to use Harper as a standalone d
4747
2. [Create a table](administration/harper-studio/manage-databases-browse-data.md#create-a-table)
4848
3. [Add a record](administration/harper-studio/manage-databases-browse-data.md#add-a-record)
4949
4. [Load CSV data](administration/harper-studio/manage-databases-browse-data.md#load-csv-data) (Here’s a sample CSV of the Harper team’s dogs)
50-
5. [Browse data](administration/harperdb-studio/manage-databases-browse-data.md#browse-table-data)
50+
5. [Browse data](administration/harper-studio/manage-databases-browse-data.md#browse-table-data)
5151

5252
## Administering Harper
5353

docs/technical-details/reference/resource.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ This provides a function for starting transactions. See the transactions section
101101

102102
### `contentTypes`
103103

104-
This provides an interface for defining new content type handlers. See the [content type extensions documentation](../../developers/components/writing-extensions.md) for more information.
104+
This provides an interface for defining new content type handlers. See the [content type extensions documentation](content-types.md) for more information.
105105

106106
### TypeScript Support
107107

docs/technical-details/release-notes/4.tucker/4.1.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ HarperDB 4.1 introduces the ability to use worker threads for concurrently handl
44

55
This means debugging will be much easier for custom functions. If you install/run HarperDB locally, most modern IDEs like WebStorm and VSCode support worker thread debugging, so you can start HarperDB in your IDE, and set breakpoints in your custom functions and debug them.
66

7-
The associated routing functionality now includes session affinity support. This can be used to consistently route users to the same thread which can improve caching locality, performance, and fairness. This can be enabled in with the [`http.sessionAffinity` option in your configuration](../../../../developers/security/configuration.md#session-affinity).
7+
The associated routing functionality now includes session affinity support. This can be used to consistently route users to the same thread which can improve caching locality, performance, and fairness. This can be enabled in with the [`http.sessionAffinity` option in your configuration](../../../deployments/configuration.md#http).
88

99
HarperDB 4.1's NoSQL query handling has been revamped to consistently use iterators, which provide an extremely memory efficient mechanism for directly streaming query results to the network _as_ the query results are computed. This results in faster Time to First Byte (TTFB) (only the first record/value in a query needs to be computed before data can start to be sent), and less memory usage during querying (the entire query result does not need to be stored in memory). These iterators are also available in query results for custom functions and can provide means for custom function code to iteratively access data from the database without loading entire results. This should be a completely transparent upgrade, all HTTP APIs function the same, with the one exception that custom functions need to be aware that they can't access query results by `[index]` (they should use array methods or for-in loops to handle query results).
1010

1111
4.1 includes configuration options for specifying the location of database storage files. This allows you to specifically locate database directories and files on different volumes for better flexibility and utilization of disks and storage volumes. See the [storage configuration](../../../../deployments/configuration.md#storage) and [schemas configuration](../../../../deployments/configuration.md#schemas) for information on how to configure these locations.
1212

13-
Logging has been revamped and condensed into one `hdb.log` file. See [logging](../../../../administration/logging.md) for more information.
13+
Logging has been revamped and condensed into one `hdb.log` file. See [logging](../../../administration/logging/) for more information.
1414

1515
A new operation called `cluster_network` was added, this operation will ping the cluster and return a list of enmeshed nodes.
1616

docs/technical-details/release-notes/4.tucker/4.2.0.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The [Resource API](../../reference/resource.md) is the new interface for accessi
1212

1313
### Component Architecture
1414

15-
HarperDB's custom functions have evolved towards a [full component architecture](../../../developers/components/); our internal functionality is defined as components, and this can be used in a modular way in conjunction with user components. These can all easily be configured and loaded through configuration files, and there is now a [well-defined interface for creating your own components](../../../developers/components/writing-extensions.md). Components can easily be deployed/installed into HarperDB using [NPM and Github references as well](../../../developers/components/installing.md).
15+
HarperDB's custom functions have evolved towards a [full component architecture](../../../developers/components/); our internal functionality is defined as components, and this can be used in a modular way in conjunction with user components. These can all easily be configured and loaded through configuration files, and there is now a [well-defined interface for creating your own components](broken-reference). Components can easily be deployed/installed into HarperDB using [NPM and Github references as well](broken-reference).
1616

1717
### Configurable Database Schemas
1818

@@ -46,7 +46,7 @@ Databases are now entirely encapsulated in a file, which means they can be moved
4646

4747
### Clone Node
4848

49-
HarperDB includes new functionality for adding new HarperDB nodes in a cluster. New instances can be configured to clone from a leader node, performing and copying a database snapshot from a leader node, and self-configuring from the leader node as well, to facilitate accelerated deployment of new nodes for fast horizontal scaling to meet demand needs. [See the documentation on Clone Node for more information.](../../../administration/administration/cloning.md)
49+
HarperDB includes new functionality for adding new HarperDB nodes in a cluster. New instances can be configured to clone from a leader node, performing and copying a database snapshot from a leader node, and self-configuring from the leader node as well, to facilitate accelerated deployment of new nodes for fast horizontal scaling to meet demand needs. [See the documentation on Clone Node for more information.](../../../administration/cloning.md)
5050

5151
### Operations API terminology updates
5252

0 commit comments

Comments
 (0)