StoredFunction
Less than 1 minute
StoredFunction
Methods
listFunctions
List defined functions.
public listFunctions(bool $includeParameters = false): void
Parameters
Parameter | Type | Description |
---|---|---|
$includeParameters | bool |
functionExists
public functionExists(string $functionName, ?string $argTypes): bool
Parameters
Parameter | Type | Description |
---|---|---|
$functionName | string | |
$argTypes | string |
describeFunction
public describeFunction(string $name, ?string $schemaName, false $): void
Parameters
Parameter | Type | Description |
---|---|---|
$name | string | |
$schemaName | string | |
$ | false |
createFunction
Create a new database function.
public createFunction(string $name, mixed $spec, bool $replace = false): bool
Parameters
Parameter | Type | Description |
---|---|---|
$name | string | The name of the function to create |
$spec | mixed | A function specification. This is basically the array returned from describeFunction() |
$replace | bool |
dropFunction
Remove a function from the database.
public dropFunction(string $name, string $argTypes, bool $cascade = false, bool $ifExists = false): bool
Parameters
Parameter | Type | Description |
---|---|---|
$name | string | The name of the function to remove |
$argTypes | string | the argument list of the function to remove |
$cascade | bool | Whether to perform a DROP CASCADE |
$ifExists | bool |
Generated by Hazaar API Doc Generator