Interface AdminResult

On-premises only.

AdminResult object is the result of adminDDL, adminStatus and may also be the result of forCompletion methods. It encapsulates the state of admin DDL operation (see adminDDL).

Some operations initiated by adminDDL are performed by the service asynchronously so that getting result from adminDDL does not imply operation completion. In this case you may call forCompletion to be notified when the operation is completed by the service. You may also call adminStatus to receive current status of the operation. Other operations are immediate and are completed when result from adminDDL is returned.

You may distinguish these types of operations in the following way:

  • Asynchronous operations may return a non-null operationId.
  • Asynchronous operations modify system state, while immediate operations are read-only.
  • Result returned by adminDDL for immediate operations has state COMPLETE and has a non-null output.

Hierarchy

  • AdminResult

Properties

operationId? output? state statement

Properties

Optional Readonly operationId

operationId?: string

Operation id of the operation that returned this result, if this result is returned by adminDDL and the operation is performed by the service asynchronously. It is used when this AdminResult is subsequently passed to forCompletion or adminStatus as the first parameter to identify the operation and check for any errors from that operation.

Optional Readonly output

output?: string

The output of the operation as a string. It is defined for read-only immediate operations such as SHOW operations and is undefined for operations that modify system state and are performed by the service asynchronously such as CREATE, DROP, GRANT, etc.

Readonly state

state: AdminState

Current state of the operation, which is either complete or in-progress, see AdminState.

Readonly statement

statement: string

Statement for the operation.

Settings

Member Visibility

Theme

Generated using TypeDoc