Stored Procedures: rpc()

You can call stored procedures as a "Remote Procedure Call".

That's a fancy way of saying that you can put some logic into your database then call it from anywhere. It's especially useful when the logic rarely changes - like password resets and updates.

const { data, error } = await supabase
.rpc('hello_world')
}

Parameters

  • fnrequiredstring

    The function name to call.

  • paramsoptionalundefined | object

    The parameters to pass to the function call.

  • __namedParametersrequiredobject

    No description provided.

      Properties

    • countrequirednull | exact | planned | estimated

      Count algorithm to use to count rows in a table.

Examples

Call a stored procedure

This is an example invoking a stored procedure.

const { data, error } = await supabase
.rpc('hello_world')
}

With Parameters

const { data, error } = await supabase
.rpc('echo_city', { name: 'The Shire' })
}

Bulk call

const { data, error } = await supabase
.rpc('echo_city', [
{ name: 'The Shire' },
{ name: 'Mordor' }
])
}

With filters.

Stored procedures that return tables can also be combined with Modifiers and Filters.

const { data, error } = await supabase
.rpc('echo_all_cities')
.eq('name', 'The Shire')

With count option

You can specify a count option to get the row count along with your data. Allowed values for count option are null, exact, planned and estimated.

const { data, error, count } = await supabase
.from('cities')
.rpc('hello_world', { count: 'exact' })
}
Edit this page