HAddScheduledOptimization (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / Managing databases / HFSQL / HFSQL Client/Server functions

Necessary rights

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HAddScheduledOptimization (Function)

In french: HAjouteOptimisationPlanifiée

Available only with this kind of connection

Adds an optimization task of HFSQL Client/Server data files.

Example

// Recalculate the statistics for the files found in "MyDatabase", 
// every Saturday at 23:00
Optim is hScheduledOptimization
Optim.Description = "Recalculating the statistics for the files found in the MyDatabase database"
Optim.Scheduling.Month = "*"
Optim.Scheduling.DayOfWeek = "Saturday"
Optim.Scheduling.Hour = "23"
Optim.Scheduling.Minute = "0"
Optim.File[1].Name = "MaBase"
Optim.File[1].Option = hOptStat
HAddScheduledOptimization(MyConnection, Optim)

Syntax

<Result> = HAddScheduledOptimization(<Connection> , <Scheduled optimization task>)

<Result>: Boolean

True if the scheduled optimization task was added
False if an error occurs. HErrorInfo is used to identify the error.

<Connection>: Character string or Connection variable

Connection for which a scheduled optimization task will be added. This connection corresponds to:
the name of the connection defined in the data model editor or with HDescribeConnection or HOpenConnection.
the name of a variable of type Connection.

<Scheduled optimization task>: hScheduledOptimization variable

Name of the hScheduledOptimization variable used.

Remarks

Necessary rights

To add a scheduled optimization task, you must have:

the corresponding rights (hRightsManageTask constant) on the server,
the rights to connect (hRightsConnection or hRightsEncryptedConnection) to each relevant database,
the rights to run the command linked to the scheduled optimization task.

The task will be run with the account of user who created the task.

For full server optimization, the user must be a superuser.

Note: If the server is off, the scheduled optimization task will not be performed. The scheduled optimization task will be performed at the next available date when the server is switched on.

To find out whether these rights are granted to a user or to a group, use HInfoServerRights or HInfoDatabaseRights.

To modify the rights granted to a user or group of users, use HModifyServerRights or HModifyDatabaseRights.

Component: wd300hf.dll