{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The Distributed Storage Profile enables you to access a distributed storage solution from APL without having to provide details about its type or implementation.","type":"text"}]},{"type":"paragraph","content":[{"text":"The APL functions described in this section use a key-value model to read, store and remove data via the specified profile. The functions can optionally use sessions that are either committed or rolled back in order to secure transaction consistency.","type":"text"}]},{"type":"paragraph","content":[{"text":"The following functions for Distributed Storage described here are:","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"maxLevel":{"value":"2"},"minLevel":{"value":"2"}},"macroMetadata":{"macroId":{"value":"c50a7b19-5c43-4aab-95b4-d85672de58be"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"081aeabc-58ef-4cef-84e6-e6311bc13129"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Initializing Storage","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsInitStorage","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsInitStorage","type":"text","marks":[{"type":"code"}]},{"text":" function returns a Distributed Storage Profile object that is used in subsequent APL calls to distributed storage functions.","type":"text"}]},{"type":"codeBlock","content":[{"text":"any dsInitStorage(string profid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"656ebe41-65e7-41ff-86ef-770271a3966e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A string containing a reference to a Distributed Storage Profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A Distributed Storage Profile object.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsInitStorage","type":"text"}]},{"type":"paragraph","content":[{"text":"any storage=null;","type":"text","marks":[{"type":"code"}]}]},{"type":"paragraph","content":[{"text":"initialize {","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" storage = dsInitStorage(\"default.ds_profile\"); ","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" if(null != dsLastErrorMessage()) {","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" //Error Handling","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":" }","type":"text","marks":[{"type":"code"}]},{"type":"hardBreak"},{"text":"}","type":"text","marks":[{"type":"code"}]}]}]},{"type":"paragraph"},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note!","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsInitStorage ","type":"text","marks":[{"type":"code"}]},{"text":"function must be used in the initialize block and not consume block.","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Storing and Removing Data","type":"text"}]},{"type":"paragraph","content":[{"text":"The following functions enable you to perform changes on data in a distributed storage:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsStore","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsStoreUdr","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsStoreMany","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsStoreManyUdrs","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsRemove","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsRemoveMany","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsStore","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsStore","type":"text","marks":[{"type":"code"}]},{"text":" function stores a key-value pair in a distributed storage.","type":"text"}]},{"type":"codeBlock","content":[{"text":"void dsStore(\n any profid, \n string key, \n bytearray value, \n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e114d5ae-d238-4188-8b3a-f3270d422cec"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The key of a key-value pair.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"value","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The value of a key-value pair.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction. Use a null value to store data in non-transaction mode. If the identifier is set the transaction is completed by calling dsCommitTransaction.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Nothing.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsStore","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\n \ninitialize {\n storage = dsInitStorage(\"default.ds_profile\");\n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}\n \nconsume { \n bytearray myValue = null;\n strToBA(myValue, \"123\");\n dsStore(storage, \"mykey\", myValue, null); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n } \n}","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsStoreUdr","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsStoreUdr","type":"text","marks":[{"type":"code"}]},{"text":" function stores a key-value pair in a distributed storage.","type":"text"}]},{"type":"codeBlock","content":[{"text":"void dsStoreUdr(\n any profid, \n string key, \n drudr myUDR, \n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b57a89ae-03ae-4deb-9bd0-9c8a03f749a6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The key of a key-value pair.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"myUDR","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The UDR to be stored.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction. Use a null value to store data in non-transaction mode. If the identifier is set the transaction is completed by calling dsCommitTransaction.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Nothing.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsStoreUDR","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\n \ninitialize {\n storage = dsInitStorage(\"default.ds_profile\");\n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}\n \nconsume { \n default.dataUDR udr = udrCreate(default.myultra.dataUDR); \n dsStoreUdr(storage, \"mykey\", udr, null); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsStoreMany","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsStoreMany","type":"text","marks":[{"type":"code"}]},{"text":" function stores a set of key-value pairs in a distributed storage.","type":"text"}]},{"type":"codeBlock","content":[{"text":"void dsStoreMany(\n any profid, \n map values, \n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"9f66318c-4333-47ea-9e4a-fb9b1e0580e6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"values","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The key-value pairs to store.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction. Use a null value to store data in non-transaction mode. If the identifier is set the transaction is completed by calling dsCommitTransaction.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Nothing.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsStoreMany","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\n \ninitialize {\n storage = dsInitStorage(\"default.ds_profile\");\n if(null != dsLastErrorMessage()) {\n //Error Handling\n } \n}\n \nconsume {\n map myValues = \n mapCreate(string, bytearray);\n bytearray value1; \n bytearray value2;\n strToBA(value1, \"abc\");\n mapSet(myValues,\"first\", value1);\n strToBA(value2, \"def\"); \n mapSet(myValues,\"second\", value2); \n dsStoreMany(storage, myValues, null);\n if(null != dsLastErrorMessage()) {\n //Error Handling\n } \n}","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsStoreManyUdrs","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsStoreManyUdrs","type":"text","marks":[{"type":"code"}]},{"text":" function stores a set of key-value pairs in a distributed storage.","type":"text"}]},{"type":"codeBlock","content":[{"text":"void dsStoreManyUdrs(\n any profid, \n map myUDRs, \n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"0d24182f-7a61-4d5d-b935-62792e212de6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"myUDRs","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The key-value pairs to store.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction. Use a null value to store data in non-transaction mode. If the identifier is set the transaction is completed by calling dsCommitTransaction.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Nothing.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsStoreManyUDRs","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\n \ninitialize {\n storage = dsInitStorage(\"default.ds_profile\");\n if(null != dsLastErrorMessage()) {\n //Error Handling\n } \n}\n \nconsume { \n map myUDRs = mapCreate(string, drudr);\n default.dataUDR udr1 = udrCreate(default.myultra.dataUDR); \n mapSet(myUDRs,\"first\", udr1);\n default.dataUDR udr2 = udrCreate(default.myultra.dataUDR); \n mapSet(myUDRs,\"second\", udr2); \n dsStoreManyUdrs(storage, myUDRs, null); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n } \n}","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsCommand","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note!","type":"text"}]},{"type":"paragraph","content":[{"text":"This function is only valid for Couchbase.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The ","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"48d00348-5cd1-4827-ad49-553f5a900d65"}}]},{"text":"dsCommand","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"48d00348-5cd1-4827-ad49-553f5a900d65"}},{"type":"code"}]},{"text":" function stores data with a Time To Live (TTL) on the entry by updating the ‘expiration’ field for data in Couchbase, meaning it will be removed when it gets too old.","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"48d00348-5cd1-4827-ad49-553f5a900d65"}}]}]},{"type":"codeBlock","content":[{"text":"void dsCommand(\n any profid, \n string \"ttlStore\"\n string key, \n int ttl,\n drudr myUDR)","type":"text"}]},{"type":"paragraph","content":[{"text":"You can also use the ","type":"text"},{"text":"dsCommand","type":"text","marks":[{"type":"code"}]},{"text":" to extend the expiration field of the data in ","type":"text"},{"text":"Couchbase using the “touch” action","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"61221757-fc3b-4aaf-864e-c8ebf56ba8db"}}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"void dsCommand(\n any profid, \n string \"touch\"\n string key, \n int ttl)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"9b376470-c053-45a6-85b5-3c6030e277b8"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"action","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The action you want to perform, “ttlStore” for storing UDRs with TTL or “touch“ to extend the TTL.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The key of a key-value pair.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"ttl","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Time To Live in seconds.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"myUDR","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The UDR to be stored.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Nothing","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"2a74f4db-9782-4a35-8eec-0e96325272af"}}]},{"text":".","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"81544570-6894-4d6d-a728-a30df5d3ff11"}}]}]}]}]}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"rw-ui-textbox-macro","parameters":{"macroParams":{"type":{"value":"info"}},"macroMetadata":{"macroId":{"value":"8a3be2bf52f0164e81019596cddfb117"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://static.dg.refinedtheme.refinedwiki.com/refinedtheme-for-cloud/macro-icons/panel.png"}}],"title":"Refined Panel"}},"localId":"9ffdaabf-0e99-4d40-81e1-84a494143c00"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsCommand","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","content":[{"text":"int ttl = 50;\nany result = dsCommand(storage, \"ttlStore\", \"3333\", ttl,input);\ndebug(result);\nsleep(10000);\nresult = dsCommand(storage, \"touch\", \"3333\", ttl);","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsRemove","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsRemove","type":"text","marks":[{"type":"code"}]},{"text":" function removes a key-value pair, identified by a key, from a distributed storage.","type":"text"}]},{"type":"codeBlock","content":[{"text":"void dsRemove(\n any profid, \n string key, \n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b5befa0e-e5a0-4445-afa5-3041e3138096"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The key of the key-value pair to remove.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction. Use a null value to remove data in non-transaction mode. If the identifier is set the transaction is completed by calling dsCommitTransaction.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Nothing.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsRemove","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\ninitialize {\n storage = dsInitStorage(\"default.ds_profile\");\n if(null != dsLastErrorMessage()) {\n //Error Handling\n } \n}\n \nconsume {\n //It is assumed here that \"mykey\" is already stored.\n dsRemove(storage, \"mykey\", null); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsRemoveMany","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsRemoveMany","type":"text","marks":[{"type":"code"}]},{"text":" function removes a list of key-value pairs, identified by a list of keys, from a distributed storage.","type":"text"}]},{"type":"codeBlock","content":[{"text":"void dsRemoveMany(\n any profid, \n list keys,\n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"b63bca64-c58a-4cd4-9612-b2b5dc6b43d6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"keys","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The keys of the key-value pairs to remove.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction. Use a null value to remove data in non-transaction mode. If the identifier is set the transaction is completed by calling dsCommitTransaction.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Nothing.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsRemoveMany","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\n \ninitialize {\n storage = dsInitStorage(\"default.ds_profile\");\n if(null != dsLastErrorMessage()) {\n //Error Handling\n } \n}\n \nconsume {\n list myKeys = listCreate(string);\n int i = 0;\n // It is assumed here that \"KEY0\", \"KEY1\"..\"KEY9\" \n // are already stored. \n while (i < 10) {\n listAdd(myKeys, \"KEY\" + (i));\n i = i + 1;\n }\n dsRemoveMany(storage, myKeys, null);\n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Reading Data","type":"text"}]},{"type":"paragraph","content":[{"text":"The following functions enable you to read data from a distributed storage.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsRead","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsReadUdr","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsReadMany","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsReadManyUdrs","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsRead","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsRead","type":"text","marks":[{"type":"code"}]},{"text":" function reads a value, identified by a key, from a distributed storage.","type":"text"}]},{"type":"codeBlock","content":[{"text":"bytearray dsRead(\n any profid, \n string key, \n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"efcbcbbe-d602-44d9-a878-fd3acf1fd217"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The key of a key-value pair.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction. Use a null value to read data in non-transaction mode. If the identifier is set, the read key-value pair is locked for other transactions untildsCommitTransaction or dsRollbackTransaction is called.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A bytearray containing the value of a key-value pair.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsRead","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\ninitialize {\n storage = dsInitStorage(\"default.ds_profile\"); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}\nconsume { \n //It is assumed here that \"mykey\" is already stored.\n bytearray myValue = dsRead(storage, \"mykey\", null); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsReadUdr","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsReadUdr","type":"text","marks":[{"type":"code"}]},{"text":" function reads a set of UDRs, identified by a list of keys, from a distributed storage.","type":"text"}]},{"type":"codeBlock","content":[{"text":"drudr dsReadUdr(\n any profid, \n string key, \n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"82cc26b8-7a36-44b7-a149-04a2ce9d696e"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"key","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The key of a key-value pair.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction. Use a null value to read data in non-transaction mode. If the identifier is set, the read key-value pair is locked for other transactions untildsCommitTransaction or dsRollbackTransaction is called.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A UDR identified by the key parameter.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsReadUDR","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\n \ninitialize {\n storage = dsInitStorage(\"default.ds_profile\"); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}\n \nconsume {\n //It is assumed here that \"mykey\" is already stored.\n default.myultra.dataUDR udr = \n (default.myultra.dataUDR) dsReadUdr(storage, \"mykey\", \n null); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsReadMany","type":"text"}]},{"type":"paragraph","content":[{"text":"The dsReadMany function reads a set of key-value pairs, identified by a list of keys, from a distributed storage.","type":"text"}]},{"type":"codeBlock","content":[{"text":"map dsReadMany(\n any profid, \n list keys,\n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"58184686-35c9-4e85-b201-0bf7f9367c68"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"keys","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The keys of the key-value pairs to be read.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction. Use a null value to read data in non-transaction mode. If the identifier is set, the read key-value pairs are locked for other transactions untildsCommitTransaction or dsRollbackTransaction is called.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A map containing the key-value pairs.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsReadMany","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\n \ninitialize {\n storage = dsInitStorage(\"default.ds_profile\"); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}\n \nconsume {\n list myKeys = listCreate(string);\n int i = 0;\n // It is assumed here that \"KEY0\", \"KEY1\"..\"KEY9\" \n // are already stored.\n while (i < 10) {\n listAdd(myKeys, \"KEY\" + (i));\n i = i + 1;\n }\n map myMap = mapCreate(string, bytearray);\n myMap = dsReadMany(storage, myKeys, null); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsReadManyUdrs","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsReadManyUdrs","type":"text","marks":[{"type":"code"}]},{"text":" function reads a key-value map, identified by a key, from a distributed storage.","type":"text"}]},{"type":"codeBlock","content":[{"text":"map dsReadManyUdrs(\n any profid, \n list< string keys, \n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"ffd7e103-263e-4a6f-95ce-f7e2f7799d14"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"keys","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The keys of the key-value pairs to be read.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction. Use a null value to read data in non-transaction mode. If the identifier is set, the read key-value pairs are locked for other transactions untildsCommitTransaction or dsRollbackTransaction is called.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A map containing the key-value pairs.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsReadManyUDRS","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\n \ninitialize {\n storage = dsInitStorage(\"default.ds_profile\"); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}\n \nconsume {\n list myKeys = listCreate(string);\n int i = 0;\n // It is assumed here that \"KEY0\", \"KEY1\"..\"KEY9\" \n // are already stored.\n \n while (i < 10) {\n listAdd(myKeys, \"KEY\" + (i));\n i = i + 1;\n }\n map myUdrMap = \n mapCreate(string, default.myultra.dataUDR);\n myUdrMap = dsReadManyUdrs(storage, myKeys, null); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Transaction Functions","type":"text"}]},{"type":"paragraph","content":[{"text":"The following functions provide transaction safety by performing commit or rollback on a set of calls to a Distributed Storage Profile:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsBeginTransaction","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsCommitTransaction","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsRollbackTransaction","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsBeginTransaction","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsBeginTransaction","type":"text","marks":[{"type":"code"}]},{"text":" function begins a new transaction and returns an object that can be used in subsequent APL calls to distributed storage functions.","type":"text"}]},{"type":"codeBlock","content":[{"text":"any dsBeginTransaction(any profid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"507ad342-3cb6-4acf-ab03-02fe13760096"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A transaction identifier.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsCommitTransaction","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsCommitTransaction","type":"text","marks":[{"type":"code"}]},{"text":" function ends a transaction and commits changes that has been made using the specified transaction identifier.","type":"text"}]},{"type":"codeBlock","content":[{"text":"void dsCommitTransaction(\n any profid,\n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7e6f8c9d-ba44-4f7c-9dd0-68c631906c58"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Nothing.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsCommitTransaction","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\nany transid = null;\n \ninitialize {\n storage = dsInitStorage(\"default.ds_profile\"); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}\n \nconsume {\n transid = dsBeginTransaction(storage);\n bytearray myValue = null;\n strToBA(myValue, \"123\");\n dsStore(storage, \"mykey1\", myValue, transid); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n dsStore(storage, \"mykey2\", myValue, transid); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n dsCommitTransaction(storage, transid); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsRollbackTransaction","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsRollbackTransaction","type":"text","marks":[{"type":"code"}]},{"text":" function ends a transaction and reverts changes that has been made using the specified transaction identifier.","type":"text"}]},{"type":"codeBlock","content":[{"text":"void dsRollbackTransaction(\n any profid,\n any transid)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"c4443a50-252c-4700-91e7-01ad183b4b82"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"transid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The transaction identifier that is returned by dsBeginTransaction.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Nothing.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsRollbackTransaction","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\nany transid = null;\n \ninitialize {\n storage = dsInitStorage(\"default.ds_profile\"); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}\n \nconsume {\n transid = dsBeginTransaction(storage);\n bytearray myValue = null;\n strToBA(myValue, \"123\");\n dsStore(storage, \"mykey1\", myValue, transid); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n dsStore(storage, \"mykey2\", myValue, transid); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n } \n dsRollbackTransaction(storage, transid); //nothing is stored \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Iterator Functions","type":"text"}]},{"type":"paragraph","content":[{"text":"The following functions are used for traversing through a set of keys in a distributed storage:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsCreateKeyIterator","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsCreateREKeyIterator","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsGetNextKey","type":"text","marks":[{"type":"code"}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"dsDestroyKeyIterator ","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsCreateKeyIterator","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note!","type":"text"}]},{"type":"paragraph","content":[{"text":"This iterator function is only valid for Couchbase.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsCreateKeyIterator","type":"text","marks":[{"type":"code"}]},{"text":" function creates an iterator object that is used in subsequent APL calls to other iterator functions.","type":"text"}]},{"type":"codeBlock","content":[{"text":"any dsCreateKeyIterator(\n any profid,\n string startkey,\n string stopkey)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"9fcb4a32-9c39-427b-b5cd-a58332ab9a91"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"startkey","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The key to start iterating at.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"stopkey","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The key to finish iterating at.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"An iterator object used in subsequent APL calls to dsGetNextKey and dsDestroyKeyIterator.7.5.2. dsGetNextKey.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsCreateREKeyIterator","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Note!","type":"text"}]},{"type":"paragraph","content":[{"text":"This iterator function is only valid for Redis.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsCreateREKeyIterator","type":"text","marks":[{"type":"code"}]},{"text":" function creates an iterator object that is used in subsequent APL calls to other iterator functions.","type":"text"}]},{"type":"codeBlock","content":[{"text":"any dsCreateREKeyIterator(\n any profid,\n string searchpattern)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"7644229a-1cdb-4e97-b252-df00116abe67"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"searchpattern","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"A search pattern which may include wild card '*'.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"An iterator object used in subsequent APL calls to dsGetNextKey and dsDestroyKeyIterator.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsGetNextKey","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsGetNextKey","type":"text","marks":[{"type":"code"}]},{"text":" function gets the next available key from a distributed storage using an iterator object. Each subsequent call to the function returns the next key in the iterator's range.","type":"text"}]},{"type":"codeBlock","content":[{"text":"string dsGetNextKey(\n any profid,\n any iterator)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"5c452f18-1804-45f2-9a4e-569cf10442a9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage Profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"iterator","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The iterator object returned by dsCreateKeyIterator.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The key of a key-value pair. A null value is returned if a key cannot be found.","type":"text"}]}]}]}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"heading","attrs":{"level":3},"content":[{"text":"Example - Using dsCreateKeyIterator","type":"text"}]},{"type":"codeBlock","content":[{"text":"any storage = null;\ninitialize {\n storage = dsInitStorage(\"default.ds_profile\"); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}\nconsume { \n string startKey = \"mystartkey\";\n string stopKey = \"mystopkey\"; \n any iterator = \n dsCreateKeyIterator(storage, startKey, stopKey);\n string key = dsGetNextKey(storage, iterator); \n if(null != dsLastErrorMessage()) {\n //Error Handling\n } \n // It is assumed here that \"mystartkey\" and \"mystopkey\" \n // are already stored\n while ( null != key) {\n debug(dsRead(storage, key, null));\n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n key = dsGetNextKey(storage, iterator);\n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n }\n dsDestroyKeyIterator(storage, iterator);\n if(null != dsLastErrorMessage()) {\n //Error Handling\n }\n}","type":"text"}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsDestroyKeyIterator","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsDestroyKeyIterator","type":"text","marks":[{"type":"code"}]},{"text":" function destroys an iterator object created with dsCreateKeyIterator in order to free up memory. It is good practice to always include a call to this function in the APL code though it may not be required for all types of storage.","type":"text"}]},{"type":"codeBlock","content":[{"text":"void dsDestroyKeyIterator( \n any profid,\n any iterator)","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"af0530df-e9e5-49e1-b6f8-0b926331174d"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"profid","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The Distributed Storage profile.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"iterator","type":"text","marks":[{"type":"em"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"The iterator object returned by dsCreateKeyIterator.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Nothing","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Error Handling","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"dsLastErrorMessage","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"dsLastErrorMessage","type":"text","marks":[{"type":"code"}]},{"text":" function returns the error message from the last call to a distributed storage function. Distributed storage functions that are not used for error handling, do not return error codes and generally do not cause runtime errors. For this reason, The dsLastErrorMessage function must be called after each operation to validate success.","type":"text"}]},{"type":"codeBlock","content":[{"text":"string dsLastErrorMessage()","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"e753c227-5829-4af4-9974-6d6d1ccacd9b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Parameter","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Returns","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"An error message, or null if no error has occurred since the last call to this function. The content of message depends on the type of profile that is used with the Distributed Storage profile. For example, with a Couchbase profile, the error message is identical to the error message exposed by the Couchbase API.","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported