[{"data":1,"prerenderedAt":1408},["ShallowReactive",2],{"navigation":3,"\u002Fdatabase\u002Ffunctions":773,"\u002Fdatabase\u002Ffunctions-surround":1403},[4,28,63,85,103,112,269,355,453,485,506,542,576,594,647,669,693,721,747],{"title":5,"path":6,"stem":7,"children":8,"icon":27},"Getting Started","\u002Fgetting-started","01.getting-started\u002F01.index",[9,11,15,19,23],{"title":10,"path":6,"stem":7},"Introduction",{"title":12,"path":13,"stem":14},"Installation","\u002Fgetting-started\u002Finstallation","01.getting-started\u002F02.installation",{"title":16,"path":17,"stem":18},"Quickstart with AI","\u002Fgetting-started\u002Fquickstart-with-ai","01.getting-started\u002F03.quickstart-with-ai",{"title":20,"path":21,"stem":22},"Quickstart by Hand","\u002Fgetting-started\u002Fquickstart-by-hand","01.getting-started\u002F04.quickstart-by-hand",{"title":24,"path":25,"stem":26},"The Admin","\u002Fgetting-started\u002Fadmin-tour","01.getting-started\u002F05.admin-tour","i-lucide-rocket",{"title":29,"icon":30,"path":31,"stem":32,"children":33,"page":62},"Concepts","i-lucide-lightbulb","\u002Fconcepts","02.concepts",[34,38,42,46,50,54,58],{"title":35,"path":36,"stem":37},"PostgreSQL First","\u002Fconcepts\u002Fpostgresql-first","02.concepts\u002F01.postgresql-first",{"title":39,"path":40,"stem":41},"Resources","\u002Fconcepts\u002Fresources","02.concepts\u002F02.resources",{"title":43,"path":44,"stem":45},"Users and Roles","\u002Fconcepts\u002Fusers-and-roles","02.concepts\u002F03.users-and-roles",{"title":47,"path":48,"stem":49},"Permissions","\u002Fconcepts\u002Fpermissions","02.concepts\u002F04.permissions",{"title":51,"path":52,"stem":53},"Drafts and Publishing","\u002Fconcepts\u002Fdrafts-and-publishing","02.concepts\u002F05.drafts-and-publishing",{"title":55,"path":56,"stem":57},"Audit and Events","\u002Fconcepts\u002Faudit-and-events","02.concepts\u002F06.audit-and-events",{"title":59,"path":60,"stem":61},"Object Access","\u002Fconcepts\u002Fobject-access","02.concepts\u002F07.object-access",false,{"title":64,"icon":65,"path":66,"stem":67,"children":68,"page":62},"App","i-lucide-app-window","\u002Fapp","03.app",[69,73,77,81],{"title":70,"path":71,"stem":72},"The App","\u002Fapp\u002Foverview","03.app\u002F01.overview",{"title":74,"path":75,"stem":76},"DataViews","\u002Fapp\u002Fdataviews","03.app\u002F02.dataviews",{"title":78,"path":79,"stem":80},"Dashboards","\u002Fapp\u002Fdashboards","03.app\u002F03.dashboards",{"title":82,"path":83,"stem":84},"Arrange menu","\u002Fapp\u002Farrange-menu","03.app\u002F04.arrange-menu",{"title":86,"icon":87,"path":88,"stem":89,"children":90,"page":62},"Database","i-lucide-database","\u002Fdatabase","04.database",[91,95,99],{"title":92,"path":93,"stem":94},"Tables","\u002Fdatabase\u002Ftables","04.database\u002F01.tables",{"title":96,"path":97,"stem":98},"Views","\u002Fdatabase\u002Fviews","04.database\u002F02.views",{"title":100,"path":101,"stem":102},"Functions","\u002Fdatabase\u002Ffunctions","04.database\u002F03.functions",{"title":104,"icon":105,"path":106,"stem":107,"children":108,"page":62},"SQL Console","i-lucide-square-terminal","\u002Fsql-console","05.sql-console",[109],{"title":104,"path":110,"stem":111},"\u002Fsql-console\u002Foverview","05.sql-console\u002F01.overview",{"title":74,"icon":113,"path":114,"stem":115,"children":116,"page":62},"i-lucide-layout-list","\u002Fdataviews","06.dataviews",[117,121,125,129,183,214],{"title":118,"path":119,"stem":120},"Overview","\u002Fdataviews\u002Foverview","06.dataviews\u002F01.overview",{"title":122,"path":123,"stem":124},"Creating a DataView","\u002Fdataviews\u002Fcreating","06.dataviews\u002F02.creating",{"title":126,"path":127,"stem":128},"Publishing","\u002Fdataviews\u002Fpublishing","06.dataviews\u002F03.publishing",{"title":130,"icon":131,"path":132,"stem":133,"children":134,"page":62},"Types","i-lucide-shapes","\u002Fdataviews\u002Ftypes","06.dataviews\u002F04.types",[135,139,143,147,151,155,159,163,167,171,175,179],{"title":136,"path":137,"stem":138},"Table","\u002Fdataviews\u002Ftypes\u002Ftable","06.dataviews\u002F04.types\u002F01.table",{"title":140,"path":141,"stem":142},"Cards","\u002Fdataviews\u002Ftypes\u002Fcards","06.dataviews\u002F04.types\u002F02.cards",{"title":144,"path":145,"stem":146},"Kanban","\u002Fdataviews\u002Ftypes\u002Fkanban","06.dataviews\u002F04.types\u002F03.kanban",{"title":148,"path":149,"stem":150},"Calendar","\u002Fdataviews\u002Ftypes\u002Fcalendar","06.dataviews\u002F04.types\u002F04.calendar",{"title":152,"path":153,"stem":154},"Gantt","\u002Fdataviews\u002Ftypes\u002Fgantt","06.dataviews\u002F04.types\u002F05.gantt",{"title":156,"path":157,"stem":158},"Map","\u002Fdataviews\u002Ftypes\u002Fmap","06.dataviews\u002F04.types\u002F06.map",{"title":160,"path":161,"stem":162},"Tree","\u002Fdataviews\u002Ftypes\u002Ftree","06.dataviews\u002F04.types\u002F07.tree",{"title":164,"path":165,"stem":166},"Form","\u002Fdataviews\u002Ftypes\u002Fform","06.dataviews\u002F04.types\u002F08.form",{"title":168,"path":169,"stem":170},"Master-detail","\u002Fdataviews\u002Ftypes\u002Fmaster-detail","06.dataviews\u002F04.types\u002F09.master-detail",{"title":172,"path":173,"stem":174},"Settings","\u002Fdataviews\u002Ftypes\u002Fsettings","06.dataviews\u002F04.types\u002F10.settings",{"title":176,"path":177,"stem":178},"Custom","\u002Fdataviews\u002Ftypes\u002Fcustom","06.dataviews\u002F04.types\u002F11.custom",{"title":180,"path":181,"stem":182},"External Frame","\u002Fdataviews\u002Ftypes\u002Fexternal-frame","06.dataviews\u002F04.types\u002F12.external-frame",{"title":172,"icon":184,"path":185,"stem":186,"children":187,"page":62},"i-lucide-settings-2","\u002Fdataviews\u002Fsettings","06.dataviews\u002F05.settings",[188,192,196,199,202,206,210],{"title":189,"path":190,"stem":191},"General","\u002Fdataviews\u002Fsettings\u002Fgeneral","06.dataviews\u002F05.settings\u002F01.general",{"title":193,"path":194,"stem":195},"Data","\u002Fdataviews\u002Fsettings\u002Fdata","06.dataviews\u002F05.settings\u002F02.data",{"title":96,"path":197,"stem":198},"\u002Fdataviews\u002Fsettings\u002Fviews","06.dataviews\u002F05.settings\u002F03.views",{"title":164,"path":200,"stem":201},"\u002Fdataviews\u002Fsettings\u002Fform","06.dataviews\u002F05.settings\u002F04.form",{"title":203,"path":204,"stem":205},"Actions","\u002Fdataviews\u002Fsettings\u002Factions","06.dataviews\u002F05.settings\u002F05.actions",{"title":207,"path":208,"stem":209},"Security","\u002Fdataviews\u002Fsettings\u002Fsecurity","06.dataviews\u002F05.settings\u002F06.security",{"title":211,"path":212,"stem":213},"Versions","\u002Fdataviews\u002Fsettings\u002Fversions","06.dataviews\u002F05.settings\u002F07.versions",{"title":215,"icon":216,"path":217,"stem":218,"children":219,"page":62},"Design Form","i-lucide-pencil-ruler","\u002Fdataviews\u002Fdesign-form","06.dataviews\u002F06.design-form",[220,223,257,261,265],{"title":118,"path":221,"stem":222},"\u002Fdataviews\u002Fdesign-form\u002Foverview","06.dataviews\u002F06.design-form\u002F01.overview",{"title":224,"icon":131,"path":225,"stem":226,"children":227,"page":62},"Widgets","\u002Fdataviews\u002Fdesign-form\u002Fwidgets","06.dataviews\u002F06.design-form\u002F02.widgets",[228,231,234,238,242,246,250,254],{"title":224,"path":229,"stem":230},"\u002Fdataviews\u002Fdesign-form\u002Fwidgets\u002Foverview","06.dataviews\u002F06.design-form\u002F02.widgets\u002F01.overview",{"title":164,"path":232,"stem":233},"\u002Fdataviews\u002Fdesign-form\u002Fwidgets\u002Fform","06.dataviews\u002F06.design-form\u002F02.widgets\u002F02.form",{"title":235,"path":236,"stem":237},"Inputs","\u002Fdataviews\u002Fdesign-form\u002Fwidgets\u002Finputs","06.dataviews\u002F06.design-form\u002F02.widgets\u002F03.inputs",{"title":239,"path":240,"stem":241},"Display","\u002Fdataviews\u002Fdesign-form\u002Fwidgets\u002Fdisplay","06.dataviews\u002F06.design-form\u002F02.widgets\u002F04.display",{"title":243,"path":244,"stem":245},"Embeds","\u002Fdataviews\u002Fdesign-form\u002Fwidgets\u002Fembeds","06.dataviews\u002F06.design-form\u002F02.widgets\u002F05.embeds",{"title":247,"path":248,"stem":249},"Layout","\u002Fdataviews\u002Fdesign-form\u002Fwidgets\u002Flayout","06.dataviews\u002F06.design-form\u002F02.widgets\u002F06.layout",{"title":251,"path":252,"stem":253},"Overlays","\u002Fdataviews\u002Fdesign-form\u002Fwidgets\u002Foverlays","06.dataviews\u002F06.design-form\u002F02.widgets\u002F07.overlays",{"title":203,"path":255,"stem":256},"\u002Fdataviews\u002Fdesign-form\u002Fwidgets\u002Factions","06.dataviews\u002F06.design-form\u002F02.widgets\u002F08.actions",{"title":258,"path":259,"stem":260},"Variables","\u002Fdataviews\u002Fdesign-form\u002Fvariables","06.dataviews\u002F06.design-form\u002F03.variables",{"title":262,"path":263,"stem":264},"Code","\u002Fdataviews\u002Fdesign-form\u002Fcode","06.dataviews\u002F06.design-form\u002F04.code",{"title":266,"path":267,"stem":268},"Formulas","\u002Fdataviews\u002Fdesign-form\u002Fformulas","06.dataviews\u002F06.design-form\u002F05.formulas",{"title":78,"icon":270,"path":271,"stem":272,"children":273,"page":62},"i-lucide-layout-dashboard","\u002Fdashboards","07.dashboards",[274,277,281,285,332],{"title":118,"path":275,"stem":276},"\u002Fdashboards\u002Foverview","07.dashboards\u002F01.overview",{"title":278,"path":279,"stem":280},"Creating a Dashboard","\u002Fdashboards\u002Fcreating","07.dashboards\u002F02.creating",{"title":282,"path":283,"stem":284},"Editor","\u002Fdashboards\u002Feditor","07.dashboards\u002F03.editor",{"title":224,"icon":286,"path":287,"stem":288,"children":289,"page":62},"i-lucide-chart-bar","\u002Fdashboards\u002Fwidgets","07.dashboards\u002F04.widgets",[290,293,297,301,305,309,313,317,321,324,328],{"title":224,"path":291,"stem":292},"\u002Fdashboards\u002Fwidgets\u002Foverview","07.dashboards\u002F04.widgets\u002F01.overview",{"title":294,"path":295,"stem":296},"Editing a Widget","\u002Fdashboards\u002Fwidgets\u002Fediting-a-widget","07.dashboards\u002F04.widgets\u002F02.editing-a-widget",{"title":298,"path":299,"stem":300},"Indicators","\u002Fdashboards\u002Fwidgets\u002Findicators","07.dashboards\u002F04.widgets\u002F03.indicators",{"title":302,"path":303,"stem":304},"Comparison","\u002Fdashboards\u002Fwidgets\u002Fcomparison","07.dashboards\u002F04.widgets\u002F04.comparison",{"title":306,"path":307,"stem":308},"Trend","\u002Fdashboards\u002Fwidgets\u002Ftrend","07.dashboards\u002F04.widgets\u002F05.trend",{"title":310,"path":311,"stem":312},"Proportion","\u002Fdashboards\u002Fwidgets\u002Fproportion","07.dashboards\u002F04.widgets\u002F06.proportion",{"title":314,"path":315,"stem":316},"Distribution and Relation","\u002Fdashboards\u002Fwidgets\u002Fdistribution-and-relation","07.dashboards\u002F04.widgets\u002F07.distribution-and-relation",{"title":318,"path":319,"stem":320},"Maps","\u002Fdashboards\u002Fwidgets\u002Fmaps","07.dashboards\u002F04.widgets\u002F08.maps",{"title":92,"path":322,"stem":323},"\u002Fdashboards\u002Fwidgets\u002Ftables","07.dashboards\u002F04.widgets\u002F09.tables",{"title":325,"path":326,"stem":327},"Visualization and Insertion","\u002Fdashboards\u002Fwidgets\u002Fvisualization-and-insertion","07.dashboards\u002F04.widgets\u002F10.visualization-and-insertion",{"title":329,"path":330,"stem":331},"SQL Conventions","\u002Fdashboards\u002Fwidgets\u002Fsql-conventions","07.dashboards\u002F04.widgets\u002F11.sql-conventions",{"title":172,"icon":184,"path":333,"stem":334,"children":335,"page":62},"\u002Fdashboards\u002Fsettings","07.dashboards\u002F05.settings",[336,339,342,345,349,352],{"title":189,"path":337,"stem":338},"\u002Fdashboards\u002Fsettings\u002Fgeneral","07.dashboards\u002F05.settings\u002F01.general",{"title":258,"path":340,"stem":341},"\u002Fdashboards\u002Fsettings\u002Fvariables","07.dashboards\u002F05.settings\u002F02.variables",{"title":193,"path":343,"stem":344},"\u002Fdashboards\u002Fsettings\u002Fdata","07.dashboards\u002F05.settings\u002F03.data",{"title":346,"path":347,"stem":348},"Share","\u002Fdashboards\u002Fsettings\u002Fshare","07.dashboards\u002F05.settings\u002F04.share",{"title":207,"path":350,"stem":351},"\u002Fdashboards\u002Fsettings\u002Fsecurity","07.dashboards\u002F05.settings\u002F05.security",{"title":211,"path":353,"stem":354},"\u002Fdashboards\u002Fsettings\u002Fversions","07.dashboards\u002F05.settings\u002F06.versions",{"title":356,"icon":357,"path":358,"stem":359,"children":360,"page":62},"Workflows","i-lucide-workflow","\u002Fworkflows","08.workflows",[361,364,368,371,393,432],{"title":118,"path":362,"stem":363},"\u002Fworkflows\u002Foverview","08.workflows\u002F01.overview",{"title":365,"path":366,"stem":367},"Creating a Workflow","\u002Fworkflows\u002Fcreating","08.workflows\u002F02.creating",{"title":282,"path":369,"stem":370},"\u002Fworkflows\u002Feditor","08.workflows\u002F03.editor",{"title":372,"icon":373,"path":374,"stem":375,"children":376,"page":62},"Triggers","i-lucide-zap","\u002Fworkflows\u002Ftriggers","08.workflows\u002F04.triggers",[377,381,385,389],{"title":378,"path":379,"stem":380},"Manual","\u002Fworkflows\u002Ftriggers\u002Fmanual","08.workflows\u002F04.triggers\u002F01.manual",{"title":382,"path":383,"stem":384},"Database Event","\u002Fworkflows\u002Ftriggers\u002Fdatabase-event","08.workflows\u002F04.triggers\u002F02.database-event",{"title":386,"path":387,"stem":388},"Schedule","\u002Fworkflows\u002Ftriggers\u002Fschedule","08.workflows\u002F04.triggers\u002F03.schedule",{"title":390,"path":391,"stem":392},"Webhook","\u002Fworkflows\u002Ftriggers\u002Fwebhook","08.workflows\u002F04.triggers\u002F04.webhook",{"title":394,"icon":357,"path":395,"stem":396,"children":397,"page":62},"Steps","\u002Fworkflows\u002Fsteps","08.workflows\u002F05.steps",[398,401,405,408,412,416,420,424,428],{"title":193,"path":399,"stem":400},"\u002Fworkflows\u002Fsteps\u002Fdata","08.workflows\u002F05.steps\u002F01.data",{"title":402,"path":403,"stem":404},"Control","\u002Fworkflows\u002Fsteps\u002Fcontrol","08.workflows\u002F05.steps\u002F02.control",{"title":262,"path":406,"stem":407},"\u002Fworkflows\u002Fsteps\u002Fcode","08.workflows\u002F05.steps\u002F03.code",{"title":409,"path":410,"stem":411},"Integration","\u002Fworkflows\u002Fsteps\u002Fintegration","08.workflows\u002F05.steps\u002F04.integration",{"title":413,"path":414,"stem":415},"Communication","\u002Fworkflows\u002Fsteps\u002Fcommunication","08.workflows\u002F05.steps\u002F05.communication",{"title":417,"path":418,"stem":419},"Files","\u002Fworkflows\u002Fsteps\u002Ffiles","08.workflows\u002F05.steps\u002F06.files",{"title":421,"path":422,"stem":423},"Documents","\u002Fworkflows\u002Fsteps\u002Fdocuments","08.workflows\u002F05.steps\u002F07.documents",{"title":425,"path":426,"stem":427},"Composition","\u002Fworkflows\u002Fsteps\u002Fcomposition","08.workflows\u002F05.steps\u002F08.composition",{"title":429,"path":430,"stem":431},"Values","\u002Fworkflows\u002Fsteps\u002Fvalues","08.workflows\u002F05.steps\u002F09.values",{"title":172,"icon":184,"path":433,"stem":434,"children":435,"page":62},"\u002Fworkflows\u002Fsettings","08.workflows\u002F06.settings",[436,439,443,446,449],{"title":189,"path":437,"stem":438},"\u002Fworkflows\u002Fsettings\u002Fgeneral","08.workflows\u002F06.settings\u002F01.general",{"title":440,"path":441,"stem":442},"Trigger","\u002Fworkflows\u002Fsettings\u002Ftrigger","08.workflows\u002F06.settings\u002F02.trigger",{"title":207,"path":444,"stem":445},"\u002Fworkflows\u002Fsettings\u002Fsecurity","08.workflows\u002F06.settings\u002F03.security",{"title":211,"path":447,"stem":448},"\u002Fworkflows\u002Fsettings\u002Fversions","08.workflows\u002F06.settings\u002F04.versions",{"title":450,"path":451,"stem":452},"Runs","\u002Fworkflows\u002Fsettings\u002Fruns","08.workflows\u002F06.settings\u002F05.runs",{"title":417,"icon":454,"path":455,"stem":456,"children":457,"page":62},"i-lucide-files","\u002Ffiles","09.files",[458,461,465,469,473,477,481],{"title":118,"path":459,"stem":460},"\u002Ffiles\u002Foverview","09.files\u002F01.overview",{"title":462,"path":463,"stem":464},"Uploading","\u002Ffiles\u002Fuploading","09.files\u002F02.uploading",{"title":466,"path":467,"stem":468},"File Details","\u002Ffiles\u002Ffile-details","09.files\u002F03.file-details",{"title":470,"path":471,"stem":472},"Editing Files","\u002Ffiles\u002Fediting-files","09.files\u002F04.editing-files",{"title":474,"path":475,"stem":476},"Using Files in Tables","\u002Ffiles\u002Fusing-files-in-tables","09.files\u002F05.using-files-in-tables",{"title":478,"path":479,"stem":480},"Image Transformations","\u002Ffiles\u002Fimage-transformations","09.files\u002F06.image-transformations",{"title":482,"path":483,"stem":484},"Who Can See a File","\u002Ffiles\u002Fwho-can-see-a-file","09.files\u002F07.who-can-see-a-file",{"title":486,"icon":487,"path":488,"stem":489,"children":490,"page":62},"Templates","i-lucide-file-text","\u002Ftemplates","10.templates",[491,494,498,502],{"title":118,"path":492,"stem":493},"\u002Ftemplates\u002Foverview","10.templates\u002F01.overview",{"title":495,"path":496,"stem":497},"Emails","\u002Ftemplates\u002Femails","10.templates\u002F02.emails",{"title":499,"path":500,"stem":501},"PDF","\u002Ftemplates\u002Fpdf","10.templates\u002F03.pdf",{"title":503,"path":504,"stem":505},"System Emails","\u002Ftemplates\u002Fsystem-emails","10.templates\u002F04.system-emails",{"title":507,"icon":508,"path":509,"stem":510,"children":511,"page":62},"Users","i-lucide-users","\u002Fusers","11.users",[512,516,520,524,528],{"title":513,"path":514,"stem":515},"Managing Users","\u002Fusers\u002Fmanaging-users","11.users\u002F01.managing-users",{"title":517,"path":518,"stem":519},"A User's Page","\u002Fusers\u002Fa-users-page","11.users\u002F02.a-users-page",{"title":521,"path":522,"stem":523},"API Tokens","\u002Fusers\u002Fapi-tokens","11.users\u002F03.api-tokens",{"title":525,"path":526,"stem":527},"Sessions","\u002Fusers\u002Fsessions","11.users\u002F04.sessions",{"title":529,"icon":530,"path":531,"stem":532,"children":533,"page":62},"Insights","i-lucide-chart-line","\u002Fusers\u002Finsights","11.users\u002F05.insights",[534,538],{"title":535,"path":536,"stem":537},"Sign-ins","\u002Fusers\u002Finsights\u002Fsign-ins","11.users\u002F05.insights\u002F01.sign-ins",{"title":539,"path":540,"stem":541},"Activity","\u002Fusers\u002Finsights\u002Factivity","11.users\u002F05.insights\u002F02.activity",{"title":543,"icon":544,"path":545,"stem":546,"children":547,"page":62},"Roles","i-lucide-shield-check","\u002Froles","12.roles",[548,552,556,560,564,568,572],{"title":549,"path":550,"stem":551},"Creating a Role","\u002Froles\u002Fcreating-a-role","12.roles\u002F01.creating-a-role",{"title":553,"path":554,"stem":555},"Granting Permissions","\u002Froles\u002Fgranting-permissions","12.roles\u002F02.granting-permissions",{"title":557,"path":558,"stem":559},"Row Filters","\u002Froles\u002Frow-filters","12.roles\u002F03.row-filters",{"title":561,"path":562,"stem":563},"Payload Checks","\u002Froles\u002Fpayload-checks","12.roles\u002F04.payload-checks",{"title":565,"path":566,"stem":567},"Members","\u002Froles\u002Fmembers","12.roles\u002F05.members",{"title":569,"path":570,"stem":571},"Access Reviews","\u002Froles\u002Faccess-reviews","12.roles\u002F06.access-reviews",{"title":573,"path":574,"stem":575},"Delegated Administration","\u002Froles\u002Fdelegated-administration","12.roles\u002F07.delegated-administration",{"title":577,"icon":578,"path":579,"stem":580,"children":581,"page":62},"Logs","i-lucide-scroll-text","\u002Flogs","13.logs",[582,586,590],{"title":583,"path":584,"stem":585},"Audit Log","\u002Flogs\u002Faudit-log","13.logs\u002F01.audit-log",{"title":587,"path":588,"stem":589},"An Entry","\u002Flogs\u002Fan-entry","13.logs\u002F02.an-entry",{"title":591,"path":592,"stem":593},"Where Else It Shows","\u002Flogs\u002Fwhere-else-it-shows","13.logs\u002F03.where-else-it-shows",{"title":595,"icon":596,"path":597,"stem":598,"children":599,"page":62},"Data API","i-lucide-braces","\u002Fdata-api","14.data-api",[600,603,607,611,615,619,623,627,631,635,639,643],{"title":118,"path":601,"stem":602},"\u002Fdata-api\u002Foverview","14.data-api\u002F01.overview",{"title":604,"path":605,"stem":606},"Authentication","\u002Fdata-api\u002Fauthentication","14.data-api\u002F02.authentication",{"title":608,"path":609,"stem":610},"Reading","\u002Fdata-api\u002Freading","14.data-api\u002F03.reading",{"title":612,"path":613,"stem":614},"Filtering","\u002Fdata-api\u002Ffiltering","14.data-api\u002F04.filtering",{"title":616,"path":617,"stem":618},"Aggregating","\u002Fdata-api\u002Faggregating","14.data-api\u002F05.aggregating",{"title":620,"path":621,"stem":622},"Writing","\u002Fdata-api\u002Fwriting","14.data-api\u002F06.writing",{"title":624,"path":625,"stem":626},"Nested Writes","\u002Fdata-api\u002Fnested-writes","14.data-api\u002F07.nested-writes",{"title":628,"path":629,"stem":630},"Transactions","\u002Fdata-api\u002Ftransactions","14.data-api\u002F08.transactions",{"title":632,"path":633,"stem":634},"Calling Functions","\u002Fdata-api\u002Fcalling-functions","14.data-api\u002F09.calling-functions",{"title":636,"path":637,"stem":638},"OpenAPI","\u002Fdata-api\u002Fopenapi","14.data-api\u002F10.openapi",{"title":640,"path":641,"stem":642},"Routes","\u002Fdata-api\u002Froutes","14.data-api\u002F11.routes",{"title":644,"path":645,"stem":646},"A client, end to end","\u002Fdata-api\u002Fa-client","14.data-api\u002F12.a-client",{"title":172,"icon":648,"path":649,"stem":650,"children":651,"page":62},"i-lucide-settings","\u002Fsettings","15.settings",[652,655,659,662,665],{"title":189,"path":653,"stem":654},"\u002Fsettings\u002Fgeneral","15.settings\u002F01.general",{"title":656,"path":657,"stem":658},"Access","\u002Fsettings\u002Faccess","15.settings\u002F02.access",{"title":207,"path":660,"stem":661},"\u002Fsettings\u002Fsecurity","15.settings\u002F03.security",{"title":595,"path":663,"stem":664},"\u002Fsettings\u002Fdata-api","15.settings\u002F04.data-api",{"title":666,"path":667,"stem":668},"Features","\u002Fsettings\u002Ffeatures","15.settings\u002F05.features",{"title":670,"icon":671,"path":672,"stem":673,"children":674,"page":62},"User Profile","i-lucide-circle-user","\u002Fuser-profile","16.user-profile",[675,679,682,686,690],{"title":676,"path":677,"stem":678},"My Account","\u002Fuser-profile\u002Fmy-account","16.user-profile\u002F01.my-account",{"title":525,"path":680,"stem":681},"\u002Fuser-profile\u002Fsessions","16.user-profile\u002F02.sessions",{"title":683,"path":684,"stem":685},"Tokens","\u002Fuser-profile\u002Ftokens","16.user-profile\u002F03.tokens",{"title":687,"path":688,"stem":689},"Preferences","\u002Fuser-profile\u002Fpreferences","16.user-profile\u002F04.preferences",{"title":539,"path":691,"stem":692},"\u002Fuser-profile\u002Factivity","16.user-profile\u002F05.activity",{"title":694,"icon":695,"path":696,"stem":697,"children":698,"page":62},"AI Agents","i-lucide-bot","\u002Fai-agents","17.ai-agents",[699,702,705,709,713,717],{"title":118,"path":700,"stem":701},"\u002Fai-agents\u002Foverview","17.ai-agents\u002F01.overview",{"title":683,"path":703,"stem":704},"\u002Fai-agents\u002Ftokens","17.ai-agents\u002F02.tokens",{"title":706,"path":707,"stem":708},"MCP Server","\u002Fai-agents\u002Fmcp-server","17.ai-agents\u002F03.mcp-server",{"title":710,"path":711,"stem":712},"Recipes","\u002Fai-agents\u002Frecipes","17.ai-agents\u002F04.recipes",{"title":714,"path":715,"stem":716},"Tools","\u002Fai-agents\u002Ftools","17.ai-agents\u002F05.tools",{"title":718,"path":719,"stem":720},"llms.txt","\u002Fai-agents\u002Fllms-txt","17.ai-agents\u002F06.llms-txt",{"title":722,"icon":723,"path":724,"stem":725,"children":726,"page":62},"Operations","i-lucide-server","\u002Foperations","18.operations",[727,731,735,739,743],{"title":728,"path":729,"stem":730},"Deployment","\u002Foperations\u002Fdeployment","18.operations\u002F01.deployment",{"title":732,"path":733,"stem":734},"PostgreSQL","\u002Foperations\u002Fpostgresql","18.operations\u002F02.postgresql",{"title":736,"path":737,"stem":738},"Public URL, Proxy and CORS","\u002Foperations\u002Fpublic-url-proxy-cors","18.operations\u002F03.public-url-proxy-cors",{"title":740,"path":741,"stem":742},"Backup and Restore","\u002Foperations\u002Fbackup-restore","18.operations\u002F04.backup-restore",{"title":744,"path":745,"stem":746},"Upgrading","\u002Foperations\u002Fupgrading","18.operations\u002F05.upgrading",{"title":748,"icon":749,"path":750,"stem":751,"children":752,"page":62},"Reference","i-lucide-library","\u002Freference","19.reference",[753,757,761,765,769],{"title":754,"path":755,"stem":756},"Query Language","\u002Freference\u002Fquery-language","19.reference\u002F01.query-language",{"title":758,"path":759,"stem":760},"Errors","\u002Freference\u002Ferrors","19.reference\u002F02.errors",{"title":762,"path":763,"stem":764},"Admin API","\u002Freference\u002Fadmin-api","19.reference\u002F03.admin-api",{"title":766,"path":767,"stem":768},"Authentication API","\u002Freference\u002Fauth-api","19.reference\u002F04.auth-api",{"title":770,"path":771,"stem":772},"Environment Variables","\u002Freference\u002Fenvironment","19.reference\u002F05.environment",{"id":774,"title":100,"admin":775,"body":776,"description":1397,"extension":1398,"links":1399,"meta":1400,"navigation":914,"path":101,"seo":1401,"stem":102,"__hash__":1402},"docs\u002F04.database\u002F03.functions.md","Database › a schema › Functions",{"type":777,"value":778,"toc":1386},"minimark",[779,788,798,801,806,817,974,977,982,987,990,1032,1036,1057,1060,1101,1104,1111,1115,1118,1162,1169,1173,1176,1193,1230,1238,1254,1258,1316,1331,1335,1346,1367,1371,1382],[780,781,782,783,787],"p",{},"TotalBase has no custom actions of its own. When an application needs an operation that isn't a plain create, update or delete (create an invoice from a work order, close a month, plan next month's maintenance), write a PostgreSQL function. It becomes a ",[784,785,786],"code",{},"FUNCTION"," resource you can expose, grant and call.",[789,790,796],"pre",{"className":791,"code":793,"language":794,"meta":795},[792],"language-text","POST \u002Fapi\u002F{schema}\u002Ffunction\u002F{name}\n","text","",[784,797,793],{"__ignoreMap":795},[780,799,800],{},"The logic lives in the database, next to the data, inside a transaction. It runs the same way whether an application, an integration or a workflow calls it.",[802,803,805],"h2",{"id":804},"creating-one","Creating one",[780,807,808,809,812,813,816],{},"Functions are written in SQL. In ",[810,811,86],"strong",{},", choose a schema and ",[810,814,815],{},"New function",": the SQL Console opens with a skeleton to fill in. Acme invoices a completed work order:",[789,818,822],{"className":819,"code":820,"language":821,"meta":795,"style":795},"language-sql shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","CREATE FUNCTION public.create_invoice_from_work_order(work_order uuid)\nRETURNS uuid\nLANGUAGE plpgsql AS $$\nDECLARE\n  wo      work_orders;\n  invoice uuid;\nBEGIN\n  SELECT * INTO wo FROM work_orders WHERE id = work_order FOR UPDATE;\n  IF NOT FOUND THEN\n    RAISE EXCEPTION 'Work order not found';\n  END IF;\n  IF wo.status \u003C> 'COMPLETED' THEN\n    RAISE EXCEPTION 'Only a completed work order can be invoiced';\n  END IF;\n\n  INSERT INTO invoices (customer, work_order, issued_on, due_on, status, tax_rate)\n  SELECT s.customer, wo.id, current_date, current_date + 30, 'DRAFT', 21\n  FROM sites s WHERE s.id = wo.site\n  RETURNING id INTO invoice;\n\n  -- hours at the plan's rate, then the parts used\n  INSERT INTO invoice_items (invoice, description, quantity, unit_price) …;\n\n  RETURN invoice;\nEND $$;\n","sql",[784,823,824,832,838,844,850,856,862,868,874,880,886,892,898,904,909,916,922,928,934,940,945,951,957,962,968],{"__ignoreMap":795},[825,826,829],"span",{"class":827,"line":828},"line",1,[825,830,831],{},"CREATE FUNCTION public.create_invoice_from_work_order(work_order uuid)\n",[825,833,835],{"class":827,"line":834},2,[825,836,837],{},"RETURNS uuid\n",[825,839,841],{"class":827,"line":840},3,[825,842,843],{},"LANGUAGE plpgsql AS $$\n",[825,845,847],{"class":827,"line":846},4,[825,848,849],{},"DECLARE\n",[825,851,853],{"class":827,"line":852},5,[825,854,855],{},"  wo      work_orders;\n",[825,857,859],{"class":827,"line":858},6,[825,860,861],{},"  invoice uuid;\n",[825,863,865],{"class":827,"line":864},7,[825,866,867],{},"BEGIN\n",[825,869,871],{"class":827,"line":870},8,[825,872,873],{},"  SELECT * INTO wo FROM work_orders WHERE id = work_order FOR UPDATE;\n",[825,875,877],{"class":827,"line":876},9,[825,878,879],{},"  IF NOT FOUND THEN\n",[825,881,883],{"class":827,"line":882},10,[825,884,885],{},"    RAISE EXCEPTION 'Work order not found';\n",[825,887,889],{"class":827,"line":888},11,[825,890,891],{},"  END IF;\n",[825,893,895],{"class":827,"line":894},12,[825,896,897],{},"  IF wo.status \u003C> 'COMPLETED' THEN\n",[825,899,901],{"class":827,"line":900},13,[825,902,903],{},"    RAISE EXCEPTION 'Only a completed work order can be invoiced';\n",[825,905,907],{"class":827,"line":906},14,[825,908,891],{},[825,910,912],{"class":827,"line":911},15,[825,913,915],{"emptyLinePlaceholder":914},true,"\n",[825,917,919],{"class":827,"line":918},16,[825,920,921],{},"  INSERT INTO invoices (customer, work_order, issued_on, due_on, status, tax_rate)\n",[825,923,925],{"class":827,"line":924},17,[825,926,927],{},"  SELECT s.customer, wo.id, current_date, current_date + 30, 'DRAFT', 21\n",[825,929,931],{"class":827,"line":930},18,[825,932,933],{},"  FROM sites s WHERE s.id = wo.site\n",[825,935,937],{"class":827,"line":936},19,[825,938,939],{},"  RETURNING id INTO invoice;\n",[825,941,943],{"class":827,"line":942},20,[825,944,915],{"emptyLinePlaceholder":914},[825,946,948],{"class":827,"line":947},21,[825,949,950],{},"  -- hours at the plan's rate, then the parts used\n",[825,952,954],{"class":827,"line":953},22,[825,955,956],{},"  INSERT INTO invoice_items (invoice, description, quantity, unit_price) …;\n",[825,958,960],{"class":827,"line":959},23,[825,961,915],{"emptyLinePlaceholder":914},[825,963,965],{"class":827,"line":964},24,[825,966,967],{},"  RETURN invoice;\n",[825,969,971],{"class":827,"line":970},25,[825,972,973],{},"END $$;\n",[780,975,976],{},"TotalBase picks it up at once as a hidden resource.",[978,979],"screenshot",{"caption":980,"id":981},"The create_invoice_from_work_order function's page: its arguments, return type, definition and endpoint.","database-function-page",[983,984,986],"h3",{"id":985},"write-it-for-callers","Write it for callers",[780,988,989],{},"A function exposed through the API is an API of its own. Write it that way:",[991,992,993,1008,1022],"ul",{},[994,995,996,999,1000,1003,1004,1007],"li",{},[810,997,998],{},"Check its inputs",", and refuse with ",[784,1001,1002],{},"RAISE EXCEPTION"," and a sentence a user can read. The message reaches the caller unchanged, as ",[784,1005,1006],{},"422 RAISE_EXCEPTION",", and a DataView shows it.",[994,1009,1010,1013,1014,1017,1018,1021],{},[810,1011,1012],{},"Lock what it changes"," (",[784,1015,1016],{},"FOR UPDATE","), so two concurrent calls can't invoice the same order twice. An ",[784,1019,1020],{},"Idempotency-Key"," protects against a retried request too.",[994,1023,1024,1027,1028,1031],{},[810,1025,1026],{},"Know who's calling."," ",[784,1029,1030],{},"current_setting('totalbase.actor_user_id', true)"," is the calling user's id.",[802,1033,1035],{"id":1034},"exposing-and-granting","Exposing and granting",[780,1037,1038,1039,1042,1043,1046,1047,1049,1050,1053,1054,1056],{},"A function has one method, ",[784,1040,1041],{},"POST",", and one action, ",[784,1044,1045],{},"EXECUTE",". Enable ",[784,1048,1041],{}," in its ",[810,1051,1052],{},"Endpoints",", then grant ",[784,1055,1045],{}," to the roles that may call it.",[780,1058,1059],{},"Row filters and field grants don't apply to functions: TotalBase can't see inside one. What it reads and writes is decided by PostgreSQL:",[1061,1062,1063,1076],"table",{},[1064,1065,1066],"thead",{},[1067,1068,1069,1073],"tr",{},[1070,1071,1072],"th",{},"The function is",[1070,1074,1075],{},"It runs with the privileges of",[1077,1078,1079,1091],"tbody",{},[1067,1080,1081,1088],{},[1082,1083,1084,1087],"td",{},[784,1085,1086],{},"SECURITY INVOKER"," (the default)",[1082,1089,1090],{},"TotalBase's database role",[1067,1092,1093,1098],{},[1082,1094,1095],{},[784,1096,1097],{},"SECURITY DEFINER",[1082,1099,1100],{},"the function's owner",[780,1102,1103],{},"If a function must respect who may do what, check it inside the function: for example, compare the order's branch with the calling user's.",[780,1105,1106,1107,1110],{},"For a function that must never run twice for the same request, such as charging a payment, turn on ",[810,1108,1109],{},"Require an idempotency key"," under its Endpoints.",[802,1112,1114],{"id":1113},"classification","Classification",[780,1116,1117],{},"On a function's page, classify it:",[1061,1119,1120,1130],{},[1064,1121,1122],{},[1067,1123,1124,1127],{},[1070,1125,1126],{},"Class",[1070,1128,1129],{},"Means",[1077,1131,1132,1142,1152],{},[1067,1133,1134,1139],{},[1082,1135,1136],{},[784,1137,1138],{},"QUERY",[1082,1140,1141],{},"only reads: safe to call and retry",[1067,1143,1144,1149],{},[1082,1145,1146],{},[784,1147,1148],{},"ACTION",[1082,1150,1151],{},"changes data",[1067,1153,1154,1159],{},[1082,1155,1156],{},[784,1157,1158],{},"UNCLASSIFIED",[1082,1160,1161],{},"not said: treat it as one that may change data",[780,1163,1164,1165,1168],{},"The class doesn't change how the function runs. It's documentation: it's in the generated OpenAPI (",[784,1166,1167],{},"x-totalbase-function-class","), where developers and AI agents read it to decide what's safe to call.",[802,1170,1172],{"id":1171},"calling-it","Calling it",[780,1174,1175],{},"From the API, with the arguments by name:",[789,1177,1181],{"className":1178,"code":1179,"language":1180,"meta":795,"style":795},"language-http shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","POST \u002Fapi\u002Fpublic\u002Ffunction\u002Fcreate_invoice_from_work_order\n{ \"data\": { \"work_order\": \"8f1c…\" } }\n","http",[784,1182,1183,1188],{"__ignoreMap":795},[825,1184,1185],{"class":827,"line":828},[825,1186,1187],{},"POST \u002Fapi\u002Fpublic\u002Ffunction\u002Fcreate_invoice_from_work_order\n",[825,1189,1190],{"class":827,"line":834},[825,1191,1192],{},"{ \"data\": { \"work_order\": \"8f1c…\" } }\n",[789,1194,1198],{"className":1195,"code":1196,"language":1197,"meta":795,"style":795},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{ \"data\": \"c41e…\" }\n","json",[784,1199,1200],{"__ignoreMap":795},[825,1201,1202,1206,1209,1213,1216,1219,1221,1225,1227],{"class":827,"line":828},[825,1203,1205],{"class":1204},"sMK4o","{",[825,1207,1208],{"class":1204}," \"",[825,1210,1212],{"class":1211},"spNyl","data",[825,1214,1215],{"class":1204},"\"",[825,1217,1218],{"class":1204},":",[825,1220,1208],{"class":1204},[825,1222,1224],{"class":1223},"sfazB","c41e…",[825,1226,1215],{"class":1204},[825,1228,1229],{"class":1204}," }\n",[780,1231,1232,1233,1237],{},"The call runs in one transaction, is recorded in the audit log with its arguments, and produces an event that workflows can react to. ",[1234,1235,1236],"a",{"href":633},"Calling functions"," covers results, overloads and asynchronous calls.",[780,1239,1240,1241,1244,1245,1249,1250,1253],{},"Workflows call functions too, with an ",[810,1242,1243],{},"Execute function"," step: Acme's ",[1246,1247,1248],"em",{},"Order completed"," workflow calls ",[784,1251,1252],{},"create_invoice_from_work_order"," as soon as an order is completed.",[802,1255,1257],{"id":1256},"what-can-be-a-resource","What can be a resource",[1061,1259,1260,1270],{},[1064,1261,1262],{},[1067,1263,1264,1267],{},[1070,1265,1266],{},"PostgreSQL object",[1070,1268,1269],{},"In TotalBase",[1077,1271,1272,1284,1292,1300,1308],{},[1067,1273,1274,1281],{},[1082,1275,1276,1277,1280],{},"a function with plain ",[784,1278,1279],{},"IN"," parameters",[1082,1282,1283],{},"a resource",[1067,1285,1286,1289],{},[1082,1287,1288],{},"each overload of a function",[1082,1290,1291],{},"a separate resource, with its own exposure and permission",[1067,1293,1294,1297],{},[1082,1295,1296],{},"a trigger function",[1082,1298,1299],{},"never a resource: only PostgreSQL calls it",[1067,1301,1302,1305],{},[1082,1303,1304],{},"a procedure",[1082,1306,1307],{},"listed in the catalog, not a resource",[1067,1309,1310,1313],{},[1082,1311,1312],{},"a function owned by an extension",[1082,1314,1315],{},"not a resource",[780,1317,1318,1319,1322,1323,1326,1327,1330],{},"Functions with ",[784,1320,1321],{},"OUT",", ",[784,1324,1325],{},"INOUT"," or ",[784,1328,1329],{},"VARIADIC"," parameters can't be called through the API.",[802,1332,1334],{"id":1333},"changing-and-dropping","Changing and dropping",[780,1336,1337,1338,1341,1342,1345],{},"A function's page shows its definition. ",[810,1339,1340],{},"Edit"," opens it in the SQL Console as ",[784,1343,1344],{},"CREATE OR REPLACE FUNCTION",".",[991,1347,1348,1354,1357],{},[994,1349,1350,1353],{},[784,1351,1352],{},"CREATE OR REPLACE"," keeps its identity: exposure and permissions stay.",[994,1355,1356],{},"Changing its arguments creates a different overload, which is a new resource.",[994,1358,1359,1362,1363,1366],{},[784,1360,1361],{},"DROP FUNCTION"," and ",[784,1364,1365],{},"CREATE FUNCTION"," again makes a new, hidden resource with no permissions.",[802,1368,1370],{"id":1369},"next-steps","Next steps",[991,1372,1373,1377],{},[994,1374,1375,1345],{},[1234,1376,1236],{"href":633},[994,1378,1379,1381],{},[1234,1380,356],{"href":362},": run a function when something happens.",[1383,1384,1385],"style",{},"html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}",{"title":795,"searchDepth":828,"depth":834,"links":1387},[1388,1391,1392,1393,1394,1395,1396],{"id":804,"depth":834,"text":805,"children":1389},[1390],{"id":985,"depth":840,"text":986},{"id":1034,"depth":834,"text":1035},{"id":1113,"depth":834,"text":1114},{"id":1171,"depth":834,"text":1172},{"id":1256,"depth":834,"text":1257},{"id":1333,"depth":834,"text":1334},{"id":1369,"depth":834,"text":1370},"PostgreSQL functions as resources: business actions and calculations callable from the API, screens and workflows.","md",null,{},{"title":100,"description":1397},"ZFRpBZQ60EmQ51A7j9Ekqx3FcJvPJaVY-cLV2ScrrdQ",[1404,1406],{"title":96,"path":97,"stem":98,"description":1405,"children":-1},"PostgreSQL views as read-only resources: saved queries, joined and computed data, materialized views.",{"title":104,"path":110,"stem":111,"description":1407,"children":-1},"Run any SQL the database role allows, from the admin - with history, EXPLAIN and PostgreSQL's full diagnostics.",1792339945287]