PageSourceSearch

https://docs.coalesce.io/assets/js/0652b12e.10344846.js

js coalesce.io collected 2026-09-24 18:04:11 UTC 30,471 bytes, 1 lines download raw bytes

1"use strict";(globalThis.webpackChunkcoalesce_docs=globalThis.webpackChunkcoalesce_docs||[]).push([[7432],{6489(e,n,t){t.r(n),t.d(n,{Badge:()=>u,Bullet:()=>d,SpecifiedBy:()=>c,assets:()=>o,contentTitle:()=>i,default:()=>g,frontMatter:()=>l,metadata:()=>a,toc:()=>p});const a=JSON.parse('{"id":"catalog/api/column-joins/types/objects/get-column-joins-output","title":"GetColumnJoinsOutput","description":"Paginated response from the executed query or mutation","source":"@site/docs/catalog/api/02-column-joins/11-types/06-objects/get-column-joins-output.mdx","sourceDirName":"catalog/api/02-column-joins/11-types/06-objects","slug":"/catalog/api/column-joins/types/objects/get-column-joins-output","permalink":"/docs/catalog/api/column-joins/types/objects/get-column-joins-output","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"displayed_sidebar":"catalogApiSidebar","hide_table_of_contents":true,"pagination_next":null,"pagination_prev":null,"id":"get-column-joins-output","title":"GetColumnJoinsOutput"},"sidebar":"catalogApiSidebar"}');var s=t(74848),r=t(28453);t(14548),t(55719),t(73464),t(17768),t(77242);const l={displayed_sidebar:"catalogApiSidebar",hide_table_of_contents:!0,pagination_next:null,pagination_prev:null,id:"get-column-joins-output",title:"GetColumnJoinsOutput"},i=void 0,o={},d=()=>(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>GetColumnJoinsOutput.<b>greatestId</b></code><Bullet></Bullet><code><b>String</b></code> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"greatest-id",level:4},{value:'<code>GetColumnJoinsOutput.<b>nbPerPage</b></code><Bullet></Bullet><code><b>Int!</b></code> <Badge class="badge badge--secondary badge--non_null"></Badge> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"nb-per-page",level:4},{value:'<code>GetColumnJoinsOutput.<b>page</b></code><Bullet></Bullet><code><b>Int</b></code> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"page",level:4},{value:'<code>GetColumnJoinsOutput.<b>totalCount</b></code><Bullet></Bullet><code><b>Int!</b></code> <Badge class="badge badge--secondary badge--non_null"></Badge> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"total-count",level:4},{value:'<code>GetColumnJoinsOutput.<b>data</b></code><Bullet></Bullet><code><b>[ColumnJoin!]!</b></code> <Badge class="badge badge--secondary badge--non_null"></Badge> <Badge class="badge badge--secondary "></Badge> <Badge class="badge badge--secondary "></Badge>',id:"data",level:4},{value:"Example",id:"example",level:3},{value:"Returned By",id:"returned-by",level:3}];function f(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:"Paginated response from the executed query or mutation"}),"\n",(0,s.jsx)(n.pre,{children:(0,s.jsx)(n.code,{className:"language-graphql",children:"type GetColumnJoinsOutput {\n  greatestId: String\n  nbPerPage: Int!\n  page: Int\n  totalCount: Int!\n  data: [ColumnJoin!]!\n}\n"})}),"\n",(0,s.jsx)(n.h3,{id:"fields",children:"Fields"}),"\n",(0,s.jsxs)(n.h4,{id:"greatest-id",children:[(0,s.jsx)(n.a,{href:"#greatest-id",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["GetColumnJoinsOutput.",(0,s.jsx)("b",{children:"greatestId"})]})}),(0,s.jsx)(d,{}),(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 greatest id returned, to pass as the next 'greaterThanId' when using cursor-based pagination. Returned only when page is not used."}),"\n",(0,s.jsxs)(n.h4,{id:"nb-per-page",children:[(0,s.jsx)(n.a,{href:"#nb-per-page",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["GetColumnJoinsOutput.",(0,s.jsx)("b",{children:"nbPerPage"})]})}),(0,s.jsx)(d,{}),(0,s.jsx)(n.a,{href:"/docs/catalog/api/general/types/scalars/int",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"Int!"})})})," ",(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:"Number of entities to return per page"}),"\n",(0,s.jsxs)(n.h4,{id:"page",children:[(0,s.jsx)(n.a,{href:"#page",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["GetColumnJoinsOutput.",(0,s.jsx)("b",{children:"page"})]})}),(0,s.jsx)(d,{}),(0,s.jsx)(n.a,{href:"/docs/catalog/api/general/types/scalars/int",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"Int"})})})," ",(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 page number (start at 0). Returned only when greaterThanId is not used."}),"\n",(0,s.jsxs)(n.h4,{id:"total-count",children:[(0,s.jsx)(n.a,{href:"#total-count",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["GetColumnJoinsOutput.",(0,s.jsx)("b",{children:"totalCount"})]})}),(0,s.jsx)(d,{}),(0,s.jsx)(n.a,{href:"/docs/catalog/api/general/types/scalars/int",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"Int!"})})})," ",(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 total number of entities"}),"\n",(0,s.jsxs)(n.h4,{id:"data",children:[(0,s.jsx)(n.a,{href:"#data",children:(0,s.jsxs)("code",{style:{fontWeight:"normal"},children:["GetColumnJoinsOutput.",(0,s.jsx)("b",{children:"data"})]})}),(0,s.jsx)(d,{}),(0,s.jsx)(n.a,{href:"/docs/catalog/api/column-joins/types/objects/column-join",children:(0,s.jsx)("code",{style:{fontWeight:"normal"},children:(0,s.jsx)("b",{children:"[ColumnJoin!]!"})})})," ",(0,s.jsx)(u,{class:"badge badge--secondary badge--non_null",text:"non-null"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"object"})," ",(0,s.jsx)(u,{class:"badge badge--secondary ",text:"column-joins"})]}),"\n",(0,s.jsx)(n.p,{children:"Field containing the response from the executed query or mutation"}),"\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  "greatestId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n  "nbPerPage": 50,\n  "page": 0,\n  "totalCount": 100,\n  "data": [\n    {\n      "id": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n      "count": 5,\n      "firstColumnId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n      "firstColumn": {\
1n        "dataType": "STRING",\n        "descriptionRaw": "Contains customer email",\n        "externalDescription": "Contains customer email",\n        "externalDescriptionSource": "COALESCE",\n        "externalId": "customer.email",\n        "isDescriptionGenerated": false,\n        "isNullable": true,\n        "isPii": false,\n        "isPrimaryKey": true,\n        "name": "email",\n        "sourceOrder": 0,\n        "accountId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n        "databaseId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n        "describedByColumnId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n        "schemaId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n        "sourceId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n        "tableId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n        "table": {\n          "deprecatedAt": 1758555879800,\n          "descriptionStateLexical": {\n            "root": {\n              "children": [\n                {\n                  "type": "paragraph",\n                  "version": 1\n                }\n              ],\n              "direction": null,\n              "format": "",\n              "indent": 0,\n              "type": "root",\n              "version": 1\n            }\n          },\n          "lastQueriedAt": 1758555879800,\n          "lastRefreshedAt": 1758555879800,\n          "numberOfQueries": 100,\n          "popularity": 80,\n          "slug": "c-customers-table",\n          "tableSize": 32,\n          "tableType": "TABLE",\n          "transformationSource": "COALESCE",\n          "url": "https://app.snowflake.com/",\n          "verifiedAt": 1758555879800,\n          "deprecatedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n          "entityEditors": [\n            {\n              "dashboardId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n              "sourceUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n              "sourceUser": {\n                "avatarUrl": "https://example.com/avatar.png",\n                "email": "[email protected]",\n                "unifiedId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n                "unifiedUser": {\n                  "role": "CONTRIBUTOR",\n                  "status": "ACTIVATED",\n                  "teamIds": [\n                    "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"\n                  ],\n                  "userId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n                  "createdAt": 1758555879800\n                },\n                "deletedAt": 1758555879800,\n                "updatedAt": 1758555879800\n              },\n              "termId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n              "refreshedAt": 1758555879800\n            }\n          ],\n          "externalLinks": [\n            {\n              "technology": "GITLAB"\n            }\n          ],\n          "lastDescribedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n          "ownerEntities": [\n            {\n              "ownerLabelId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n              "ownerLabel": {\n                "label": "Data Steward"\n              },\n              "user": {\n                "firstName": "John",\n                "lastName": "Doe",\n                "ownerEntities": [],\n                "fullName": "John Doe"\n              }\n            }\n          ],\n          "schema": {\n            "description": "Default Postgres schema",\n            "isHidden": false,\n            "database": {\n              "warehouse": {\n                "origin": "EXTRACTION",\n                "type": "COMMUNICATION"\n              }\n            }\n          },\n          "tagEntities": [\n            {\n              "tagId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n              "tag": {\n                "color": "ALERT_COLOR",\n                "linkedTermId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"\n              }\n            }\n          ],\n          "teamOwnerEntities": [\n            {\n              "teamId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n              "team": {\n                "slackChannel": "#emea-sales",\n                "slackGroup": "@emea-sales",\n                "source": "Slack",\n                "teamOwnerEntities": []\n              }\n            }\n          ],\n          "verifiedByUserId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba",\n          "isDeprecated": false,\n          "isVerified": false\n        },\n        "tagEntities": []\n      },\n      "secondColumnId": "fffe43cb-a92f-48d9-9527-3fcc4e5f6dba"\n    }\n  ]\n}\n'})}),"\n",(0,s.jsx)(n.h3,{id:"returned-by",children:"Returned By"}),"\n",(0,s.jsxs)(n.ul,{children:["\n",(0,s.jsxs)(n.li,{children:[(0,s.jsx)(n.a,{href:"/docs/catalog/api/column-joins/operations/queries/get-column-joins",children:(0,s.jsx)(n.code,{children:"getColumnJoins"})}),"  ",(0,s.jsx)(u,{class:"badge badge--secondary badge--relation",text:"query"})]}),"\n"]})]})}function g(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,s.jsx)(n,{...e,children:(0,s.jsx)(f,{...e})}):f(e)}},93290(e,n,t){t.d(n,{Cf:()=>g,Sh:()=>h});var a=t(5774),s=t(59811),r=t(86745);function l(e){if((0,a.bd)(e))return`${l(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 i(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 o=["id","name","label","status","jobId","query","email"],d=["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,o);return 0===a.length?`${t}__typename`:a.map(e=>`${t}${e}`).join("\n")}(e,a);const r=n[t],l=e.getFields()[r];if(!l)return`${s}__typename`;const d=i(l.type);if(!d)return`${s}__typename`;return`${s}${r} {\n${u(d,n,t+1,a+2)}\n${s}}`}function p(e,n){const t=c(e,o).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 f(e,n,t,s){const r=n.length>0?`${e}(${n.join(", ")})`:e,l=(0,a.MR)(t);if((0,a.lg)(l))return r;const o=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=i(e);return t?p(t,n):"__typename"}const s=t.getFields();if(s.data){const e=c(t,d),a=i(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    ${o}\n  }`}function g(e,n,t){const a="mutation"===n?e.getMutationType():e.getQueryType(),i=a?.getFields()?.[t];if(!i)return null;const o=(0,r.b)(i.description),d=t.charAt(0).toUpperCase()+t.slice(1);if(!i.args.length){return{query:`${n} ${d} {\n  ${f(t,[],i.type,o)}\n}`,variables:{},variablesJson:"{}"}}const c=[],u=[],p={};for(const r of i.args){c.push(`$${r.name}: ${l(r.type)}`),u.push(`${r.name}: $${r.name}`);const e=(0,s.t)(r);void 0!==e&&(p[r.name]=e)}return{query:`${n} ${d}(\n  ${c.join(",\n  ")}\n) {\n  ${f(t,u,i.type,o)}\n}`,variables:p,variablesJson:Object.keys(p).length>0?JSON.stringify(p,null,2):"{}"}}function h(e){return(0,a.bd)(e)}},59811(e,n,t){t.d(n,{cB:()=>d,q1:()=>o,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 l(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 i(e,n={}){const{fieldName:t="",depth:s=0,argName:r=""}=n,l=(0,a.MR)(e),d=(0,a.bd)(e);if((0,a.lg)(l))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}}(l,t);if((0,a.oF)(l))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=i(e.ofType,{...n,depth:s+1});return null==t?d?[]:void 0:[t]}if((0,a.qK)(l)){const n=o(e,s);return n||(d?{}:void 0)}return d?null:void 0}function o(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)??i(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 o=t.name,d={};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:i(c.type,{argName:o,fieldName:s,depth:n+1});void 0!==u&&((e||void 0!==t||l(o,s))&&(d[s]=u))}return Object.keys(d).length>0?d:null}function d(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"]),l={};for(const[o,d]of Object.entries(t.getFields())){const e=(0,a.MR)(d.type);if((0,a.Fs)(d.type)||(0,a.YQ)(e)&&!(0,a.lg)(e))continue;const t=r(d,d.type),c=void 0!==t?t:i(d.type,{fieldName:o,depth:n+1}),u=(0,a.bd)(d.type);void 0!==c&&((u||void 0!==t||s.has(o))&&(l[o]=c))}return Object.keys(l).length>0?l: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)?i(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:()=>i});var a=t(96540),s=t(3897);function r(){return(0,a.useEffect)(()=>{(0,s.Cd)()},[]),null}var l=t(74848);function i({children:e,tryIt:n}){return(0,l.jsxs)("div",{className:"graphql-doc-layout",children:[(0,l.jsx)(r,{}),(0,l.jsx)("div",{className:"graphql-doc-main",children:e}),n?(0,l.jsx)("aside",{className:"graphql-doc-aside",children:n}):null]})}},73464(e,n,t){t.d(n,{A:()=>o});var a=t(96540),s=t(29813),r=t(74848);const l=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 i({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)(l,{operation:e,kind:n})})})}function o({operation:e,kind:n}){return(0,r.jsx)(i,{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:()=>F});var a=t(96540),s=t(98180),r=t(14783),l=t(93187),i=t(5899),o=t(84466),d=t(5774),c=t(93356),u=t(93290),p=t(86745);function f(e){const n=(0,d.MR)(e);return(0,d.lg)(n)||(0,d.oF)(n)}function g(e){if((0,d.Fs)(e)){const n=(0,d.MR)(e.ofType);return(0,d.YQ)(n)?n:null}const n=(0,d.MR)(e);return(0,d.YQ)(n)?n:null}function h(e){return{name:e.name,type:e.type,required:(0,u.Sh)(e.type),description:e.description,children:[]}}function m(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;
1if(f(r.type)){s.push(h(r));continue}if("none"===n||"unspecified"===n)continue;if(!t||!t[r.name])continue;const e=h(r),l=g(r.type);l&&(e.children=m(l,{relationsMode:"list",relationTree:t[r.name],depth:a+1})),s.push(e)}return s}function b(e,n){return function(e,n){const{mode:t,tree:a}=n,s=(0,d.MR)(e);if((0,d.lg)(s)||(0,d.oF)(s))return[];if((0,d.Fs)(e)){const n=(0,d.MR)(e.ofType);return(0,d.YQ)(n)?m(n,{relationsMode:t,relationTree:a,depth:0}):[]}if(!(0,d.YQ)(s))return[];const r=[];for(const l of Object.values(s.getFields())){if("__typename"===l.name)continue;const e=h(l),n=g(l.type);"data"===l.name&&n?(e.children=m(n,{relationsMode:t,relationTree:a,depth:0}),r.push(e)):f(l.type)?r.push(e):n&&"list"===t&&a[l.name]&&(e.children=m(n,{relationsMode:"list",relationTree:a[l.name],depth:0}),r.push(e))}return r}(e,n)}var x=t(74848);function y(e){return(0,d.bd)(e)?`${y(e.ofType)}!`:(0,d.Fs)(e)?`[${y(e.ofType)}]`:(0,d.MR)(e).name}function j(e){const n=function(e){return(0,d.lg)(e)?"scalars":(0,d.oF)(e)?"enums":(0,d.qK)(e)?"inputs":(0,d.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=j((0,d.MR)(e)),t=y(e);return n?(0,x.jsx)(r.default,{to:n,children:(0,x.jsx)("code",{children:t})}):t}function _({required:e}){return void 0===e?null:e?(0,x.jsx)("span",{className:"openapi-schema__required",children:"required"}):null}function I({name:e,type:n,required:t}){return(0,x.jsxs)("span",{className:"openapi-schema__container",children:[e?(0,x.jsx)("strong",{className:"openapi-schema__property",children:e}):null,(0,x.jsxs)("span",{className:"openapi-schema__name",children:[e?" ":null,(0,x.jsx)(v,{type:n})]}),void 0!==t?(0,x.jsx)("span",{className:"openapi-schema__divider"}):null,(0,x.jsx)(_,{required:t})]})}function N(e,n=0){if(n>2)return[];const t=(0,d.MR)(e);return(0,d.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 q({text:e}){return e?(0,x.jsx)("div",{style:{marginTop:".5rem",marginBottom:".5rem"},children:(0,x.jsx)(o.default,{children:e})}):null}function C({name:e,type:n,required:t}){return(0,x.jsx)("summary",{children:(0,x.jsx)(I,{name:e,type:n,required:t})})}function S({children:e}){return e?(0,x.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"},children:(0,x.jsx)("div",{style:{marginTop:"1rem",marginBottom:"1rem"},children:e})}):null}function B({title:e="Schema",description:n,children:t}){return(0,x.jsxs)(i.default,{className:"openapi-markdown__details response","data-collapsed":!1,open:!0,summary:(0,x.jsx)("summary",{children:(0,x.jsx)("strong",{className:"openapi-markdown__details-summary-response",children:e})}),children:[n?(0,x.jsx)(S,{children:n}):null,(0,x.jsx)("div",{className:"openapi-schema__list",style:{marginLeft:"1rem"},children:t})]})}function w({fields:e}){return e?.length?e.map(e=>(0,x.jsx)(O,{field:e},e.name)):null}function T({field:e}){return(0,x.jsx)("div",{className:"openapi-schema__list-item",children:(0,x.jsxs)("div",{children:[(0,x.jsx)(I,{name:e.name,type:e.type,required:e.required}),e.description?(0,x.jsx)(o.default,{children:e.description}):null]})})}function O({field:e}){return e.children?.length>0?(0,x.jsx)("div",{className:"openapi-schema__list-item",children:(0,x.jsx)(i.default,{className:"openapi-markdown__details",summary:(0,x.jsx)(C,{name:e.name,type:e.type,required:e.required}),children:(0,x.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,x.jsx)(q,{text:e.description}),(0,x.jsx)(w,{fields:e.children})]})})}):(0,x.jsx)(T,{field:e})}function F({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,l]=(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||l(e.message)}),()=>{n=!0}},[e]),{schema:n,error:r}}(),i=(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)})),l=(0,u.Cf)(t,e,n),i=(0,p.b)(s.description),o=b(s.type,i),d=(0,p.J)(s.description);return{args:r,example:l,allowedRelations:i,responseType:s.type,responseDescription:d,responseFields:o}},[t,e,n]);if(r)return(0,x.jsx)("p",{className:"graphql-op-error",children:"Could not load schema details."});if(!i)return null;const o=i.responseDescription||"none"===i.allowedRelations.mode||"unspecified"===i.allowedRelations.mode&&i.responseFields.length>0;return(0,x.jsxs)("div",{className:"graphql-op-schema",children:[i.args.length>0?(0,x.jsxs)("section",{className:"graphql-op-section",children:[(0,x.jsx)("h2",{children:"Arguments"}),(0,x.jsx)(B,{title:"Schema",children:(0,x.jsx)(w,{fields:i.args})})]}):null,i.example?(0,x.jsxs)("section",{className:"graphql-op-section",children:[(0,x.jsx)("h2",{children:"Example"}),(0,x.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,x.jsx)("h3",{className:"graphql-op-example__heading",children:"Query"}),(0,x.jsx)(l.default,{language:"graphql",className:"graphql-op-example__block",children:i.example.query}),"{}"!==i.example.variablesJson?(0,x.jsxs)(x.Fragment,{children:[(0,x.jsx)("h3",{className:"graphql-op-example__heading",children:"Variables"}),(0,x.jsx)(l.default,{language:"json",className:"graphql-op-example__block",children:i.example.variablesJson})]}):null]}):null,(0,x.jsxs)("section",{className:"graphql-op-section",children:[(0,x.jsx)("h2",{children:"Response"}),(0,x.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,x.jsx)("code",{children:"getColumns"})," or ",(0,x.jsx)("code",{children:"getTables"})," when you need related data not shown here."]}),(0,x.jsxs)(B,{title:"Schema",description:o?(0,x.jsxs)(x.Fragment,{children:[(0,x.jsx)(q,{text:i.responseDescription}),"none"===i.allowedRelations.mode?(0,x.jsx)(q,{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"===i.allowedRelations.mode&&i.responseFields.length>0?(0,x.jsx)(q,{text:"Nested relations are not documented for this operation. Only simple fields are listed below."}):null]}):null,children:[(0,x.jsx)(T,{field:{name:void 0,type:i.responseType,required:void 0,description:void 0}}),i.responseFields.length>0?(0,x.jsx)(w,{fields:i.responseFields}):null]})]})]})}},77242(e,n,t){t.d(n,{A:()=>p});var a=t(96540),s=t(90031),r=t(98180),l=t(93187),i=t(5774),o=t(93356),d=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,i.qK)(a)?s=(0,d.q1)(a,0,n):("object"===t||(0,i.YQ)(a))&&(s=(0,d.cB)(a)),s&&0!==Object.keys(s).length?JSON.stringify(s,null,2):null}((0,o.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"),[i,o]=(0,a.useState)(null),[d,p]=(0,a.useState)(null),f=e.title,g=function(e=""){return e.includes("/03-inputs/")?"input":e.includes("/06-objects/")?"object":null}(n?.source);return(0,a.useEffect)(()=>{if(!f||!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,f,g);o(t)}).catch(n=>{e||p(n.message)}),()=>{e=!0}},[t,f,g]),d?(0,u.jsx)("p",{className:"graphql-op-error",children:"Could not load type example."}):i?(0,u.jsx)(l.default,{language:"json",className:"graphql-type-example__block",children:i}):null}},3897(e,n,t){t.d(n,{Cd:()=>o,bP:()=>r,hk:()=>l});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 l(e){"undefined"!=typeof window&&(e?sessionStorage.setItem(a,e):sessionStorage.removeItem(a),localStorage.removeItem(a))}let i=!1;function o(){"undefined"==typeof window||i||(i=!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.