UnloadSchema

Unload a schema.

URL

/icCube/api/console/admin/UnloadSchema

Parameters

Name Type Cardinality Default value
schemaName  string  one   
waitS  number  zero-one   
cancelS  number  zero-one   

Return (Payload)

{
    "schemaName" : "Sales",
    "status"     : "UNLOADED"
}

Description


This request unloads a schema. Note that the schema definition remains deployed on the server for further loads.

On completion, the response contains the status of the operation. Refer to this page for more details about it.

The optional waitS and cancelS parameters allows for cancelling ongoing requests. A lengthy request might prevent the actual load (e.g. incremental load, re-load, etc..) of the schema. Unless specified otherwise loading a schema (or partitions) is performed in two steps. The first step is loading the required data and the second step is actually updating the already loaded schema. The first step can be performed in parallel of ongoing MDX requests but the second step requires no more requests are accessing the schema. Therefore, the load is stuck until all requests are completed. These two parameters allows for cancelling the requests before the second step is performed. Before the second step, icCube waits for waitS seconds, then if it cancels the ongoing requests (if any) and waits for cancelS seconds. Then if there is still some ongoing requests the load fails otherwise icCube proceed with the second step.

This request does nothing if the schema is not loaded.

See Also

LoadSchema