Click here to view and discuss this page in DocCommentXchange. In the future, you will be sent there automatically.

SAP SQL Anywhere, on-demand edition 1.0 SP 6 » Task syntax

ForgetServer task

Removes the metadata of a cloud server.

Syntax 1 (SQL)
CALL DBCloud.ForgetServer ( server=server [, optional-parameters ] )
Syntax 2 (Cloud Command utility)
dbcloudcmd run ForgetServer server [ optional-parameters ]
Parameters
  • server

    The cloud server to forget. Accepts a search query that identifies one cloud server, for example a cloud server name or ID. (Required)

  • unconditionally

    Set to 1 to forget the dependent objects when forgetting the cloud server. If a dependent object exists, setting to 0 returns an error. The default is 0.

Required privileges

Administrator

Remarks

If unconditionally is set to 0, it returns an error if a database copy is running on the cloud server. If unconditionally is set to 1, it forgets the target cloud server as well as the database copies running on the cloud server.

Forgetting a cloud object should only be done if repairing the object fails, and the object cannot be dropped from the cloud.

If the specified cloud server is running a primary or mirror database, then the remaining partner is not forgotten; however, the tenant database is no longer running as a mirroring system. If the specified cloud server is running a database that is not mirrored but is running as a read-only scale-out system, then the scale-out database copies are also forgotten.

When possible, cloud servers should be removed from the cloud using the DropServer task. The DropServer task removes system resources (files, directories, and processes), and the cloud server's metadata from the cloud. The ForgetServer task should be used only when the DropServer task cannot be used. The ForgetServer task does not attempt to remove or update system resources.

Since the ForgetServer task does not delete data files, you may want to delete data files from the cloud data directory to ensure that subsequent cloud operations are not affected.

Example

Run the following task to remove the metadata of the cloud server my-server#1:

dbcloudcmd run ForgetServer server=my-server#1