{"id":19053786,"url":"https://github.com/siddhi-io/siddhi-execution-map","last_synced_at":"2025-07-02T17:05:37.527Z","repository":{"id":43711975,"uuid":"74111343","full_name":"siddhi-io/siddhi-execution-map","owner":"siddhi-io","description":"Extension that provides the capability to send a map object inside Siddhi stream definitions and use it within queries","archived":false,"fork":false,"pushed_at":"2022-02-22T10:02:14.000Z","size":1722,"stargazers_count":1,"open_issues_count":0,"forks_count":21,"subscribers_count":30,"default_branch":"master","last_synced_at":"2025-04-24T03:07:09.776Z","etag":null,"topics":["execution","extension","map","set","siddhi"],"latest_commit_sha":null,"homepage":"https://siddhi-io.github.io/siddhi-execution-map/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/siddhi-io.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-18T08:42:38.000Z","updated_at":"2022-02-22T06:19:17.000Z","dependencies_parsed_at":"2022-08-22T17:11:21.736Z","dependency_job_id":null,"html_url":"https://github.com/siddhi-io/siddhi-execution-map","commit_stats":null,"previous_names":["wso2-extensions/siddhi-execution-map"],"tags_count":30,"template":false,"template_full_name":null,"purl":"pkg:github/siddhi-io/siddhi-execution-map","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siddhi-io%2Fsiddhi-execution-map","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siddhi-io%2Fsiddhi-execution-map/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siddhi-io%2Fsiddhi-execution-map/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siddhi-io%2Fsiddhi-execution-map/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/siddhi-io","download_url":"https://codeload.github.com/siddhi-io/siddhi-execution-map/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siddhi-io%2Fsiddhi-execution-map/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263182165,"owners_count":23426630,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["execution","extension","map","set","siddhi"],"created_at":"2024-11-08T23:34:13.576Z","updated_at":"2025-07-02T17:05:37.480Z","avatar_url":"https://github.com/siddhi-io.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"Siddhi Execution Map\n======================================\n\n  [![Jenkins Build Status](https://wso2.org/jenkins/job/siddhi/job/siddhi-execution-map/badge/icon)](https://wso2.org/jenkins/job/siddhi/job/siddhi-execution-map/)\n  [![GitHub Release](https://img.shields.io/github/release/siddhi-io/siddhi-execution-map.svg)](https://github.com/siddhi-io/siddhi-execution-map/releases)\n  [![GitHub Release Date](https://img.shields.io/github/release-date/siddhi-io/siddhi-execution-map.svg)](https://github.com/siddhi-io/siddhi-execution-map/releases)\n  [![GitHub Open Issues](https://img.shields.io/github/issues-raw/siddhi-io/siddhi-execution-map.svg)](https://github.com/siddhi-io/siddhi-execution-map/issues)\n  [![GitHub Last Commit](https://img.shields.io/github/last-commit/siddhi-io/siddhi-execution-map.svg)](https://github.com/siddhi-io/siddhi-execution-map/commits/master)\n  [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\nThe **siddhi-execution-map extension** is a \u003ca target=\"_blank\" href=\"https://siddhi.io/\"\u003eSiddhi\u003c/a\u003e extension that provides capability to generate and manipulate map (key-value) data objects.\n\nFor information on \u003ca target=\"_blank\" href=\"https://siddhi.io/\"\u003eSiddhi\u003c/a\u003e and it's features refer \u003ca target=\"_blank\" href=\"https://siddhi.io/redirect/docs.html\"\u003eSiddhi Documentation\u003c/a\u003e. \n\n## Download\n\n* Versions 5.x and above with group id `io.siddhi.extension.*` from \u003ca target=\"_blank\" href=\"https://mvnrepository.com/artifact/io.siddhi.extension.execution.map/siddhi-execution-map/\"\u003ehere\u003c/a\u003e.\n* Versions 4.x and lower with group id `org.wso2.extension.siddhi.*` from \u003ca target=\"_blank\" href=\"https://mvnrepository.com/artifact/org.wso2.extension.siddhi.execution.map/siddhi-execution-map\"\u003ehere\u003c/a\u003e.\n\n## Latest API Docs \n\nLatest API Docs is \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7\"\u003e5.0.7\u003c/a\u003e.\n\n## Features\n\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#collect-aggregate-function\"\u003ecollect\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#aggregate-function\"\u003eAggregate Function\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eCollect multiple key-value pairs to construct a map. Only distinct keys are collected, if a duplicate key arrives, it overrides the old value\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#merge-aggregate-function\"\u003emerge\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#aggregate-function\"\u003eAggregate Function\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eCollect multiple maps to merge as a single map. Only distinct keys are collected, if a duplicate key arrives, it overrides the old value.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#clear-function\"\u003eclear\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the cleared map. \u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#clone-function\"\u003eclone\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the cloned map.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#combinebykey-function\"\u003ecombineByKey\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the map after combining all the maps given as parameters, such that the keys, of all the maps will be matched with an Array list of values from each map respectively.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#containskey-function\"\u003econtainsKey\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction checks if the map contains the key.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#containsvalue-function\"\u003econtainsValue\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction checks if the map contains the value.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#create-function\"\u003ecreate\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction creates a map pairing the keys and their corresponding values.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#createfromjson-function\"\u003ecreateFromJSON\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the map created by pairing the keys with their corresponding values given in the JSON string.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#createfromxml-function\"\u003ecreateFromXML\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the map created by pairing the keys with their corresponding values,given as an XML string.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#get-function\"\u003eget\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the value corresponding to the given key from the map.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#isempty-function\"\u003eisEmpty\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction checks if the map is empty.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#ismap-function\"\u003eisMap\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction checks if the object is type of a map.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#keys-function\"\u003ekeys\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction to return the keys of the map as a list.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#put-function\"\u003eput\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the updated map after adding the given key-value pair. If the key already exist in the map the key is updated with the new value.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#putall-function\"\u003eputAll\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the updated map after adding all the key-value pairs from another map. If there are duplicate keys, the key will be assigned new values from the map that's being copied.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#putifabsent-function\"\u003eputIfAbsent\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the updated map after adding the given key-value pair if key is absent. \u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#remove-function\"\u003eremove\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the updated map after removing the element with the specified key.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#replace-function\"\u003ereplace\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the updated map after replacing the given key-value pair only if key is present.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#replaceall-function\"\u003ereplaceAll\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the updated map after replacing all the key-value pairs from another map, if keys are present.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#size-function\"\u003esize\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction to return the size of the map.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#tojson-function\"\u003etoJSON\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction converts a map into a JSON object and returns the JSON as a string.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#toxml-function\"\u003etoXML\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction returns the map as an XML string.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#values-function\"\u003evalues\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#function\"\u003eFunction\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eFunction to return the values of the map.\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n* \u003ca target=\"_blank\" href=\"https://siddhi-io.github.io/siddhi-execution-map/api/5.0.7/#tokenize-stream-processor\"\u003etokenize\u003c/a\u003e *(\u003ca target=\"_blank\" href=\"http://siddhi.io/en/v5.1/docs/query-guide/#stream-processor\"\u003eStream Processor\u003c/a\u003e)*\u003cbr\u003e \u003cdiv style=\"padding-left: 1em;\"\u003e\u003cp\u003e\u003cp style=\"word-wrap: break-word;margin: 0;\"\u003eTokenize the map and return each key, value as new attributes in events\u003c/p\u003e\u003c/p\u003e\u003c/div\u003e\n\n## Dependencies \n\nThere are no other dependencies needed for this extension. \n\n## Installation\n\nFor installing this extension on various siddhi execution environments refer Siddhi documentation section on \u003ca target=\"_blank\" href=\"https://siddhi.io/redirect/add-extensions.html\"\u003eadding extensions\u003c/a\u003e.\n\n## Support and Contribution\n\n* We encourage users to ask questions and get support via \u003ca target=\"_blank\" href=\"https://stackoverflow.com/questions/tagged/siddhi\"\u003eStackOverflow\u003c/a\u003e, make sure to add the `siddhi` tag to the issue for better response.\n\n* If you find any issues related to the extension please report them on \u003ca target=\"_blank\" href=\"https://github.com/siddhi-io/siddhi-execution-map/issues\"\u003ethe issue tracker\u003c/a\u003e.\n\n* For production support and other contribution related information refer \u003ca target=\"_blank\" href=\"https://siddhi.io/community/\"\u003eSiddhi Community\u003c/a\u003e documentation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsiddhi-io%2Fsiddhi-execution-map","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsiddhi-io%2Fsiddhi-execution-map","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsiddhi-io%2Fsiddhi-execution-map/lists"}