SYSIBMADM.STORAGE_ACCESS_ALIAS.UNCATALOG procedure

The SYSIBMADM.STORAGE_ACCESS_ALIAS.UNCATALOG stored procedure deletes an alias for accessing remote storage on IBM Cloud Object Storage or Amazon Simple Storage Service (S3).

Functionality mirrors that of the UNCATALOG STORAGE ACCESS ALIAS CLP command.

Authorization

Any user with EXECUTE privilege on the module SYSIBMADM.STORAGE_ACCESS_ALIAS will have permission to call the UNCATALOG stored procedure.

The user must also have DBADM authority on the database to successfully uncatalog an alias and the alias cannot be associated with a different database.

Syntax

Read syntax diagramSkip visual syntax diagramSTORAGE_ACCESS_ALIAS.UNCATALOG(alias-name)

Parameter description

alias-name
An input argument of type VARCHAR(128) that specifies the name of the alias to uncatalog.

Usage Notes

It is recommended to run HCAT_CACHE_SYNC after uncataloging a storage access alias to ensure that the Big SQL scheduler cache has been cleared. For more information, see Big SQL scheduler.

Attempting to use a storage access alias after it has been uncataloged, the following error may occur:
Failed to open input stream for file: <file-location>

as opposed to an error message indicating that the storage alias does not exist.

This is due to the fact that while the credentials to access the storage have been deleted, an internal cache listing the storage access aliases has not been updated yet. This message is harmless and the data on the storage is effectively not accessible anymore, as was intended by the uncataloging of the storage access alias. The message will revert to a message indicating that the storage alias does not exist the next time the instance is restarted.

Examples

  • Example of usage format:
    call SYSIBMADM.STORAGE_ACCESS_ALIAS.UNCATALOG(alias-name)
  • Delete the alias named 'product_info' by running the following command:
    call SYSIBMADM.STORAGE_ACCESS_ALIAS.UNCATALOG('product_info');