Comment on page
Utilities
Restarts the HarperDB instance.
Operation is restricted to super_user roles only
- operation (required) - must always be
restart
{
"operation": "restart"
}
{
"message": "Restarting HarperDB. This may take up to 60 seconds."
}
Restarts servers for the specified HarperDB service.
Operation is restricted to super_user roles only
- operation (required) - must always be
restart_service
- service (required) - must be one of:
http_workers
,clustering_config
orclustering
{
"operation": "restart_service",
"service": "http_workers"
}
{
"message": "Restarting http_workers"
}
Returns detailed metrics on the host system.
Operation is restricted to super_user roles only
- operation (required) - must always be
system_information
- attributes (optional) - string array of top level attributes desired in the response, if no value is supplied all attributes will be returned. Available attributes are: ['system', 'time', 'cpu', 'memory', 'disk', 'network', 'harperdb_processes', 'table_size', 'replication']
{
"operation": "system_information"
}
Delete data before the specified timestamp on the specified database table exclusively on the node where it is executed. Any clustered nodes with replicated data will retain that data.
Operation is restricted to super_user roles only
- operation (required) - must always be
delete_records_before
- date (required) - records older than this date will be deleted. Supported format looks like:
YYYY-MM-DDThh:mm:ss.sZ
- schema (required) - name of the schema where you are deleting your data
- table (required) - name of the table where you are deleting your data
{
"operation": "delete_records_before",
"date": "2021-01-25T23:05:27.464",
"schema": "dev",
"table": "breed"
}
{
"message": "Starting job with id d3aed926-e9fe-4ec1-aea7-0fb4451bd373",
"job_id": "d3aed926-e9fe-4ec1-aea7-0fb4451bd373"
}
Exports data based on a given search operation to a local file in JSON or CSV format.
- operation (required) - must always be
export_local
- format (required) - the format you wish to export the data, options are
json
&csv
- path (required) - path local to the server to export the data
- search_operation (required) - search_operation of
search_by_hash
,search_by_value
orsql
{
"operation": "export_local",
"format": "json",
"path": "/data/",
"search_operation": {
"operation": "sql",
"sql": "SELECT * FROM dev.breed"
}
}
{
"message": "Starting job with id 6fc18eaa-3504-4374-815c-44840a12e7e5"
}
Exports data based on a given search operation from table to AWS S3 in JSON or CSV format.
- operation (required) - must always be
export_to_s3
- format (required) - the format you wish to export the data, options are
json
&csv
- s3 (required) - details your access keys, bucket, bucket region and key for saving the data to S3
- search_operation (required) - search_operation of
search_by_hash
,search_by_value
orsql
{
"operation": "export_to_s3",
"format": "json",
"s3": {
"aws_access_key_id": "YOUR_KEY",
"aws_secret_access_key": "YOUR_SECRET_KEY",
"bucket": "BUCKET_NAME",
"key": "OBJECT_NAME",
"region": "BUCKET_REGION"
},
"search_operation": {
"operation": "sql",
"sql": "SELECT * FROM dev.dog"
}
}
{
"message": "Starting job with id 9fa85968-4cb1-4008-976e-506c4b13fc4a",
"job_id": "9fa85968-4cb1-4008-976e-506c4b13fc4a"
}
Executes npm install against specified custom function projects.
Operation is restricted to super_user roles only
- operation (required) - must always be
install_node_modules
- projects (required) - must ba an array of custom functions projects.
- dry_run (optional) - refers to the npm --dry-run flag: https://docs.npmjs.com/cli/v8/commands/npm-install#dry-run. Defaults to false.
{
"operation": "install_node_modules",
"projects": [
"dogs",
"cats"
],
"dry_run": true
}
Modifies the HarperDB configuration file parameters. Must follow with a restart or restart_service operation.
Operation is restricted to super_user roles only
- operation (required) - must always be
set_configuration
- logging_level (example/optional) - one or more configuration keywords to be updated in the HarperDB configuration file
- clustering_enabled (example/optional) - one or more configuration keywords to be updated in the HarperDB configuration file
{
"operation": "set_configuration",
"logging_level": "trace",
"clustering_enabled": true
}
{
"message": "Configuration successfully set. You must restart HarperDB for new config settings to take effect."
}
Returns the HarperDB configuration parameters.
Operation is restricted to super_user roles only
- operation (required) - must always be
get_configuration
{
"operation": "get_configuration"
}
{
"http": {
"compressionThreshold": 1200,
"cors": false,
"corsAccessList": [
null
],
"keepAliveTimeout": 30000,
"port": 9926,
"securePort": null,
"timeout": 120000
},
"threads": 11,
"authentication": {
"cacheTTL": 30000,
"enableSessions": true,
"operationTokenTimeout": "1d",
"refreshTokenTimeout": "30d"
},
"analytics": {
"aggregatePeriod": 60
},
"clustering": {
"enabled": true,
"hubServer": {
"cluster": {
"name": "harperdb",
"network": {
"port": 12345,
"routes": null
}
},
"leafNodes": {
"network": {
"port": 9931
}
},
"network": {
"port": 9930
}
},
"leafServer": {
"network": {
"port": 9940,
"routes": null
},
"streams": {
"maxAge": null,
"maxBytes": null,
"maxMsgs": null,
"path": "/Users/hdb/clustering/leaf"
}
},
"logLevel": "info",
"nodeName": "node1",
"republishMessages": false,
"databaseLevel": false,
"tls": {
"certificate": "/Users/hdb/keys/certificate.pem",
"certificateAuthority": "/Users/hdb/keys/ca.pem",
"privateKey": "/Users/hdb/keys/privateKey.pem",
"insecure": true,
"verify": true
},
"user": "cluster_user"
},
"componentsRoot": "/Users/hdb/components",
"localStudio": {
"enabled": false
},
"logging": {
"auditAuthEvents": {
"logFailed": false,
"logSuccessful": false
},
"auditLog": true,
"auditRetention": "3d",
"file": true,
"level": "error",
"root": "/Users/hdb/log",
"rotation": {
"enabled": false,
"compress": false,
"interval": null,
"maxSize": null,
"path": "/Users/hdb/log"
},
"stdStreams": false
},
"mqtt": {
"network": {
"port": 1883,
"securePort": 8883
},
"webSocket": true,
"requireAuthentication": true
},
"operationsApi": {
"network": {
"cors": true,
"corsAccessList": [
"*"
],
"domainSocket": "/Users/hdb/operations-server",
"port": 9925,
"securePort": null
}
},
"rootPath": "/Users/hdb",
"storage": {
"writeAsync": false,
"caching": true,
"compression": false,
"noReadAhead": true,
"path": "/Users/hdb/database",
"prefetchWrites": true
},
"tls": {
"certificate": "/Users/hdb/keys/certificate.pem",
"certificateAuthority": "/Users/hdb/keys/ca.pem",
"privateKey": "/Users/hdb/keys/privateKey.pem"
}
}
Last modified 16d ago