The data-policy command of the HiveMQ command line offers a set of commands to work with data validation policies using a HiveMQ Data Hub API endpoint.
NOTE : The HiveMQ Data Hub is a new product in the HiveMQ platform and commands using it may be subject to breaking changes in the future.
Option Long Version Explanation -h--helpDisplay help message for command. -V--versionDisplay version information of the cli.
Create a new data policy and upload it to a HiveMQ node. The policy definition may be provided either directly from the command line or from a file.
mqtt hivemq data-policy create
mqtt hivemq data-policy create --file my-policy.json
Option Long Version Explanation Required --definitionThe definition of the data policy. This should be a JSON string containing a complete policy definition. Either --definition or --file, but not both --fileA path to a file containing the definition of the policy. Either --definition or --file, but not both
Option Long Version Explanation Default -u--urlThe URL of the HiveMQ REST API endpoint. http://localhost:8888-r--rateThe rate limit of the rest calls to the HiveMQ API endpoint in requests per second. 1500
Option Long Version Explanation Default -l Log to ~./mqtt-cli/logs (Configurable through ~/.mqtt-cli/config.properties). false
Option Long Version Explanation -h--helpDisplay help message for command. -V--versionDisplay version information of the cli.
Retrieve a single existing policy.
mqtt hivemq data-policy get
$ mqtt hivemq data-policy get --id my-policy-id
{
"createdAt": "2023-05-25T14:58:09.093Z",
"id": "my-policy-id",
"matching": {
"topicFilter": "topic/1"
},
"onFailure": {
"pipeline": []
},
"onSuccess": {
"pipeline": []
},
"validation": {
"validators": [
{
"arguments": {
"strategy": "ALL_OF",
"schemas": [
{
"schemaId": "my-schema"
}
]
},
"type": "schema"
}
]
}
}
Option Long Version Explanation Required -i--idThe id of the data policy to fetch. X -f--fieldSelect which JSON fields appear in the response. Can be specified multiple times.
Option Long Version Explanation Default -u--urlThe URL of the HiveMQ REST API endpoint. http://localhost:8888-r--rateThe rate limit of the rest calls to the HiveMQ API endpoint in requests per second. 1500
Option Long Version Explanation Default -l Log to ~./mqtt-cli/logs (Configurable through ~/.mqtt-cli/config.properties). false
Option Long Version Explanation -h--helpDisplay help message for command. -V--versionDisplay version information of the cli.
Update an existing data policy. The policy definition may be provided either directly from the command line or from a file. The provided policy id argument must match the id in the policy definition.
mqtt hivemq data-policy update
mqtt hivemq data-policy update --id my-policy-id --file my-policy.json
Option Long Version Explanation Required -i--idThe id of the data policy to be updated. X --definitionThe definition of the data policy. This should be a JSON string containing a complete policy definition. Either --definition or --file, but not both --fileA path to a file containing the definition of the data policy. Either --definition or --file, but not both
Option Long Version Explanation Default -u--urlThe URL of the HiveMQ REST API endpoint. http://localhost:8888-r--rateThe rate limit of the rest calls to the HiveMQ API endpoint in requests per second. 1500
Option Long Version Explanation Default -l Log to ~./mqtt-cli/logs (Configurable through ~/.mqtt-cli/config.properties). false
Option Long Version Explanation -h--helpDisplay help message for command. -V--versionDisplay version information of the cli.
List every data policy that exists on a HiveMQ node. This list may optionally be filtered by policy id, schema id, and MQTT topic.
mqtt hivemq data-policy list
$ mqtt hivemq data-policy list --topic topic/1
{
"items": [
{
"createdAt": "2023-05-25T14:59:03.303Z",
"id": "policy-1",
"matching": {
"topicFilter": "#"
},
"onFailure": {
"pipeline": []
},
"onSuccess": {
"pipeline": []
},
"validation": {
"validators": [
{
"arguments": {
"strategy": "ALL_OF",
"schemas": [
{
"schemaId": "schema-1"
}
]
},
"type": "schema"
}
]
}
},
{
"createdAt": "2023-05-25T15:18:09.093Z",
"id": "policy-2",
"matching": {
"topicFilter": "topic/1"
},
"onFailure": {
"pipeline": []
},
"onSuccess": {
"pipeline": []
},
"validation": {
"validators": [
{
"arguments": {
"strategy": "ALL_OF",
"schemas": [
{
"schemaId": "schema-2"
}
]
},
"type": "schema"
}
]
}
}
]
}
Option Long Version Explanation Required -i--idFilter by policies with a matching policy id. Can be specified multiple times. -s--schema-idFilter by policies that reference a schema with a matching schema id. Can be specified multiple times. -t--topicFilter by policies that apply to a certain MQTT topic. -f--fieldSelect which JSON fields appear in the response. Can be specified multiple times. --limitLimit the maximum number of policies returned.
Option Long Version Explanation Default -u--urlThe URL of the HiveMQ REST API endpoint. http://localhost:8888-r--rateThe rate limit of the rest calls to the HiveMQ API endpoint in requests per second. 1500
Option Long Version Explanation Default -l Log to ~./mqtt-cli/logs (Configurable through ~/.mqtt-cli/config.properties). false
Option Long Version Explanation -h--helpDisplay help message for command. -V--versionDisplay version information of the cli.
Delete a single existing data policy.
mqtt hivemq data-policy delete
mqtt hivemq data-policy delete --id my-policy-id
Option Long Version Explanation Required -i--idThe id of the policy to be deleted. X
Option Long Version Explanation Default -u--urlThe URL of the HiveMQ REST API endpoint. http://localhost:8888-r--rateThe rate limit of the rest calls to the HiveMQ API endpoint in requests per second. 1500
Option Long Version Explanation Default -l Log to ~./mqtt-cli/logs (Configurable through ~/.mqtt-cli/config.properties). false
Option Long Version Explanation -h--helpDisplay help message for command. -V--versionDisplay version information of the cli.