Skip to main content

Engine Rules

Engine rules are used to route jobs to a specific engine. For more information on the types of rules that are supported, see the engine routing topic.

Engine Rule Object
{
    "ruleSet": {
        "ruleInfos": [
            {
                "name": "UI Previews",
                "condition": "query_type() = 'UI Preview'",
                "engineName": "preview",
                "action": "ROUTE",
                "rejectMessage": ""
            },
            {
                "name": "Reflections",
                "condition": "query_type() = 'Reflections'",
                "engineName": "default",
                "action": "ROUTE",
                "rejectMessage": ""
            }
        ],
        "ruleInfoDefault": {
            "name": "All Other Queries",
            "condition": "",
            "engineName": "default",
            "action": "ROUTE",
            "rejectMessage": ""
        },
        "tag": ""
    }
}

Engine Rule Attributes​

{{< api-section file="data/api/engine-rules.json" data="engineRuleAttributes" >}}

ruleInfoDefault​

{{< api-section file="data/api/engine-rules.json" data="ruleInfoDefault" >}}

ruleInfos​

{{< api-section file="data/api/engine-rules.json" data="ruleInfos" >}}

Individual Rule Object​

{{< api-section file="data/api/engine-rules.json" data="individualRuleObject" >}}

Listing All Rules​

Returns a list of all the rules in a project and the metadata for each rule.

Listing All Rules
GET /v0/projects/{project-id}/rules

Parameters​

{{< api-section file="data/api/engine-rules.json" data="listingAllRulesParameters" >}}

Example Request
curl -X GET 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/rules' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
{
    "ruleSet": {
        "ruleInfos": [
            {
                "name": "UI Previews",
                "condition": "query_type() = 'UI Preview'",
                "engineName": "preview",
                "action": "ROUTE",
                "rejectMessage": ""
            },
            {
                "name": "Reflections",
                "condition": "query_type() = 'Reflections'",
                "engineName": "firstEngine",
                "action": "ROUTE",
                "rejectMessage": ""
            },
            {
                "name": "test-rule",
                "condition": "query_type() IN ('UI Run')",
                "engineName": "test-engine",
                "action": "ROUTE",
                "rejectMessage": ""
            }
        ],
        "ruleInfoDefault": {
            "name": "All Other Queries",
            "condition": "",
            "engineName": "firstEngine",
            "action": "ROUTE",
            "rejectMessage": ""
        },
        "tag": "",
    }
}

Responses​

{{< api-responses file="data/api/engine-rules.json" data="listingAllRulesResponses" >}}

Adding a Rule​

Add a rule.

important:

When adding a rule, include the existing rules that you want to retain in the request, otherwise they will be deleted.

Adding a Rule
PUT /v0/projects/{project-id}/rules

Parameters​

{{< api-section file="data/api/engine-rules.json" data="addingRuleParameters" >}}

Example Request
curl -X PUT 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/rules' \
-H 'Authorization: Bearer <personal access token>' \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
    "ruleSet": {
        "ruleInfos": [
            {
                "name": "UI Previews",
                "condition": "query_type() = 'UI Preview'",
                "engineName": "preview",
                "action": "ROUTE",
                "rejectMessage": ""
            },
            {
                "name": "add-new-rule",
                "condition": "query_type() IN ('UI Run')",
                "engineName": "test-engine",
                "action": "ROUTE",
                "rejectMessage": ""
            }
        ],
        "ruleInfoDefault": {
            "name": "All Other Queries",
            "condition": "",
            "engineName": "default",
            "action": "ROUTE",
            "rejectMessage": ""
        },
        "tag": ""
    }
}
Example Response
{
    "ruleSet": {
        "ruleInfos": [
            {
                "name": "UI Previews",
                "condition": "query_type() = 'UI Preview'",
                "engineName": "preview",
                "action": "ROUTE",
                "rejectMessage": ""
            },
            {
                "name": "add-new-rule",
                "condition": "query_type() IN ('UI Run')",
                "engineName": "test-engine",
                "action": "ROUTE",
                "rejectMessage": "",
            }
        ],
        "ruleInfoDefault": {
            "name": "All Other Queries",
            "condition": "",
            "engineName": "default",
            "action": "ROUTE",
            "rejectMessage": ""
        },
        "tag": ""
    }
}'

