Skip to main content

Conditions

You can use the Condition input field to build complex conditions in your triggers and actions.

Custom Condition Schema​

This document explains how to structure a JSON‐based custom condition schema that your “Condition” component can use to generate query strings for different platforms (for example, MySQL and Shopify Search Syntax).

1. Purpose of the custom condition schema​

• The schema tells your component how to translate a user’s inputs (field, operator, value, and logical connector) into the appropriate query string.
• Each top‐level entry in this schema corresponds to one platform or language.

2. Example Schema Outline​

An example JSON file might look like:

{
    "name": "MySQL",
    "operators": {
        "equals": "=",
        "not_equals": "<>",
        "less_than": "<",
        "less_than_or_equal": "<=",
        "greater_than": ">",
        "greater_than_or_equal": ">=",
        "contains": "LIKE",
        "not_contains": "NOT LIKE",
        "starts_with": "LIKE",
        "ends_with": "LIKE"
    },
    "logicalOperators": {
        "AND": "AND",
        "OR": "OR"
    },
    "valueWrapper": "'{{value}}'",
    "wildcardSymbol": "%",
    "multiConditionFormat": "({{conditions}})",
    "singleConditionFormat": "{{field}} {{operator}} {{value}}",
    "esacapeKeys": false,
    "escapeValues": false,
    "escapeStart": "",
    "escapeEnd": "",
}

2.1 "name" Field​

• A human‐readable name for the platform (e.g., "MySQL" or "Shopify Search Syntax").
• Generally used for display labels in a UI or for logging.

2.2 "operators" Object​

• Maps a set of operator keys (e.g., "equals", "less_than") to how they should be expressed in the target platform.
• For MySQL, "contains" maps to "LIKE".
• For Shopify Search, "equals" maps to {{field}}:{{value}}.
• Four placeholders are commonly used in these expressions:

  • {{field}}
  • {{operator}}
  • {{value}}
  • {{conditions}}

2.3 "logicalOperators" Object​

• Defines how logical conjunctions (e.g., "AND", "OR") should be spelled.
• Typically "AND" and "OR" are consistent across many SQL‐like languages, but this can differ for other platforms.

2.4 "valueWrapper" (MySQL example)​

• Determines how values are wrapped or escaped for that platform.
• Here, "'{{value}}'" indicates that incoming values should be enclosed in single quotes.
• For “LIKE” queries, you may insert additional characters, such as wildcard symbols to handle partial text searches.

2.5 "wildcardSymbol" (MySQL example)​

• If your platform uses wildcards for partial matches, specify them (e.g., “%” for MySQL).

2.6 "multiConditionFormat"​

• Defines how to compose multiple sub‐conditions into one grouped expression.
• For MySQL, ({{conditions}}) means every sub‐condition is wrapped in parentheses.

2.7 "singleConditionFormat"​

• Defines how a single condition is composed.
• For MySQL, {{field}} {{operator}} {{value}} might become title LIKE 'myValue'.
• For Shopify, it might become title:myValue.

3. Adding More Platforms​

You can add new platforms exactly like the above keys, e.g.,

{
    "name": "Postgres",
    "operators": {
        "...": "..."
    },
    "logicalOperators": {
        "...": "..."
    },
    "multiConditionFormat": "...",
    "singleConditionFormat": "..."
}