1"use strict";(globalThis.webpackChunkcoalesce_docs=globalThis.webpackChunkcoalesce_docs||[]).push([[10405],{66057(e,n,t){t.r(n),t.d(n,{Badge:()=>u,Bullet:()=>o,SpecifiedBy:()=>c,assets:()=>d,contentTitle:()=>l,default:()=>g,frontMatter:()=>i,metadata:()=>a,toc:()=>p});const a=JSON.parse('{"id":"catalog/api/databases/types/inputs/update-database-input","title":"UpdateDatabaseInput","description":"Input object expected by the query or mutation","source":"@site/docs/catalog/api/09-databases/11-types/03-inputs/update-database-input.mdx","sourceDirName":"catalog/api/09-databases/11-types/03-inputs","slug":"/catalog/api/databases/types/inputs/update-database-input","permalink":"/docs/catalog/api/databases/types/inputs/update-database-input","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"displayed_sidebar":"catalogApiSidebar","hide_table_of_contents":true,"pagination_next":null,"pagination_prev":null,"id":"update-database-input","title":"UpdateDatabaseInput"},"sidebar":"catalogApiSidebar"}');var s=t(74848),r=t(28453);t(14548),t(55719),t(73464),t(17768),t(77242);const i={displayed_sidebar:"catalogApiSidebar",hide_table_of_contents:!0,pagination_next:null,pagination_prev:null,id:"update-database-input",title:"UpdateDatabaseInput"},l=void 0,d={},o=()=>(0,s.jsx)(s.Fragment,{children:(0,s.jsx)("span",{style:{fontWeight:"normal",fontSize:".5em",color:"var(--ifm-color-secondary-darkest)"},children:"\xa0\u25cf\xa0"})}),c=e=>(0,s.jsxs)(s.Fragment,{children:["Specification",(0,s.jsx)("a",{className:"link",style:{fontSize:"1.5em",paddingLeft:"4px"},target:"_blank",href:e.url,title:"Specified by "+e.url,children:"\u2398"})]}),u=e=>(0,s.jsx)(s.Fragment,{children:(0,s.jsx)("span",{className:e.class,children:e.text})}),p=[{value:"Fields",id:"fields",level:3},{value:'<code>UpdateDatabaseInput.<b>deletedAt</b></code><Bullet></Bullet><code><b>DateTime</b></code> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"deleted-at",level:4},{value:'<code>UpdateDatabaseInput.<b>description</b></code><Bullet></Bullet><code><b>String</b></code> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"description",level:4},{value:'<code>UpdateDatabaseInput.<b>isHidden</b></code><Bullet></Bullet><code><b>Boolean</b></code> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"is-hidden",level:4},{value:'<code>UpdateDatabaseInput.<b>externalId</b></code><Bullet></Bullet><code><b>String</b></code> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"external-id",level:4},{value:'<code>UpdateDatabaseInput.<b>id</b></code><Bullet></Bullet><code><b>String!</b></code> <Badge class="badge badge--secondary badge--non_null"></Badge> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"id",level:4},{value:'<code>UpdateDatabaseInput.<b>name</b></code><Bullet></Bullet><code><b>String</b></code> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"name",level:4},{value:"Example",id:"example",level:3},{value:"Member Of",id:"member-of",level:3}];function h(e){const n={a:"a",code:"code",h3:"h3",h4:"h4",li:"li",p:"p",pre:"pre",ul:"ul",...(0,r.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(n.p,{children:"Input object expected by the query or mutation"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-graphql",children:"input UpdateDatabaseInput {\n deletedAt: DateTime\n description: String\n isHidden: Boolean\n externalId: String\n id: String!\n name: String\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"fields",children:"Fields"}),"\n",(0,s.jsxs)(n.h4,{id:"deleted-at",children:[(0,s.jsx)(n.a,{href:"#deleted-at",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["UpdateDatabaseInput.",(0,s.jsx)("b",{children:"deletedAt"})]})}),(0,s.jsx)(o,{}),(0,s.jsx)(n.a,{href:"/docs/catalog/api/general/types/scalars/date-time",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"DateTime"})})})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"scalar"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"general"})]}),"\n",(0,s.jsx)(n.p,{children:"If present, indicates when the database was deleted"}),"\n",(0,s.jsxs)(n.h4,{id:"description",children:[(0,s.jsx)(n.a,{href:"#description",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["UpdateDatabaseInput.",(0,s.jsx)("b",{children:"description"})]})}),(0,s.jsx)(o,{}),(0,s.jsx)(n.a,{href:"/docs/catalog/api/general/types/scalars/string",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"String"})})})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"scalar"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"general"})]}),"\n",(0,s.jsx)(n.p,{children:"The Catalog documentation for this database (max length: 500)"}),"\n",(0,s.jsxs)(n.h4,{id:"is-hidden",children:[(0,s.jsx)(n.a,{href:"#is-
1hidden",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["UpdateDatabaseInput.",(0,s.jsx)("b",{children:"isHidden"})]})}),(0,s.jsx)(o,{}),(0,s.jsx)(n.a,{href:"/docs/catalog/api/general/types/scalars/boolean",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"Boolean"})})})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"scalar"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"general"})]}),"\n",(0,s.jsx)(n.p,{children:"Indicate if the database should be hidden"}),"\n",(0,s.jsxs)(n.h4,{id:"external-id",children:[(0,s.jsx)(n.a,{href:"#external-id",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["UpdateDatabaseInput.",(0,s.jsx)("b",{children:"externalId"})]})}),(0,s.jsx)(o,{}),(0,s.jsx)(n.a,{href:"/docs/catalog/api/general/types/scalars/string",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"String"})})})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"scalar"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"general"})]}),"\n",(0,s.jsx)(n.p,{children:"The technical database identifier from the warehouse structure"}),"\n",(0,s.jsxs)(n.h4,{id:"id",children:[(0,s.jsx)(n.a,{href:"#id",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["UpdateDatabaseInput.",(0,s.jsx)("b",{children:"id"})]})}),(0,s.jsx)(o,{}),(0,s.jsx)(n.a,{href:"/docs/catalog/api/general/types/scalars/string",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"String!"})})})," ",(0,s.jsx)(u,{class:"badge badge--secondary badge--non_null",text:"non-null"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"scalar"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"general"})]}),"\n",(0,s.jsx)(n.p,{children:"The database id"}),"\n",(0,s.jsxs)(n.h4,{id:"name",children:[(0,s.jsx)(n.a,{href:"#name",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["UpdateDatabaseInput.",(0,s.jsx)("b",{children:"name"})]})}),(0,s.jsx)(o,{}),(0,s.jsx)(n.a,{href:"/docs/catalog/api/general/types/scalars/string",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"String"})})})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"scalar"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"general"})]}),"\n",(0,s.jsx)(n.p,{children:"The database name"}),"\n",(0,s.jsx)(n.h3,{id:"example",children:"Example"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-graphql",children:'{\n "deletedAt": "2025-09-20T12:00:00.000Z",\n "description": "Contains customer information",\n "isHidden": false,\n "externalId": "customers",\n "id": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n "name": "Customers"\n}\n'})}),"\n",(0,s.jsx)(n.h3,{id:"member-of",children:"Member Of"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/docs/catalog/api/databases/operations/mutations/update-databases",children:(0,s.jsx)(n.code,{children:"updateDatabases"})})," ",(0,s.jsx)(u,{class:"badge badge--secondary badge--relation",text:"mutation"})]}),"\n"]})]})}function g(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(h,{...e})}):h(e)}},93290(e,n,t){t.d(n,{Cf:()=>g,Sh:()=>m});var a=t(5774),s=t(59811),r=t(86745);function i(e){if((0,a.bd)(e))return`${i(e.ofType)}!`;if((0,a.Fs)(e)){const n=e.ofType,t=(0,a.MR)(n),s=(0,a.bd)(n)?"!":"";return`[${t.name}${s}]`}return(0,a.MR)(e).name}function l(e){if((0,a.Fs)(e)){const n=(0,a.MR)(e.ofType);return(0,a.YQ)(n)?n:null}const n=(0,a.MR)(e);return(0,a.YQ)(n)?n:null}const d=["id","name","label","status","jobId","query","email"],o=["totalCount","page","nbPerPage","jobId","status"];function c(e,n){const t=e.getFields();return n.filter(e=>{const n=t[e];return n&&function(e){const n=(0,a.MR)(e);return(0,a.lg)(n)||(0,a.oF)(n)}(n.type)})}function u(e,n,t,a){const s=" ".repeat(a);if(t>=n.length)return function(e,n){const t=" ".repeat(n),a=c(e,d);return 0===a.length?`${t}__typename`:a.map(e=>`${t}${e}`).join("\n")}(e,a);const r=n[t],i=e.getFields()[r];if(!i)return`${s}__typename`;const o=l(i.type);if(!o)return`${s}__typename`;return`${s}${r} {\n${u(o,n,t+1,a+2)}\n${s}}`}function p(e,n){const t=c(e,d).map(e=>e);if("list"!==n.mode)return t.join("\n ");const a=function(e){if(!e.length)return null;const n=[...e].sort((e,n)=>n.split(".").length-e.split(".").length),t=n.filter(e=>e.split(".").length>=3);return t.find(e=>e.startsWith("schema."))||t.find(e=>e.startsWith("tagEntities."))||t.find(e=>e.split(".").length>=2)||n[0]}(n.paths);if(!a)return t.join("\n ");const s=u(e,a.split("."),0,4),r=a.split(".")[0];return t.includes(r)||t.push(s),t.join("\n ")}function h(e,n,t,s){const r=n.length>0?`${e}(${n.join(", ")})`:e,i=(0,a.MR)(t);if((0,a.lg)(i))return r;const d=function(e,n){const t=(0,a.MR)(e);if((0,a.lg)(t)||(0,a.oF)(t))return null;if(!t.getFields)return"__typename";if((0,a.Fs)(e)){const t=l(e);return t?p(t,n):"__typename"}const s=t.getFields();if(s.data){const e=c(t,o),a=l(s.data.type);if(a){const t=p(a,n);e.push(`data {\n ${t}\n }`)}else e.push("data");return e.join("\n ")}return p(t,n)}(t,s)||"__typename";return`${r} {\n ${d}\n }`}function g(e,n,t){const a="mutation"===n?e.getMutationType():e.getQueryType(),l=a?.getFields()?.[t];if(!l)return null;const d=(0,r.b)(l.description),o=t.charAt(0).toUpperCase()+t.slice(1);if(!l.args.length){return{query:`${n} ${o} {\n ${h(t,[],l.type,d)}\n}`,variables:{},variablesJson:"{}"}}const c=[],u=[],p={};for(const r of l.args){c.push(`$${r.name}: ${i(r.type)}`),u.push(`${r.name}: $${r.name}`);const e=(0,s.t)(r);void 0!==e&&(p[r.name]=e)}return{query:`${n} ${o}(\n ${c.join(",\n ")}\n) {\n ${h(t,u,l.type,d)}\n}`,variables:p,variablesJson:Object.keys(p).length>0?JSON.stringify(p,null,2):"{}"}}function m(e){return(0,a.bd)(e)}},59811(e,n,t){t.d(n,{cB:()=>o,q1:()=>d,t:()=>c});var a=t(5774);const s=["nameContains","name","question","folderPath","pathContains","ids","sourceId","sourceIds","tableIds","databaseId","schemaId","warehouseId","tableId"];function r(e,n){const t=e?.astNode?.directives?.find(e=>"example"===e.name?.value),s=t?.arguments?.find(e=>"value"===e.name?.value),r=s?.value?.value;if("string"==typeof r&&""!==r.trim())return function(e,n){const t=(0,a.MR)(n),s=e.trim();if(s.startsWith("[")||s.startsWith("{"))try{return JSON.parse(s)}catch{return e}if((0,a.oF)(t))return t.getValues().some(e=>
1e.name===s)?s:void 0;if("Int"===t?.name||"Float"===t?.name){const n=Number(s);return Number.isNaN(n)?e:n}if("Boolean"===t?.name){if("true"===s)return!0;if("false"===s)return!1}return e}(r,n)}function i(e,n){return e.endsWith("Scope")?s.includes(n):e.endsWith("Sorting")?["sortingKey","direction"].includes(n):"PublicPagination"===e?["nbPerPage","page"].includes(n):"delaySeconds"===n}function l(e,n={}){const{fieldName:t="",depth:s=0,argName:r=""}=n,i=(0,a.MR)(e),o=(0,a.bd)(e);if((0,a.lg)(i))return function(e,n=""){const t=n.toLowerCase();switch(e.name){case"String":return t.includes("email")?"[email protected]":"question"===t?"revenue by region":t.includes("namecontains")?"revenue":"name"===t?"Example Name":"description"===t?"Created via the Catalog Public API":"label"===t?"example-tag":"externalid"===t?"your_external_id":"datatype"===t?"STRING":"folderpath"===t?"/Reports":t.endsWith("id")||"id"===t?"YOUR_ID":"YOUR_VALUE";case"Int":return"nbperpage"===t?20:"page"===t?0:"delayseconds"===t?2:0;case"Float":return 0;case"Boolean":return"isnullable"===t;case"ID":return"YOUR_ID";default:return null}}(i,t);if((0,a.oF)(i))return function(e,n=""){const t=(0,a.MR)(e);if(!(0,a.oF)(t))return null;const s=t.getValues().map(e=>e.name);return"sortingKey"===n&&s.includes("name")?"name":s.includes("ASC")?"ASC":s[0]??null}(e,t);if((0,a.Fs)(e)){const t=l(e.ofType,{...n,depth:s+1});return null==t?o?[]:void 0:[t]}if((0,a.qK)(i)){const n=d(e,s);return n||(o?{}:void 0)}return o?null:void 0}function d(e,n=0){if(n>5)return null;const t=(0,a.MR)(e);if(!(0,a.qK)(t))return null;if(t.name.endsWith("Scope"))return function(e){const n=e.getFields(),t=(n,t)=>r(t,t.type)??l(t.type,{argName:e.name,fieldName:n,depth:1});for(const a of s){if(!n[a])continue;const e=t(a,n[a]);if(void 0!==e)return{[a]:e}}for(const[a,s]of Object.entries(n)){const e=t(a,s);if(void 0!==e)return{[a]:e}}return null}(t);const d=t.name,o={};for(const[s,c]of Object.entries(t.getFields())){const e=(0,a.bd)(c.type),t=r(c,c.type),u=void 0!==t?t:l(c.type,{argName:d,fieldName:s,depth:n+1});void 0!==u&&((e||void 0!==t||i(d,s))&&(o[s]=u))}return Object.keys(o).length>0?o:null}function o(e,n=0){if(n>1)return null;const t=(0,a.MR)(e);if(!(0,a.YQ)(t))return null;const s=new Set(["id","name","label","status","jobId","totalCount","email","slug","lineageType"]),i={};for(const[d,o]of Object.entries(t.getFields())){const e=(0,a.MR)(o.type);if((0,a.Fs)(o.type)||(0,a.YQ)(e)&&!(0,a.lg)(e))continue;const t=r(o,o.type),c=void 0!==t?t:l(o.type,{fieldName:d,depth:n+1}),u=(0,a.bd)(o.type);void 0!==c&&((u||void 0!==t||s.has(d))&&(i[d]=c))}return Object.keys(i).length>0?i:null}function c(e){const n=(0,a.MR)(e.type),t=r(e,e.type);return void 0!==t?t:(0,a.bd)(e.type)||"pagination"===e.name||"sorting"===e.name||"scope"===e.name||"data"===e.name&&(0,a.qK)(n)?l(e.type,{argName:n.name}):void 0}},86745(e,n,t){function a(e){if(!e)return{mode:"unspecified",paths:[],tree:{}};const n=e.indexOf("### Allowed relations");if(-1===n)return{mode:"unspecified",paths:[],tree:{}};const t=e.slice(n);if(t.includes("You cannot request any relation"))return{mode:"none",paths:[],tree:{}};const a=[...t.matchAll(/- `([^`]+)`/g)].map(e=>e[1]);return 0===a.length?{mode:"unspecified",paths:[],tree:{}}:{mode:"list",paths:a,tree:r(a)}}function s(e){if(!e)return"";const n=e.indexOf("### Allowed relations");return-1===n?e.trim():e.slice(0,n).trim()}function r(e){const n={};for(const t of e){let e=n;for(const n of t.split("."))e[n]||(e[n]={}),e=e[n]}return n}t.d(n,{J:()=>s,b:()=>a})},14548(e,n,t){t.d(n,{A:()=>l});var a=t(96540),s=t(3897);function r(){return(0,a.useEffect)(()=>{(0,s.Cd)()},[]),null}var i=t(74848);function l({children:e,tryIt:n}){return(0,i.jsxs)("div",{className:"graphql-doc-layout",children:[(0,i.jsx)(r,{}),(0,i.jsx)("div",{className:"graphql-doc-main",children:e}),n?(0,i.jsx)("aside",{className:"graphql-doc-aside",children:n}):null]})}},73464(e,n,t){t.d(n,{A:()=>d});var a=t(96540),s=t(29813),r=t(74848);const i=a.lazy(()=>Promise.all([t.e(71869),t.e(82139),t.e(99219),t.e(55373),t.e(14646),t.e(71468),t.e(20652)]).then(t.bind(t,33335)));function l({operation:e,kind:n}){return(0,r.jsx)(s.default,{fallback:(0,r.jsx)("div",{className:"graphql-explorer__loading",children:"Loading explorer\u2026"}),children:()=>(0,r.jsx)(a.Suspense,{fallback:(0,r.jsx)("div",{className:"graphql-explorer__loading",children:"Loading explorer\u2026"}),children:(0,r.jsx)(i,{operation:e,kind:n})})})}function d({operation:e,kind:n}){return(0,r.jsx)(l,{operation:e,kind:n})}},55719(e,n,t){t.d(n,{A:()=>r});t(96540);var a=t(34164),s=t(74848);function r({kind:e,name:n}){return(0,s.jsxs)("div",{className:"graphql__operation-endpoint","data-graphql-kind":e,children:[(0,s.jsx)("span",{className:(0,a.A)("graphql__operation-badge",`graphql__operation-badge--${e}`),children:e}),(0,s.jsx)("code",{className:"graphql__operation-name",children:n})]})}},17768(e,n,t){t.d(n,{A:()=>M});var a=t(96540),s=t(98180),r=t(14783),i=t(93187),l=t(5899),d=t(84466),o=t(5774),c=t(93356),u=t(93290),p=t(86745);function h(e){const n=(0,o.MR)(e);return(0,o.lg)(n)||(0,o.oF)(n)}function g(e){if((0,o.Fs)(e)){const n=(0,o.MR)(e.ofType);return(0,o.YQ)(n)?n:null}const n=(0,o.MR)(e);return(0,o.YQ)(n)?n:null}function m(e){return{name:e.name,type:e.type,required:(0,u.Sh)(e.type),description:e.description,children:[]}}function f(e,{relationsMode:n,relationTree:t,depth:a=0}){if(!e||a>4)return[];const s=[];for(const r of Object.values(e.getFields())){if("__typename"===r.name)continue;if(h(r.type)){s.push(m(r));continue}if("none"===n||"unspecified"===n)continue;if(!t||!t[r.name])continue;const e=m(r),i=g(r.type);
1i&&(e.children=f(i,{relationsMode:"list",relationTree:t[r.name],depth:a+1})),s.push(e)}return s}function x(e,n){return function(e,n){const{mode:t,tree:a}=n,s=(0,o.MR)(e);if((0,o.lg)(s)||(0,o.oF)(s))return[];if((0,o.Fs)(e)){const n=(0,o.MR)(e.ofType);return(0,o.YQ)(n)?f(n,{relationsMode:t,relationTree:a,depth:0}):[]}if(!(0,o.YQ)(s))return[];const r=[];for(const i of Object.values(s.getFields())){if("__typename"===i.name)continue;const e=m(i),n=g(i.type);"data"===i.name&&n?(e.children=f(n,{relationsMode:t,relationTree:a,depth:0}),r.push(e)):h(i.type)?r.push(e):n&&"list"===t&&a[i.name]&&(e.children=f(n,{relationsMode:"list",relationTree:a[i.name],depth:0}),r.push(e))}return r}(e,n)}var b=t(74848);function j(e){return(0,o.bd)(e)?`${j(e.ofType)}!`:(0,o.Fs)(e)?`[${j(e.ofType)}]`:(0,o.MR)(e).name}function y(e){const n=function(e){return(0,o.lg)(e)?"scalars":(0,o.oF)(e)?"enums":(0,o.qK)(e)?"inputs":(0,o.YQ)(e)?"objects":null}(e);return n?`/docs/catalog/api/${function(e){const n=e?.astNode?.directives?.find(e=>"group"===e.name?.value),t=n?.arguments?.find(e=>"name"===e.name?.value),a=t?.value?.value;return"string"!=typeof a||""===a.trim()?"general":a.toLowerCase().replace(/[^a-z0-9]+/g,"-").replace(/^-+|-+$/g,"")}(e)}/types/${n}/${t=e.name,t.replace(/([a-z0-9])([A-Z])/g,"$1-$2").replace(/([A-Z])([A-Z][a-z])/g,"$1-$2").toLowerCase()}`:null;var t}function v({type:e}){const n=y((0,o.MR)(e)),t=j(e);return n?(0,b.jsx)(r.default,{to:n,children:(0,b.jsx)("code",{children:t})}):t}function _({required:e}){return void 0===e?null:e?(0,b.jsx)("span",{className:"openapi-schema__required",children:"required"}):null}function q({name:e,type:n,required:t}){return(0,b.jsxs)("span",{className:"openapi-schema__container",children:[e?(0,b.jsx)("strong",{className:"openapi-schema__property",children:e}):null,(0,b.jsxs)("span",{className:"openapi-schema__name",children:[e?" ":null,(0,b.jsx)(v,{type:n})]}),void 0!==t?(0,b.jsx)("span",{className:"openapi-schema__divider"}):null,(0,b.jsx)(_,{required:t})]})}function N(e,n=0){if(n>2)return[];const t=(0,o.MR)(e);return(0,o.qK)(t)?Object.values(t.getFields()).map(e=>({name:e.name,type:e.type,required:(0,u.Sh)(e.type),description:e.description,children:N(e.type,n+1)})):[]}function S({text:e}){return e?(0,b.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,b.jsx)(d.default,{children:e})}):null}function I({name:e,type:n,required:t}){return(0,b.jsx)("summary",{children:(0,b.jsx)(q,{name:e,type:n,required:t})})}function B({children:e}){return e?(0,b.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,b.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:e})}):null}function F({title:e="Schema",description:n,children:t}){return(0,b.jsxs)(l.default,{className:"openapi-markdown__details response","data-collapsed":!1,open:!0,summary:(0,b.jsx)("summary",{children:(0,b.jsx)("strong",{className:"openapi-markdown__details-summary-response",children:e})}),children:[n?(0,b.jsx)(B,{children:n}):null,(0,b.jsx)("div",{className:"openapi-schema__list",style:{marginLeft:"1rem"},children:t})]})}function $({fields:e}){return e?.length?e.map(e=>(0,b.jsx)(T,{field:e},e.name)):null}function w({field:e}){return(0,b.jsx)("div",{className:"openapi-schema__list-item",children:(0,b.jsxs)("div",{children:[(0,b.jsx)(q,{name:e.name,type:e.type,required:e.required}),e.description?(0,b.jsx)(d.default,{children:e.description}):null]})})}function T({field:e}){return e.children?.length>0?(0,b.jsx)("div",{className:"openapi-schema__list-item",children:(0,b.jsx)(l.default,{className:"openapi-markdown__details",summary:(0,b.jsx)(I,{name:e.name,type:e.type,required:e.required}),children:(0,b.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,b.jsx)(S,{text:e.description}),(0,b.jsx)($,{fields:e.children})]})})}):(0,b.jsx)(w,{field:e})}function M({kind:e,operation:n}){const{schema:t,error:r}=function(){const e=(0,s.Ay)("/graphql/public-schema.graphql"),[n,t]=(0,a.useState)(null),[r,i]=(0,a.useState)(null);return(0,a.useEffect)(()=>{let n=!1;return fetch(e).then(e=>{if(!e.ok)throw new Error(`Failed to load schema (${e.status})`);return e.text()}).then(e=>
1{n||t((0,c.I)(e))}).catch(e=>{n||i(e.message)}),()=>{n=!0}},[e]),{schema:n,error:r}}(),l=(0,a.useMemo)(()=>{if(!t)return null;const a="mutation"===e?t.getMutationType():t.getQueryType(),s=a?.getFields()?.[n];if(!s)return null;const r=s.args.map(e=>({name:e.name,type:e.type,required:(0,u.Sh)(e.type),description:e.description,children:N(e.type)})),i=(0,u.Cf)(t,e,n),l=(0,p.b)(s.description),d=x(s.type,l),o=(0,p.J)(s.description);return{args:r,example:i,allowedRelations:l,responseType:s.type,responseDescription:o,responseFields:d}},[t,e,n]);if(r)return(0,b.jsx)("p",{className:"graphql-op-error",children:"Could not load schema details."});if(!l)return null;const d=l.responseDescription||"none"===l.allowedRelations.mode||"unspecified"===l.allowedRelations.mode&&l.responseFields.length>0;return(0,b.jsxs)("div",{className:"graphql-op-schema",children:[l.args.length>0?(0,b.jsxs)("section",{className:"graphql-op-section",children:[(0,b.jsx)("h2",{children:"Arguments"}),(0,b.jsx)(F,{title:"Schema",children:(0,b.jsx)($,{fields:l.args})})]}):null,l.example?(0,b.jsxs)("section",{className:"graphql-op-section",children:[(0,b.jsx)("h2",{children:"Example"}),(0,b.jsx)("p",{className:"graphql-op-field__desc",children:"Pass argument values as GraphQL variables. In the Try it panel, use the query below and paste the variables JSON into the variables field."}),(0,b.jsx)("h3",{className:"graphql-op-example__heading",children:"Query"}),(0,b.jsx)(i.default,{language:"graphql",className:"graphql-op-example__block",children:l.example.query}),"{}"!==l.example.variablesJson?(0,b.jsxs)(b.Fragment,{children:[(0,b.jsx)("h3",{className:"graphql-op-example__heading",children:"Variables"}),(0,b.jsx)(i.default,{language:"json",className:"graphql-op-example__block",children:l.example.variablesJson})]}):null]}):null,(0,b.jsxs)("section",{className:"graphql-op-section",children:[(0,b.jsx)("h2",{children:"Response"}),(0,b.jsxs)("p",{className:"graphql-op-field__desc",children:["Fields you can include in your query for this operation. Nested objects are listed only when this endpoint supports them. Use a follow-up read query such as"," ",(0,b.jsx)("code",{children:"getColumns"})," or ",(0,b.jsx)("code",{children:"getTables"})," when you need related data not shown here."]}),(0,b.jsxs)(F,{title:"Schema",description:d?(0,b.jsxs)(b.Fragment,{children:[(0,b.jsx)(S,{text:l.responseDescription}),"none"===l.allowedRelations.mode?(0,b.jsx)(S,{text:"This operation returns only simple fields (text, numbers, IDs). Nested relations such as `table` or `tagEntities` are not available on this endpoint."}):null,"unspecified"===l.allowedRelations.mode&&l.responseFields.length>0?(0,b.jsx)(S,{text:"Nested relations are not documented for this operation. Only simple fields are listed below."}):null]}):null,children:[(0,b.jsx)(w,{field:{name:void 0,type:l.responseType,required:void 0,description:void 0}}),l.responseFields.length>0?(0,b.jsx)($,{fields:l.responseFields}):null]})]})]})}},77242(e,n,t){t.d(n,{A:()=>p});var a=t(96540),s=t(90031),r=t(98180),i=t(93187),l=t(5774),d=t(93356),o=t(59811);function c(e,n,t){try{return function(e,n,t){const a=e.getType(n);if(!a)return null;let s=null;return"input"===t||(0,l.qK)(a)?s=(0,o.q1)(a,0,n):("object"===t||(0,l.YQ)(a))&&(s=(0,o.cB)(a)),s&&0!==Object.keys(s).length?JSON.stringify(s,null,2):null}((0,d.I)(e),n,t)}catch{return null}}var u=t(74848);function p(){const{frontMatter:e,metadata:n}=(0,s.u)(),t=(0,r.Ay)("/graphql/public-schema.graphql"),[l,d]=(0,a.useState)(null),[o,p]=(0,a.useState)(null),h=e.title,g=function(e=""){return e.includes("/03-inputs/")?"input":e.includes("/06-objects/")?"object":null}(n?.source);return(0,a.useEffect)(()=>{if(!h||!g)return;let e=!1;return fetch(t).then(e=>{if(!e.ok)throw new Error(`Failed to load schema (${e.status})`);return e.text()}).then(n=>{if(e)return;const t=c(n,h,g);d(t)}).catch(n=>{e||p(n.message)}),()=>{e=!0}},[t,h,g]),o?(0,u.jsx)("p",{className:"graphql-op-error",children:"Could not load type example."}):l?(0,u.jsx)(i.default,{language:"json",className:"graphql-type-example__block",children:l}):null}},3897(e,n,t){t.d(n,{Cd:()=>d,bP:()=>r,hk:()=>i});const a="catalog-api-explorer-token";function s(e){if(!e)return;const n=[];for(let t=0;t<e.length;t+=1){const s=e.key(t);s===a&&n.push(s)}n.forEach(n=>e.removeItem(n))}function r(){if("undefined"==typeof window)return"";const e=sessionStorage.getItem(a);if(e)return e;const n=localStorage.getItem(a);return n?(sessionStorage.setItem(a,n),localStorage.removeItem(a),n):""}function i(e){"undefined"!=typeof window&&(e?sessionStorage.setItem(a,e):sessionStorage.removeItem(a),localStorage.removeItem(a))}let l=!1;function d(){"undefined"==typeof window||l||(l=!0,window.addEventListener("pagehide",e=>{e.persisted||"undefined"!=typeof window&&(s(sessionStorage),s(localStorage))}))}}}]);
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.