{ "operations": [ { "name": "get", "params": [ "key" ], "docs": { "description": "Get the string value of a key.\nIf the key does not exist, null is returned.\nAn error is thrown if the value stored at key is not a string, because `get()` only handles string values.", "tags": [ { "title": "example", "description": "get(\"patient\");", "caption": "Get the value of the patient key" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": "The name of the key", "type": { "type": "NameExpression", "name": "string" }, "name": "key" }, { "title": "state", "description": "{RedisState}" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "hget", "params": [ "key", "field" ], "docs": { "description": "Get the value associated with a specific field in a hash stored at a specified key.", "tags": [ { "title": "example", "description": "hget(\"patient\", \"name\");", "caption": "Get the value of the name field under the patient key" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": "The name of the key", "type": { "type": "NameExpression", "name": "string" }, "name": "key" }, { "title": "param", "description": "Field", "type": { "type": "NameExpression", "name": "string" }, "name": "field" }, { "title": "state", "description": "{RedisState}" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "jGet", "params": [ "key" ], "docs": { "description": "Get the value at a specified path in a JSON document stored in a key", "tags": [ { "title": "example", "description": "jGet(\"patient\");", "caption": "Get JSON document value of the patient key" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": "The key at which the JSON document is stored.", "type": { "type": "NameExpression", "name": "string" }, "name": "key" }, { "title": "state", "description": "{RedisState}" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "mGet", "params": [ "keys" ], "docs": { "description": "Get the values at specified paths in JSON documents stored at multiple keys.", "tags": [ { "title": "example", "description": "mGet([\"patient\", \"doctor\"]);", "caption": "Get JSON document values of the patient and doctor keys" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": "The keys at which the JSON documents are stored.", "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "NameExpression", "name": "string" } ] }, "name": "keys" }, { "title": "state", "description": "{RedisState}" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "hGetAll", "params": [ "key" ], "docs": { "description": "Get all fields and values of a hash, as an object, for a specified key.", "tags": [ { "title": "example", "description": "hGetAll(\"noderedis:animals:1\");", "caption": "Get the hash obejct at the noderedis:animals:1 key" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": "The name of the key", "type": { "type": "NameExpression", "name": "string" }, "name": "key" }, { "title": "state", "description": "{RedisState}" }, { "title": "state", "description": "data - The hash as an object" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "set", "params": [ "key", "value" ], "docs": { "description": "Set the string value of a key.\nIf the key already exists, its value is updated. Otherwise, a new key-value pair is created.", "tags": [ { "title": "example", "description": "set(\"patient\", \"mtuchi\");", "caption": "Set the \"patient\" key to value \"mtuchi\"" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": "The name of the key", "type": { "type": "NameExpression", "name": "string" }, "name": "key" }, { "title": "param", "description": "The value to set", "type": { "type": "NameExpression", "name": "string" }, "name": "value" }, { "title": "state", "description": "references - an array of all previous data objects used in the Job" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "hset", "params": [ "key", "value" ], "docs": { "description": "Sets the specified fields to their respective values in the hash stored at key.\nThis function overwrites the values of specified fields that exist in the hash.\nIf key doesn't exist, a new key holding a hash is created.", "tags": [ { "title": "example", "description": "hset('patient', { name: 'mtuchi' });", "caption": "Set a field and value for the `patient` key" }, { "title": "example", "description": "hset('patient', { name: 'victor', ihs_number: 12345 });", "caption": "Set multiple field values for the `patient` key" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": "The name of the key", "type": { "type": "NameExpression", "name": "string" }, "name": "key" }, { "title": "param", "description": "The values to set", "type": { "type": "NameExpression", "name": "object" }, "name": "value" }, { "title": "state", "description": "references - an array of all previous data objects used in the Job" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "jSet", "params": [ "key", "value" ], "docs": { "description": "Creates a JSON object at the specified key. If the key already exists, the\nexisting value will be replaced by the new value.", "tags": [ { "title": "example", "description": "jSet('patient', { name: 'victor', ihs_number: 12345 });", "caption": "Set a JSON object for the key `patient`" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": "The key to modify.", "type": { "type": "NameExpression", "name": "string" }, "name": "key" }, { "title": "param", "description": "The JSON object or string value to set.", "type": { "type": "UnionType", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "object" } ] }, "name": "value" }, { "title": "state", "description": "references - an array of all previous data objects used in the Job" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "mSet", "params": [ "entries" ], "docs": { "description": "Set values at the root path ('$') in JSON documents stored at multiple keys.\nThis function allows setting multiple key-value pairs in Redis JSON documents in a single operation.\nIf a key already exists, its value will be replaced. If it does not exist, a new key-value pair will be created.", "tags": [ { "title": "example", "description": "mSet([{ key: 'patient', value: { name: 'victor', ihs_number: 12345 } },\n { key: 'doctor', value: { name: 'Alice', specialization: 'cardiology' } }]);", "caption": "Set multiple JSON objects" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": "An array of key-value pairs to set in the JSON store.", "type": { "type": "TypeApplication", "expression": { "type": "NameExpression", "name": "Array" }, "applications": [ { "type": "RecordType", "fields": [ { "type": "FieldType", "key": "key", "value": { "type": "NameExpression", "name": "string" } }, { "type": "FieldType", "key": "value", "value": { "type": "UnionType", "elements": [ { "type": "NameExpression", "name": "string" }, { "type": "NameExpression", "name": "object" } ] } } ] } ] }, "name": "entries" }, { "title": "state", "description": "references - an array of all previous data objects used in the Job" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "scan", "params": [ "pattern", "options" ], "docs": { "description": "Returns all keys which match the provided pattern.\nscan iterates the whole database to find the matching keys", "tags": [ { "title": "example", "description": "scan('*:20240524T172736Z*');", "caption": "Scan for matching keys" }, { "title": "example", "description": "scan('*:20240524T172736Z*');\neach($.data, get($.data).then((state) => {\n state.results ??= [];\n state.results.push(state.data)\n return state;\n})", "caption": "Scan for keys and fetch the string values inside" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": "A glob-style pattern", "type": { "type": "NameExpression", "name": "string" }, "name": "pattern" }, { "title": "param", "description": "Scan options", "type": { "type": "NameExpression", "name": "ScanOptions" }, "name": "options" }, { "title": "state", "description": "{RedisState}" }, { "title": "state", "description": "data - an array of keys which match the pattern" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true } ], "exports": [], "common": [ { "name": "fn", "params": [ "func" ], "docs": { "description": "Creates a custom step (or operation) for more flexible job writing.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "fn(state => {\n // do some things to state\n return state;\n});" }, { "title": "param", "description": "is the function", "type": { "type": "NameExpression", "name": "Function" }, "name": "func" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "fnIf", "params": [ "condition", "operation" ], "docs": { "description": "Execute a function only when the condition returns true", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "fnIf((state) => state?.data?.name, get(\"https://example.com\"));" }, { "title": "param", "description": "The condition that returns true", "type": { "type": "NameExpression", "name": "Boolean" }, "name": "condition" }, { "title": "param", "description": "The operation needed to be executed.", "type": { "type": "NameExpression", "name": "Operation" }, "name": "operation" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "sourceValue", "params": [ "path" ], "docs": { "description": "Picks out a single value from source data.\nIf a JSONPath returns more than one value for the reference, the first\nitem will be returned.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "sourceValue('$.key')" }, { "title": "param", "description": "JSONPath referencing a point in `state`.", "type": { "type": "NameExpression", "name": "String" }, "name": "path" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "dataPath", "params": [ "path" ], "docs": { "description": "Ensures a path points at the data.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "dataPath('key')" }, { "title": "param", "description": "JSONPath referencing a point in `data`.", "type": { "type": "NameExpression", "name": "string" }, "name": "path" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "string" } } ] }, "valid": true }, { "name": "dataValue", "params": [ "path" ], "docs": { "description": "Picks out a single value from the source data object—usually `state.data`.\nIf a JSONPath returns more than one value for the reference, the first\nitem will be returned.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "dataValue('key')" }, { "title": "param", "description": "JSONPath referencing a point in `data`.", "type": { "type": "NameExpression", "name": "String" }, "name": "path" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "lastReferenceValue", "params": [ "path" ], "docs": { "description": "Picks out the last reference value from source data.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "lastReferenceValue('key')" }, { "title": "param", "description": "JSONPath referencing a point in `references`.", "type": { "type": "NameExpression", "name": "String" }, "name": "path" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "each", "params": [ "dataSource", "operation" ], "docs": { "description": "Iterates over an array of items and invokes an operation upon each one, where the state\nobject is _scoped_ so that state.data is the item under iteration.\nThe rest of the state object is untouched and can be referenced as usual.\nYou can pass an array directly, or use lazy state or a JSONPath string to\nreference a slice of state.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "each(\n $.data,\n // Inside the callback operation, `$.data` is scoped to the item under iteration\n insert(\"patient\", {\n patient_name: $.data.properties.case_name,\n patient_id: $.data.case_id,\n })\n);", "caption": "Using lazy state ($) to iterate over items in state.data and pass each into an \"insert\" operation" }, { "title": "example", "description": "each(\n $.data,\n insert(\"patient\", (state) => ({\n patient_id: state.data.case_id,\n ...state.data\n }))\n);", "caption": "Iterate over items in state.data and pass each one into an \"insert\" operation" }, { "title": "example", "description": "each(\n \"$.data[*]\",\n insert(\"patient\", (state) => ({\n patient_name: state.data.properties.case_name,\n patient_id: state.data.case_id,\n }))\n);", "caption": "Using JSON path to iterate over items in state.data and pass each one into an \"insert\" operation" }, { "title": "param", "description": "JSONPath referencing a point in `state`.", "type": { "type": "NameExpression", "name": "DataSource" }, "name": "dataSource" }, { "title": "param", "description": "The operation needed to be repeated.", "type": { "type": "NameExpression", "name": "Operation" }, "name": "operation" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "field", "params": [ "key", "value" ], "docs": { "description": "Returns a key, value pair in an array.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "field('destination_field_name__c', 'value')" }, { "title": "param", "description": "Name of the field", "type": { "type": "NameExpression", "name": "string" }, "name": "key" }, { "title": "param", "description": "The value itself or a sourceable operation.", "type": { "type": "NameExpression", "name": "Value" }, "name": "value" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Field" } } ] }, "valid": true }, { "name": "fields", "params": [ "fields" ], "docs": { "description": "Zips key value pairs into an object.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "fields(list_of_fields)" }, { "title": "param", "description": "a list of fields", "type": { "type": "NameExpression", "name": "Fields" }, "name": "fields" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Object" } } ] }, "valid": true }, { "name": "merge", "params": [ "dataSource", "fields" ], "docs": { "description": "Merges fields into each item in an array.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "example", "description": "merge(\n \"$.books[*]\",\n fields(\n field( \"publisher\", sourceValue(\"$.publisher\") )\n )\n)" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": null, "type": { "type": "NameExpression", "name": "DataSource" }, "name": "dataSource" }, { "title": "param", "description": "Group of fields to merge in.", "type": { "type": "NameExpression", "name": "Object" }, "name": "fields" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "DataSource" } } ] }, "valid": true }, { "name": "cursor", "params": [ "value", "options" ], "docs": { "description": "Sets a cursor property on state.\nSupports natural language dates like `now`, `today`, `yesterday`, `n hours ago`, `n days ago`, and `start`,\nwhich will be converted relative to the environment (ie, the Lightning or CLI locale). Custom timezones\nare not yet supported.\nYou can provide a formatter to customise the final cursor value, which is useful for normalising\ndifferent inputs. The custom formatter runs after natural language date conversion.\nSee the usage guide at {@link https://docs.openfn.org/documentation/jobs/job-writing-guide#using-cursors}", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "cursor($.cursor, { defaultValue: 'today' })", "caption": "Use a cursor from state if present, or else use the default value" }, { "title": "example", "description": "cursor(22)", "caption": "Use a pagination cursor" }, { "title": "param", "description": "the cursor value. Usually an ISO date, natural language date, or page number", "type": { "type": "NameExpression", "name": "any" }, "name": "value" }, { "title": "param", "description": "options to control the cursor.", "type": { "type": "NameExpression", "name": "object" }, "name": "options" }, { "title": "param", "description": "set the cursor key. Will persist through the whole run.", "type": { "type": "NameExpression", "name": "string" }, "name": "options.key" }, { "title": "param", "description": "the value to use if value is falsy", "type": { "type": "NameExpression", "name": "any" }, "name": "options.defaultValue" }, { "title": "param", "description": "custom formatter for the final cursor value", "type": { "type": "NameExpression", "name": "Function" }, "name": "options.format" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": false } ] }