(window.webpackJsonp=window.webpackJsonp||[]).push([[201],{485:function(t,s,a){"use strict";a.r(s);var e=a(15),r=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"pexpireat"}},[t._v("pexpireat "),s("a",{staticClass:"heading-anchor-link",attrs:{href:"#pexpireat"}},[t._v("#")])]),t._v(" "),s("p",[t._v("Sets an expiration timestamp on a key. After the timestamp has been reached, the key will automatically be deleted.")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("timestamp")]),t._v(" parameter accepts an "),s("a",{attrs:{href:"https://en.wikipedia.org/wiki/Unix_time",target:"_blank",rel:"noopener noreferrer"}},[t._v("Epoch time"),s("OutboundLink")],1),t._v(" value, in milliseconds.")]),t._v(" "),s("p",[s("a",{attrs:{href:"https://redis.io/commands/pexpireat",target:"_blank",rel:"noopener noreferrer"}},[t._v("["),s("em",[t._v("Redis documentation")]),t._v("]"),s("OutboundLink")],1)]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"argument"}},[t._v("Argument "),s("a",{staticClass:"heading-anchor-link",attrs:{href:"#argument"}},[t._v("#")])]),t._v(" "),s("ul",[s("li",[s("code",[t._v("_id")]),t._v(": key identifier")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"query-syntax"}},[t._v("Query Syntax "),s("a",{staticClass:"heading-anchor-link",attrs:{href:"#query-syntax"}},[t._v("#")])]),t._v(" "),s("h3",{attrs:{id:"http"}},[t._v("HTTP "),s("a",{staticClass:"heading-anchor-link",attrs:{href:"#http"}},[t._v("#")])]),t._v(" "),s("div",{staticClass:"code-block"},[s("div",{staticClass:"language-http extra-class"},[s("div",{staticClass:"codehilite",attrs:{id:"__code_30"}},[s("button",{staticClass:"md-clipboard",attrs:{title:"Copy to clipboard","data-clipboard-target":"#__code_30 pre code"}}),t._v(" "),s("span",{staticClass:"md-clipboard__message"},[t._v("Copied to clipboard!")])]),s("pre",{pre:!0,attrs:{class:"language-http"}},[s("code",[s("span",{pre:!0,attrs:{class:"token header"}},[s("span",{pre:!0,attrs:{class:"token header-name keyword"}},[t._v("URL")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token header-value"}},[t._v("http://kuzzle:7512/ms/_pexpireat/<_id>")])]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token header"}},[s("span",{pre:!0,attrs:{class:"token header-name keyword"}},[t._v("Method")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token header-value"}},[t._v("POST")])]),t._v("\nBody:\n")])])])]),s("div",{staticClass:"code-block"},[s("div",{staticClass:"language-js extra-class"},[s("div",{staticClass:"codehilite",attrs:{id:"__code_31"}},[s("button",{staticClass:"md-clipboard",attrs:{title:"Copy to clipboard","data-clipboard-target":"#__code_31 pre code"}}),t._v(" "),s("span",{staticClass:"md-clipboard__message"},[t._v("Copied to clipboard!")])]),s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"timestamp"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1538640821799")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])]),s("h3",{attrs:{id:"other-protocols"}},[t._v("Other protocols "),s("a",{staticClass:"heading-anchor-link",attrs:{href:"#other-protocols"}},[t._v("#")])]),t._v(" "),s("div",{staticClass:"code-block"},[s("div",{staticClass:"language-js extra-class"},[s("div",{staticClass:"codehilite",attrs:{id:"__code_35"}},[s("button",{staticClass:"md-clipboard",attrs:{title:"Copy to clipboard","data-clipboard-target":"#__code_35 pre code"}}),t._v(" "),s("span",{staticClass:"md-clipboard__message"},[t._v("Copied to clipboard!")])]),s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"controller"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ms"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"action"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pexpireat"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"_id"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<key>"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"body"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"timestamp"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1538640821799")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])]),s("hr"),t._v(" "),s("h2",{attrs:{id:"argument-2"}},[t._v("Argument "),s("a",{staticClass:"heading-anchor-link",attrs:{href:"#argument-2"}},[t._v("#")])]),t._v(" "),s("ul",[s("li",[s("code",[t._v("_id")]),t._v(": key identifier")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"body-properties"}},[t._v("Body properties "),s("a",{staticClass:"heading-anchor-link",attrs:{href:"#body-properties"}},[t._v("#")])]),t._v(" "),s("ul",[s("li",[s("code",[t._v("timestamp")]),t._v(": the key expiration timestamp, using the Epoch-millis format")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"response"}},[t._v("Response "),s("a",{staticClass:"heading-anchor-link",attrs:{href:"#response"}},[t._v("#")])]),t._v(" "),s("p",[t._v("Returns either "),s("code",[t._v("0")]),t._v(" (command failed), or "),s("code",[t._v("1")]),t._v(" (command succeeded).")]),t._v(" "),s("div",{staticClass:"code-block"},[s("div",{staticClass:"language-js extra-class"},[s("div",{staticClass:"codehilite",attrs:{id:"__code_65"}},[s("button",{staticClass:"md-clipboard",attrs:{title:"Copy to clipboard","data-clipboard-target":"#__code_65 pre code"}}),t._v(" "),s("span",{staticClass:"md-clipboard__message"},[t._v("Copied to clipboard!")])]),s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"requestId"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"<unique request identifier>"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"status"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("200")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"error"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"controller"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ms"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"action"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pexpireat"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"collection"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"index"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n  "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v('"result"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])])}),[],!1,null,null,null);s.default=r.exports}}]);