1"use strict";(self.webpackChunkottoman_documentation=self.webpackChunkottoman_documentation||[]).push([[2390],{7223:(e,n,i)=>{i.r(n),i.d(n,{assets:()=>c,contentTitle:()=>r,default:()=>a,frontMatter:()=>o,metadata:()=>s,toc:()=>l});const s=JSON.parse('{"id":"api/interfaces/UpdateManyOptions","title":"Interface: UpdateManyOptions","description":"Defined in7","source":"@site/docs/api/interfaces/UpdateManyOptions.md","sourceDirName":"api/interfaces","slug":"/api/interfaces/UpdateManyOptions","permalink":"/docs/api/interfaces/UpdateManyOptions","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{},"sidebar":"tutorialSidebar","previous":{"title":"saveOptions","permalink":"/docs/api/interfaces/saveOptions"},"next":{"title":"ValidatorOption","permalink":"/docs/api/interfaces/ValidatorOption"}}');var t=i(4848),d=i(8453);const o={},r="Interface: UpdateManyOptions",c={},l=[{value:"Extends",id:"extends",level:2},{value:"Properties",id:"properties",level:2},{value:"consistency?",id:"consistency",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"enforceRefCheck?",id:"enforcerefcheck",level:3},{value:"Overrides",id:"overrides",level:4},{value:"ignoreCase?",id:"ignorecase",level:3},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"lean?",id:"lean",level:3},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"limit?",id:"limit",level:3},{value:"Inherited from",id:"inherited-from-3",level:4},{value:"maxExpiry?",id:"maxexpiry",level:3},{value:"Inherited from",id:"inherited-from-4",level:4},{value:"noCollection?",id:"nocollection",level:3},{value:"Inherited from",id:"inherited-from-5",level:4},{value:"populate?",id:"populate",level:3},{value:"Inherited from",id:"inherited-from-6",level:4},{value:"populateMaxDeep?",id:"populatemaxdeep",level:3},{value:"Inherited from",id:"inherited-from-7",level:4},{value:"select?",id:"select",level:3},{value:"Inherited from",id:"inherited-from-8",level:4},{value:"skip?",id:"skip",level:3},{value:"Inherited from",id:"inherited-from-9",level:4},{value:"sort?",id:"sort",level:3},{value:"Inherited from",id:"inherited-from-10",level:4},{value:"strict?",id:"strict",level:3},{value:"Inherited from",id:"inherited-from-11",level:4},{value:"transactionContext?",id:"transactioncontext",level:3},{value:"Inherited from",id:"inherited-from-12",level:4},{value:"upsert?",id:"upsert",level:3}];function h(e){const n={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.header,{children:(0,t.jsx)(n.h1,{id:"interface-updatemanyoptions",children:"Interface: UpdateManyOptions"})}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/model/interfaces/update-many.interface.ts#L7",children:"model/interfaces/update-many.interface.ts:7"})]}),"\n",(0,t.jsx)(n.p,{children:"Update Many Options parameter"}),"\n",(0,t.jsx)(n.h2,{id:"extends",children:"Extends"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:[(0,t.jsx)(n.code,{children:"IFindOptions"}),".",(0,t.jsx)(n.a,{href:"/docs/api/type-aliases/MutationFunctionOptions",children:(0,t.jsx)(n.code,{children:"MutationFunctionOptions"})})]}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"properties",children:"Properties"}),"\n",(0,t.jsx)(n.h3,{id:"consistency",children:"consistency?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"consistency"}),": ",(0,t.jsx)(n.a,{href:"/docs/api/enumerations/SearchConsistency",children:(0,t.jsx)(n.code,{children:"SearchConsistency"})})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/handler/find/find-options.ts#L41",children:"handler/find/find-options.ts:41"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"IFindOptions.consistency"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"enforcerefcheck",children:"enforceRefCheck?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"enforceRefCheck"}),": ",(0,t.jsx)(n.code,{children:"boolean"})," | ",(0,t.jsx)(n.code,{children:'"throw"'})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/model/interfaces/update-many.interface.ts#L19",children:"model/interfaces/update-many.interface.ts:19"})]}),"\n",(0,t.jsx)(n.p,{children:"Default: false\nenforceRefCheck will check if the referenced document exists\nset to true: will log a warning message.\nset to 'throw': will throw an exception."}),"\n",(0,t.jsx)(n.h4,{id:"overrides",children:"Overrides"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/docs/api/type-aliases/MutationFunctionOptions",children:(0,t.jsx)(n.code,{children:"MutationFunctionOptions"})}),".",(0,t.jsx)(n.a,{href:"/docs/api/type-aliases/MutationFunctionOptions#enforcerefcheck",children:(0,t.jsx)(n.code,{children:"enforceRefCheck"})})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"ignorecase",children:"ignoreCase?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"ignoreCase"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/handler/find/find-options.ts#L44",children:"handler/find/find-options.ts:44"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"IFindOptions.ignoreCase"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"lean",children:"lean?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"lean"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/handler/find/find-options.ts#L43",children:"handler/find/find-options.ts:43"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"IFindOptions.lean"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"limit",children:"limit?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"limit"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/handler/find/find-options.ts#L36",children:"handler/find/find-options.ts:36"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"IFindOptions.limit"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"maxexpiry",children:"maxExpiry?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"maxExpiry"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/utils/cast-strategy.ts#L53",children:"utils/cast-strategy.ts:53"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-4",children:"Inherited from"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/docs/api/type-aliases/MutationFunctionOptions",children:(0,t.jsx)(n.code,{children:"MutationFunctionOptions"})}),".",(0,t.jsx)(n.a,{href:"/docs/api/type-aliases/MutationFunctionOptions#maxexpiry",children:(0,t.jsx)(n.code,{children:"maxExpiry"})})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"nocollection",children:"noCollection?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"noCollection"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/handler/find/find-options.ts#L42",children:"handler/find/find-options.ts:42"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-5",children:"Inherited from"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"IFindOptions.noCollection"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"populate",children:"populate?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"populate"}),": ",(0,t.jsx)(n.code,{children:"PopulateFieldsType"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/handler/find/find-options.ts#L38",children:"handler/find/find-options.ts:38"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-6",children:"Inherited from"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"IFindOptions.populate"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"populatemaxdeep",children:"populateMaxDeep?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"populateMaxDeep"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/handler/find/find-options.ts#L39",children:"handler/find/find-options.ts:39"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-7",children:"Inherited from"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"IFindOptions.populateMaxDeep"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"select",children:"select?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"select"}),": ",(0,t.jsx)(n.code,{children:"string"})," | ",(0,t.jsx)(n.code,{children:"string"}),"[] | ",(0,t.jsx)(n.a,{href:"/docs/api/type-aliases/ISelectType",children:(0,t.jsx)(n.code,{children:"ISelectType"})}),"[]"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/handler/find/find-options.ts#L40",children:"handler/find/find-options.ts:40"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-8",children:"Inherited from"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"IFindOptions.select"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"skip",children:"skip?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"skip"}),": ",(0,t.jsx)(n.code,{children:"number"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/handler/find/find-options.ts#L35",children:"handler/find/find-options.ts:35"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-9",children:"Inherited from"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"IFindOptions.skip"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"sort",children:"sort?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"sort"}),": ",(0,t.jsx)(n.code,{children:"Record"}),"<",(0,t.jsx)(n.code,{children:"string"}),", ",(0,t.jsx)(n.a,{href:"/docs/api/type-aliases/SortType",children:(0,t.jsx)(n.code,{children:"SortType"})}),">"]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/handler/find/find-options.ts#L37",children:"handler/find/find-options.ts:37"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-10",children:"Inherited from"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"IFindOptions.sort"})}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"strict",children:"strict?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"strict"}),": ",(0,t.jsx)(n.code,{children:"ApplyStrategy"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/utils/cast-strategy.ts#L52",children:"utils/cast-strategy.ts:52"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-11",children:"Inherited from"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/docs/api/type-aliases/MutationFunctionOptions",children:(0,t.jsx)(n.code,{children:"MutationFunctionOptions"})}),".",(0,t.jsx)(n.a,{href:"/docs/api/type-aliases/MutationFunctionOptions#strict",children:(0,t.jsx)(n.code,{children:"strict"})})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"transactioncontext",children:"transactionContext?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"transactionContext"}),": ",(0,t.jsx)(n.code,{children:"TransactionAttemptContext"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/utils/cast-strategy.ts#L55",children:"utils/cast-strategy.ts:55"})]}),"\n",(0,t.jsx)(n.h4,{id:"inherited-from-12",children:"Inherited from"}),"\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"/docs/api/type-aliases/MutationFunctionOptions",children:(0,t.jsx)(n.code,{children:"MutationFunctionOptions"})}),".",(0,t.jsx)(n.a,{href:"/docs/api/type-aliases/MutationFunctionOptions#transactioncontext",children:(0,t.jsx)(n.code,{children:"transactionContext"})})]}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.h3,{id:"upsert",children:"upsert?"}),"\n",(0,t.jsxs)(n.blockquote,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.code,{children:"optional"})," ",(0,t.jsx)(n.strong,{children:"upsert"}),": ",(0,t.jsx)(n.code,{children:"boolean"})]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Defined in: ",(0,t.jsx)(n.a,{href:"https://github.com/couchbaselabs/node-ottoman/blob/1d27269e06fbcd854d0a0ee2417c83714e023318/src/model/interfaces/update-many.interface.ts#L11",children:"model/interfaces/update-many.interface.ts:11"})]}),"\n",(0,t.jsx)(n.p,{children:"Default: false\nif true, and no documents found, insert a new document."})]})}function a(e={}){const{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(h,{...e})}):h(e)}},8453:(e,n,i)=>{i.d(n,{R:()=>o,x:()=>r});var s=i(6540);const t={},d=s.createContext(t);function o(e){const n=s.useContext(d);return s.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function r(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:o(e.components),s.createElement(d.Provider,{value:n},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.