Load or unload a table
Modifies the state of a table to loaded or unloaded. Returns loaded or unloaded to indicate the state after the operation.
| Name | Type | Required | Description |
|---|---|---|---|
caslibName | string | true | The Caslib name containing the table whose state should be modified. |
serverName | string | true | Server name containing the table whose state is being modified. |
tableName | string | true | The table name whose state is being modified. |
| Name | Type | Required | Description |
|---|---|---|---|
scope | string | false | When value=loaded, the optional scope to which to load the table. Valid values include global and session. Defaults to global. If specified at the same time as a casLoadRequest body containing a scope setting, the casLoadRequest scope will override the value specified on this query parameter. |
sessionId | string | false | Session ID containing the table. |
sourceTableName | string | false | The source file or table name from which to load the CAS table. If not specified: For path-based caslibs, the source file used will be the first matching .sashdat, .sas7bdat, .parquet or .csv file found, in that order, independent of case. For non-path-based caslibs (such as DBMS libraries), the source table used will be the first matching source table name found, independent of case. |
value | string | true | State to which to set the table. Valid values include loaded or unloaded. |
Optional body, providing greater control over the output when a state change to loaded is requested. In general, state changes will not require this body, and should be performed sending an empty body. When an empty body is submitted, the service will change state of referenced table in the library in which it resides.
Inputs when loading a source table or file to a CAS table.
| Name | Type | Required | Description |
|---|---|---|---|
copies | integer | false | Number of copies to create in memory. Defaults to 1. |
label | string | false | Label to use on the output table. |
outputCaslibName | string | true | Name of the output caslib to which the source table or external file will be loaded. If not specified, defaults to the caslib name containing the table to be loaded. |
outputTableName | string | true | Name of the output CAS table. If not specified, defaults to the same name as the table being loaded. |
parameters | object | false | A name and value pair map of additional parameters to pass when performing the load. These parameters generally are passed directly to the Caslib source as part of the load operation and are specific to the source type. Exceptions include the following parameters, which are passed directly to the load operation: * importOptions * groupBy * orderBy * vars See the CAS action documentation for loadTable for more information about the valid parameter values. |
replace | boolean | false | If true, any pre-existing table with the same name is replaced. Defaults to false. Note that already-loaded global tables cannot be replaced. |
replaceMode | string | false | When replace is true, the replace mode to use when the table is already at loaded state. Valid values include: * always - always replace * newer - replace only if the source table is newer than the last time the table was loaded If omitted, defaults to always. |
scope | string | false | Scope to which to load the table. Valid values include \session\ and \global. Defaults to \global. |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | The requested action was successful. The state is returned. Valid values are loaded and unloaded. | ||
| 400 | Bad Request | The request was invalid. | Schema | |
| 404 | Not Found | The requested CAS server or Caslib does not exist. | ||
| 409 | Conflict | The request could not be completed due to a conflict with the current state of the resource. Details are included in the response body. |