Responses​

{{< api-responses file="data/api/engine-rules.json" data="addingRuleResponses" >}}

Modifying a Rule​

Modify a rule.

Modifying a Rule
PUT /v0/projects/{project-id}/rules

Parameters​

{{< api-section file="data/api/engine-rules.json" data="modifyingRuleParameters" >}}

Example Request
curl -X PUT 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/rules'\
-H 'Authorization: Bearer <personal access token>' \
-H "Content-Type:application/json" \
-H "Accept: application/json"
-d '{
    "ruleSet": {
        "ruleInfos": [
            {
                "name": "UI Previews",
                "condition": "query_type() = 'UI Preview'",
                "engineName": "preview",
                "action": "ROUTE",
                "rejectMessage": ""
            },
            {
                "name": "modify-a-rule",
                "condition": "query_type() IN ('UI Run', 'JDBC')",
                "engineName": "test-engine",
                "action": "ROUTE",
                "rejectMessage": ""
            }
        ],
        "ruleInfoDefault": {
            "name": "All Other Queries",
            "condition": "",
            "engineName": "default",
            "action": "ROUTE",
            "rejectMessage": ""
        },
        "tag": ""
    }
}'
Example Response
{
    "ruleSet": {
        "ruleInfos": [
            {
                "name": "UI Previews",
                "condition": "query_type() = 'UI Preview'",
                "engineName": "preview",
                "action": "ROUTE",
                "rejectMessage": ""
            },
            {
                "name": "modify-a-rule",
                "condition": "query_type() IN ('UI Run', 'JDBC')",
                "engineName": "test-engine",
                "action": "ROUTE",
                "rejectMessage": ""
            }
        ],
        "ruleInfoDefault": {
            "name": "All Other Queries",
            "condition": "",
            "engineName": "default",
            "action": "ROUTE",
            "rejectMessage": ""
        },
        "tag": ""
    }
}

Responses​

{{< api-responses file="data/api/engine-rules.json" data="modifyingRuleResponses" >}}

Deleting a Rule​

To delete a rule, you can use the PUT command to update the list of rules by omitting the rule that you want removed.

warning:

Since ruleInfoDefault is the default rule, it cannot be deleted.

Deleting a Rule
PUT /v0/projects/{project-id}/rules

Parameters​

{{< api-section file="data/api/engine-rules.json" data="deletingRuleParameters" >}}

Example Request
curl -X PUT 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/rules'\
-H 'Authorization: Bearer <personal access token>' \
-H "Content-Type:application/json" \
-H "Accept: application/json"
-d '{
    "ruleSet": {
        "ruleInfos": [
            {
                "name": "UI Previews",
                "condition": "query_type() = 'UI Preview'",
                "engineName": "preview",
                "action": "ROUTE",
                "rejectMessage": ""
            },
        ],
        "ruleInfoDefault": {
            "name": "All Other Queries",
            "condition": "",
            "engineName": "default",
            "action": "ROUTE",
            "rejectMessage": ""
        },
        "tag": ""
    }
}'
Example Response
{
    "ruleSet": {
        "ruleInfos": [
            {
                "name": "UI Previews",
                "condition": "query_type() = 'UI Preview'",
                "engineName": "preview",
                "action": "ROUTE",
                "rejectMessage": ""
            },
        ],
        "ruleInfoDefault": {
            "name": "All Other Queries",
            "condition": "",
            "engineName": "default",
            "action": "ROUTE",
            "rejectMessage": ""
        },
        "tag": ""
    }
}

Responses​

{{< api-responses file="data/api/engine-rules.json" data="deletingRuleResponses" >}}