admin_offline - Kinetica Docs

admin_offline

admin_offline(
offline: boolean,
options?: Record<string, string>,
callback?: GPUdbCallback,
): Promise<AdminOfflineResponse>
Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.
Parameters
- offline: boolean
  Set to true if desired state is offline.
- Optionaloptions: Record<string, string>
  Optional parameters.
- Optionalcallback: GPUdbCallback
  Optional callback function
Returns Promise<AdminOfflineResponse>
Promise<Types.AdminOfflineResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:2103

admin_offline_request

admin_offline_request(
request: AdminOfflineRequest,
callback?: GPUdbCallback,
): Promise<AdminOfflineResponse>
Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.
Parameters
- request: AdminOfflineRequest
  Request object containing the parameters for the operation
- Optionalcallback: GPUdbCallback
  Optional callback function
Returns Promise<AdminOfflineResponse>
Promise<Types.AdminOfflineResponse> - Promise resolving to the response
- Defined in src/GPUdb.ts:2079