StoredFunction

interface StoredFunction

Methods

listFunctions

List functions in the database.

public listFunctions(bool $includeParameters): array

Returns: array

Parameters

Parameter	Type	Description
$includeParameters	bool

functionExists

Check if a function exists in the database.

public functionExists(string $functionName, ?string $argTypes): bool

Returns: bool

Parameters

Parameter	Type	Description
$functionName	string
$argTypes	string

describeFunction

Describe a function in the database.

public describeFunction(string $name): array|false

Returns: array|false

Parameters

Parameter	Type	Description
$name	string

createFunction

Create a function in the database.

public createFunction(string $name, array $spec, bool $replace): bool

Returns: bool

Parameters

Parameter	Type	Description
$name	string
$spec	array
$replace	bool

dropFunction

Drop a function from the database.

public dropFunction(string $name, array|string|null $argTypes, bool $cascade, bool $ifExists): bool

Returns: bool

Parameters

Parameter	Type	Description
$name	string
$argTypes	array	string
$cascade	bool
$ifExists	bool

---

Generated by Hazaar API Doc Generator on Fri, 04 Sep 2026 23:32:16 +0000