Calling functions via RPC in Supabase

Introduction

Calling functions via RPC lets you run custom code on your database easily. It helps you get or change data with special logic.

You want to run a custom query that is too complex for simple filters.

You need to reuse a piece of database logic from different parts of your app.

You want to keep your app code simple by moving logic to the database.

You want to securely run operations that only the database should handle.

You want to call a stored procedure that returns specific data.

Syntax

Supabase

const { data, error } = await supabase.rpc('function_name', { param1: value1, param2: value2 });

Use the rpc method on your Supabase client to call a database function.

Pass the function name as a string and an object with parameters matching the function's inputs.

Examples

Calls a function named get_user_by_id with one parameter user_id.

Supabase

const { data, error } = await supabase.rpc('get_user_by_id', { user_id: 123 });

Calls calculate_discount with two parameters to get a discounted price.

Supabase

const { data, error } = await supabase.rpc('calculate_discount', { price: 100, discount_rate: 0.2 });

Sample Program

This example shows how to call a stored function get_user_name that takes a user_id and returns the user's name. It handles errors and prints the result.

Supabase

import { createClient } from '@supabase/supabase-js';

const supabaseUrl = 'https://xyzcompany.supabase.co';
const supabaseKey = 'public-anonymous-key';
const supabase = createClient(supabaseUrl, supabaseKey);

async function getUserName(userId) {
  const { data, error } = await supabase.rpc('get_user_name', { user_id: userId });
  if (error) {
    console.error('Error calling RPC:', error.message);
    return null;
  }
  return data;
}

getUserName(42).then(name => {
  if (name) {
    console.log('User name is:', name);
  } else {
    console.log('User not found or error occurred.');
  }
});

Important Notes

Make sure the function exists in your database and the parameters match exactly.

RPC calls run on the database server, so they can be faster and more secure for complex logic.

Always handle errors to avoid crashes in your app.

Summary

RPC lets you run custom database functions from your app.

Use supabase.rpc() with the function name and parameters.

It helps keep your app simple and your logic secure in the database.

Practice

1. What does supabase.rpc() do in a Supabase app?

easy

A. Creates a new table in the database

B. Uploads files to storage

C. Fetches user authentication details

D. Calls a custom database function remotely

Solution

1. Step 1: Understand the purpose of supabase.rpc()

   This method is designed to call remote procedure calls (RPC), which are custom functions defined in the database.

2. Step 2: Identify what supabase.rpc() does in the app context

   It runs these custom functions securely from the app, allowing logic to stay in the database.

3. Final Answer:

   Calls a custom database function remotely -> Option D

4. Quick Check:

   RPC calls = custom database functions [OK]

Hint: RPC means running database functions remotely [OK]

Common Mistakes:

• Confusing RPC with file uploads
• Thinking it creates tables
• Assuming it handles user login

2. Which is the correct way to call a function named get_user_data with parameter { user_id: 5 } using Supabase RPC?

easy

A. supabase.rpc('get_user_data', { user_id: 5 })

B. supabase.call('get_user_data', 5)

C. supabase.function('get_user_data', { id: 5 })

D. supabase.execute('get_user_data', user_id=5)

Solution

1. Step 1: Recall the syntax of supabase.rpc()

   The method takes the function name as a string and an object with parameters.

2. Step 2: Match the correct syntax with the options

   supabase.rpc('get_user_data', { user_id: 5 }) correctly uses supabase.rpc('function_name', { params }) format.

3. Final Answer:

   supabase.rpc('get_user_data', { user_id: 5 }) -> Option A

4. Quick Check:

   Correct RPC call syntax = supabase.rpc('get_user_data', { user_id: 5 }) [OK]

Hint: Use rpc('function', {params}) format [OK]

Common Mistakes:

• Using wrong method names like call or execute
• Passing parameters as separate arguments
• Using incorrect parameter keys

3. Given this code snippet:

const { data, error } = await supabase.rpc('multiply', { a: 3, b: 4 });
console.log(data);

What will be printed if the multiply function returns the product of a and b?

medium

A. 7

B. 12

C. undefined

D. Error

Solution

1. Step 1: Understand the function call and parameters

   The function multiply is called with a=3 and b=4.

2. Step 2: Calculate the expected return value

   Since the function returns the product, 3 * 4 = 12.

3. Final Answer:

   12 -> Option B

4. Quick Check:

   3 times 4 = 12 [OK]

Hint: Multiply parameters to find output [OK]

Common Mistakes:

• Adding instead of multiplying
• Assuming no return value
• Confusing data with error

4. You wrote this code:

const { data, error } = await supabase.rpc('get_user', { user_id: 10 });
console.log(data);

But you get an error saying the function does not exist. What is the likely cause?

medium

A. Parameters must be passed as an array, not an object

B. You forgot to import supabase client

C. The function name is misspelled or missing in the database

D. RPC calls do not support parameters

Solution

1. Step 1: Analyze the error message

   The error says the function does not exist, indicating a problem with the function name or its presence in the database.

2. Step 2: Check common causes for missing function errors

   Usually, the function is either misspelled or not created in the database schema.

3. Final Answer:

   The function name is misspelled or missing in the database -> Option C

4. Quick Check:

   Function missing error = wrong or absent function [OK]

Hint: Check function spelling and existence in DB [OK]

Common Mistakes:

• Passing parameters incorrectly
• Assuming import errors cause this
• Thinking RPC disallows parameters

5. You want to create a Supabase RPC call to get the total sales for a given store_id. The database function is named total_sales and takes store_id as input. Which code snippet correctly calls this function and handles errors?

hard

A. const { data, error } = await supabase.rpc('total_sales', { store_id }); if (error) console.error(error); else console.log(data);

B. const result = supabase.call('total_sales', store_id); console.log(result);

C. const { data } = await supabase.rpc('total_sales', store_id); console.log(data);

D. const { data, error } = supabase.rpc('total_sales', { store: store_id }); if (error) throw error; else console.log(data);

Solution

1. Step 1: Identify correct RPC call syntax with parameters

   The function name is 'total_sales' and parameters must be passed as an object with key matching the function input, here { store_id }.

2. Step 2: Check error handling and async usage

   const { data, error } = await supabase.rpc('total_sales', { store_id }); if (error) console.error(error); else console.log(data); uses await, destructures data and error, and handles error properly with console.error.

3. Final Answer:

   const { data, error } = await supabase.rpc('total_sales', { store_id }); if (error) console.error(error); else console.log(data); -> Option A

4. Quick Check:

   Correct RPC call with error check = const { data, error } = await supabase.rpc('total_sales', { store_id }); if (error) console.error(error); else console.log(data); [OK]

Hint: Use await, pass params as object, check error [OK]

Common Mistakes:

• Passing parameters incorrectly (not as object)
• Ignoring error handling
• Using wrong method names like call