Components
Add Component
Creates a new component project in the component root directory using a predefined template.
Operation is restricted to super_user roles only
operation (required) - must always be
add_component
project (required) - the name of the project you wish to create
Body
Response: 200
Deploy Component
Will deploy a component using either a base64-encoded string representation of a .tar
file (the output from package_component
) or a package value, which can be any valid NPM reference, such as a GitHub repo, an NPM package, a tarball, a local directory or a website.\
If deploying with the payload
option, HarperDB will decrypt the base64-encoded string, reconstitute the .tar file of your project folder, and extract it to the component root project directory.\
or this can be shortened to:
You can also install from private repository if you have an installed SSH keys on the server:
Or you can use a Github token:
Or you can use a GitLab Project Access Token:
Note: After deploying a component a restart may be required
Operation is restricted to super_user roles only
operation (required) - must always be
deploy_component
project (required) - the name of the project you wish to deploy
package (optional) - this can be any valid GitHub or NPM reference
payload (optional) - a base64-encoded string representation of the .tar file. Must be a string
Body
Response: 200
Package Component
Creates a temporary .tar
file of the specified project folder, then reads it into a base64-encoded string and returns an object with the string and the payload.
Operation is restricted to super_user roles only
operation (required) - must always be
package_component
project (required) - the name of the project you wish to package
skip_node_modules (optional) - if true, creates option for tar module that will exclude the project's node_modules directory. Must be a boolean
Body
Response: 200
Drop Component
Deletes a file from inside the component project or deletes the complete project.
If just project
is provided it will delete all that projects local files and folders
Operation is restricted to super_user roles only
operation (required) - must always be
drop_component
project (required) - the name of the project you wish to delete or to delete from if using the
file
parameterfile (optional) - the path relative to your project folder of the file you wish to delete
Body
Response: 200
Get Components
Gets all local component files and folders and any component config from harperdb-config.yaml
Operation is restricted to super_user roles only
operation (required) - must always be
get_components
Body
Response: 200
Get Component File
Gets the contents of a file inside a component project.
Operation is restricted to super_user roles only
operation (required) - must always be
get_component_file
project (required) - the name of the project where the file is located
file (required) - the path relative to your project folder of the file you wish to view
encoding (optional) - the encoding that will be passed to the read file call. Defaults to
utf8
Body
Response: 200
Set Component File
Creates or updates a file inside a component project.
Operation is restricted to super_user roles only
operation (required) - must always be
set_component_file
project (required) - the name of the project the file is located in
file (required) - the path relative to your project folder of the file you wish to set
payload (required) - what will be written to the file
encoding (optional) - the encoding that will be passed to the write file call. Defaults to
utf8
Body
Response: 200
Last updated