Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.snackbase.dev/llms.txt

Use this file to discover all available pages before exploring further.

The Macros service allows you to create and manage custom SQL macros that can be used in permission rules. Macros provide reusable SQL fragments that help you write more complex and dynamic permission logic.

​
Overview

import { SnackBaseClient } from "@snackbase/sdk";

const client = new SnackBaseClient({
  baseUrl: "https://api.example.com",
});

// Access the macros service
const macros = client.macros;
Most macro operations require superadmin authentication.

​
List Macros

Retrieve all available macros, including built-in ones: 
const response = await client.macros.list();
// Returns: { items: Macro[], total: number }
The response includes both built-in macros (provided by SnackBase) and custom macros created for your account.

​
Get a Macro

Get details for a specific macro: 
const macro = await client.macros.get("macro-id");

​
Create a Macro

Create a new custom macro: 
const macro = await client.macros.create({
  name: "user_posts",
  description: "Get posts owned by the current user",
  template: "SELECT * FROM posts WHERE user_id = {{user_id}}",
  parameters: ["user_id"]
});
The template property uses {{parameter_name}} syntax for parameter substitution.

​
Update a Macro

Update an existing custom macro: 
const updated = await client.macros.update("macro-id", {
  description: "Updated description",
  template: "SELECT * FROM posts WHERE user_id = {{user_id}} AND status = 'published'"
});
Built-in macros cannot be updated.

​
Delete a Macro

Delete a custom macro: 
await client.macros.delete("macro-id");
You cannot delete built-in macros or macros that are currently in use by permission rules.

​
Test a Macro

Test a macro with specific parameters: 
const result = await client.macros.test("macro-id", {
  user_id: "user-123"
});
// Returns: { sql: string, parameters: any[] }
This is useful for validating that your macro generates the correct SQL before using it in production rules.

​
Built-in Macros

SnackBase provides several built-in macros:
NameDescription
current_userGet the ID of the currently authenticated user
current_accountGet the ID of the current account
user_rolesGet roles for a specific user
group_membersGet members of a specific group

​
Using Macros in Rules

Macros can be referenced in permission rules using the {{macro_name}} syntax: 
// Example rule using a macro
const rule = {
  name: "own_posts_only",
  effect: "allow",
  action: "read",
  resource: "posts",
  condition: {
    sql: "{{current_user}} = posts.user_id"
  }
};

​
Next Steps