SurrealDB Docs Logo

Enter a search query

Back to home

Enter a search query

SDK methodsrun

->run()

Runs a defined SurrealQL function on the remote database.

Method Syntax
$db->run($function, $version, $params);

Arguments

ArgumentsTypeDescription
$function requiredstring

The name of the function to run.

$version optional

string or null

The version of the function to run.

$params optional

array or null

An array of parameters to pass to the function.

Example

Example
$functionA = $db->run("fn::hello_world", null, ["Tobie"]);
$functionB = $db->run("fn::hello_world", "v1", ["Tobie"]);

// or with named arguments
$functionA = $db->run("fn::hello_world", params: ["Tobie"]);
$functionB = $db->run("fn::hello_world", version: "v1", params: ["Tobie"]);
Edit this page on GitHub
queryRawselect