Core 1830 Docs Migration: Custom Functions 1 of 2 by terraHDB · Pull Request #6 · HarperFast/documentation

terraHDB · 2022-10-19T03:46:03Z

This PR is 1 of 2 for Custom Functions and its subtopics.

Current state of CF docs: https://harperdb.io/docs/custom-functions/

* doc migration epic branch * 3/4 progress of security * finished configuration.md, began users and roles * users and roles migrated; still needs updates * updated user and roles operations * corrections to security docs * CORE-1825 Add/Update "install harpedb" subtopics (#1) * added mac, added/updated windows, added/updated node version requirements, and added offline docs * go requirements * docs adjustments * testing variable usage * testing variable usage * Update other.md Update installation for other operating systems. * added link to download * node version * exact replica download button * functional download link * deleted old link * node version Co-authored-by: Kris Zyp <kriszyp@gmail.com> * Core 1826 add/update harperdb studio topic and subtopics (#2) * added mac, added/updated windows, added/updated node version requirements, and added offline docs * 1/3 through studio subtopics * 2/3 through studio subtopics * 3/3 through studio subtopics * corrected harperdb operations api * removed icon descriptions and fixed typos * removed icon descriptions * primary key vs hash_attribute change * primary key vs hash attribute qualifier * minor change to example function Co-authored-by: Kris Zyp <kriszyp@gmail.com>

# Conflicts: # docs/harperdb-cloud/index.md # docs/harperdb-studio/index.md

kylebernhardy · 2022-11-28T17:16:31Z

+```
+
+
+3. **create a project folder in your Custom Functions root directory**


For this step do we also want to recommend having the user run the command npm init ?

kylebernhardy · 2022-11-28T17:22:23Z

+
+* To use your helpers, they must be exported from your helper file. Please use any standard export mechanisms available for your module system. We like ESM, ECMAScript Modules. Our example below exports using `module.exports`.
+
+* To include the helper in your route file, you must import. With ESM, you'd use a `require` statement.


Can we change this sentence:
To include the helper in your route file, you must import.

To something like:
You must import the helper module into your file that needs access to the exported functions.

Can we also link to the section in define-routes.md that shows where we are requiring the custom validator?

kylebernhardy · 2022-11-28T18:30:45Z

+
+* [**Instance URL**]:[**Custom Functions Port**]/[**Project Name**]/[**Route URL**]
+
+* The route below, within the **dogs** project, would be available at **http://localhost:9926/dogs**.


Depending on the name of the route file this URL may not be accurate. If the route file name is index.js I think the above URL would be correct. If it is say test.js the URL would be http://localhost:9926/dogs/test.js

kylebernhardy · 2022-11-28T18:33:51Z

+Before you get started with Custom Functions, here’s a primer on the basic configuration and the structure of a Custom Functions Project.
+
+## Configuration
+Custom Functions is enabled by default. If you wish to manage Custom Functions directly, you will find the relevant configuration parameters in your [configuration file](https://harperdb.io/docs/reference/configuration-file/). The available settings are listed below:


@DavidCockerill do you think we should add a section this showing an actual configuration section in YAML?

Yeah, I think so. No need to send them chasing links.

@terraHDB let's add a section with example of the custom functions YAML section

kylebernhardy · 2022-11-28T18:35:44Z

 ---
 ## How does Studio Work?
-While HarperDB Studio is web based and hosted by us, all database interactions are performed locally. The HarperDB Studio loads in your browser, at which point you login to your HarperDB instances. Credentials are stored in your browser cache and are not transmitted back to HarperDB. All database interactions are made via the HarperDB REST API directly from your browser to your instance.
+While HarperDB Studio is web based and hosted by us, all database interactions are performed locally. The HarperDB Studio loads in your browser, at which point you login to your HarperDB instances. Credentials are stored in your browser cache and are not transmitted back to HarperDB. All database interactions are made via the HarperDB Operations API directly from your browser to your instance.


Can we change:
all database interactions are performed locally.

to
all database interactions are performed on the HarperDB instance the studio is connected to.

kylebernhardy · 2022-11-29T17:37:45Z

+
+
+
+**Built-In Roles**


In 3.3.0 we added a new role type called structure_user. When defining this role type you can either assign a value of true which will allow the role to create and drop schemas & tables. Alternatively the role type can be assigned a string array. The values in this array are schemas and allows the role to only create and drop tables in the designated schemas.

✔️ please let me know if that role's description is accurate

kylebernhardy · 2022-11-30T17:50:18Z


  * This role is an internally managed role to facilitate communication between clustered instances.

+* `structure_user` - This role provides specific access for creation and deletion of data.


This role provides specific access for creation and deletion of schemas and tables.

kylebernhardy

Looks great!

terraHDB added 18 commits October 5, 2022 09:33

testing variable syntax

9ba2ab8

testing variable syntax

143bf62

testing variable syntax

3c119d9

testing variable syntax

2aec8f9

testing variable syntax

1f3b4f0

testing variable syntax

d2603a7

testing variable syntax

81f4d2a

testing variable syntax

79d2562

testing variable syntax

9cc4e3f

testing variable syntax

018a088

testing variable syntax

3375c62

testing variable syntax

8abcd22

testing variable syntax

7abd436

testing variable syntax

1415f76

testing variable syntax

d2dd1fe

testing variable syntax

3f7618e

reverted changes from variable testing

501405b

docs migration: 1 of 2 custom functions

414c698

terraHDB requested review from DavidCockerill, kriszyp and kylebernhardy October 19, 2022 03:46

DavidCockerill reviewed Oct 19, 2022

View reviewed changes

Comment thread docs/custom-functions/define-routes.md

Comment thread docs/custom-functions/requirements-definitions.md Outdated

kriszyp reviewed Oct 20, 2022

View reviewed changes

corrections to 1/2 custom functions docs

f2be4fe

kriszyp reviewed Oct 25, 2022

View reviewed changes

Comment thread docs/custom-functions/define-helpers.md Outdated

terraHDB added 5 commits October 25, 2022 15:52

corrections to cf doc migration

dab4f6e

updated request and prevalidation helpers in accordance to pr comments

5252844

addressed comments on cf docs

b05d4fa

cleaned up function with fetch

de14187

Merge branch 'CORE-1824' into CORE-1830

cb72fd3

reverted changes to function

b40c804

terraHDB requested review from DavidCockerill and kriszyp November 15, 2022 18:05

terraHDB and others added 4 commits November 15, 2022 15:20

Merge branch 'main' into CORE-1824

b92bfe9

# Conflicts: # docs/harperdb-cloud/index.md # docs/harperdb-studio/index.md

Merge branch 'CORE-1824' into CORE-1830

6ffc03c

cleaned up helper function with fetch and fixed typo in define-routes.md

ea02094

DavidCockerill reviewed Nov 16, 2022

View reviewed changes

Comment thread docs/custom-functions/requirements-definitions.md Outdated

DavidCockerill approved these changes Nov 16, 2022

View reviewed changes

terraHDB added 2 commits November 16, 2022 13:36

removed reference to cf.root

c499dcf

re-added root, removed reference to processes

b46828f

kylebernhardy reviewed Nov 28, 2022

View reviewed changes

Comment thread docs/security/basic-auth.md

kriszyp approved these changes Nov 28, 2022

View reviewed changes

terraHDB added 3 commits November 28, 2022 14:30

adding instruction to npm init

d3c1245

link to custom val import

5033214

btoa link and other adjustments from pr comments

ce5646b

kylebernhardy reviewed Nov 29, 2022

View reviewed changes

terraHDB added 4 commits November 29, 2022 11:58

Merge remote-tracking branch 'origin/CORE-1824' into CORE-1824

7303649

Merge branch 'CORE-1824' into CORE-1830

6052412

included yaml config snippet for cf

d9f562b

added structure user role

a98829a

kylebernhardy reviewed Nov 30, 2022

View reviewed changes

kylebernhardy approved these changes Nov 30, 2022

View reviewed changes

kylebernhardy merged commit 0ca0976 into CORE-1824 Nov 30, 2022

dawsontoth deleted the CORE-1830 branch July 17, 2025 18:53

		```


		3. create a project folder in your Custom Functions root directory


		* To use your helpers, they must be exported from your helper file. Please use any standard export mechanisms available for your module system. We like ESM, ECMAScript Modules. Our example below exports using `module.exports`.

		* To include the helper in your route file, you must import. With ESM, you'd use a `require` statement.


		* [Instance URL]:[Custom Functions Port]/[Project Name]/[Route URL]

		* The route below, within the dogs project, would be available at http://localhost:9926/dogs.


		* This role is an internally managed role to facilitate communication between clustered instances.

		* `structure_user` - This role provides specific access for creation and deletion of data.




		Built-In Roles

Uh oh!

Conversation

terraHDB commented Oct 19, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kylebernhardy Nov 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kylebernhardy left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

kylebernhardy Nov 28, 2022 •

edited

Loading