DBMS_TELEMETRY_WORKSPACE

The DBMS_TELEMETRY_WORKSPACE package provides a collection of administration procedures to create and manage workspaces in Oracle AI Database Telemetry Streaming.

This chapter contains the following topics:

DBMS_TELEMETRY_WORKSPACE Overview

Any user with the Oracle database administrator (Oracle DBA) privileges can perform workspace management. The workspace management APIs are implemented using the DBMS_TELEMETRY_WORKSPACE package, which enables the Oracle DBA to create a Oracle AI Database Telemetry Streaming workspace, and add and manage workspace administrators for each workspace.

See Also: User Roles and Privileges and Managing a Workspace for more information about Oracle AI Database Telemetry Streaming workspaces.

DBMS_TELEMETRY_WORKSPACE Security Model

Using the DBMS_TELEMETRY_WORKSPACE package, the Oracle DBA can create and manage workspaces. Additionally, the Oracle DBA can use DBMS_TELEMETRY_WORKSPACE to enable or disable an existing database user as an administrator of a workspace.

Summary of DBMS_TELEMETRY_WORKSPACE Subprograms

This table lists and briefly describes the DBMS_TELEMETRY_WORKSPACE package subprograms.

Table 1 DBMS_TELEMETRY_WORKSPACE Package

Subprogram	Description
CREATE_WORKSPACE Procedure	Creates a Oracle AI Database Telemetry Streaming workspace
DROP_WORKSPACE Procedure	Drops a Oracle AI Database Telemetry Streaming workspace
ENABLE_WORKSPACE_ADMIN Procedure	Adds a user with the workspace administrator role to a Oracle AI Database Telemetry Streaming workspace
DISABLE_WORKSPACE_ADMIN Procedure	Removes a user with the workspace administrator role from a Oracle AI Database Telemetry Streaming workspace

CREATE_WORKSPACE Procedure

This procedure adds a workspace to Oracle AI Database Telemetry Streaming.

This procedure is used by the Oracle DBA user to create a workspace in Oracle AI Database Telemetry Streaming.

Syntax

create_workspace(workspace_name  VARCHAR2,
                 tablespace_name VARCHAR2);

Parameters

Table 2 CREATE_WORKSPACE Procedure

Parameter Description

Parameter	Description
`workspace_name`	Name of the workspace with a maximum of 125-character length The name of the workspace can be any valid database username and can contain non-ASCII characters.
`tablespace_name`	The default tablespace to be used for this workspace

workspace_name

Name of the workspace with a maximum of 125-character length

The name of the workspace can be any valid database username and can contain non-ASCII characters.

tablespace_name The default tablespace to be used for this workspace

Note: Each workspace is backed by an exclusive schema. The schema name is derived by prefixing the workspace name with TM$.

DROP_WORKSPACE Procedure

This procedure drops a workspace from Oracle AI Database Telemetry Streaming.

This procedure is used by the Oracle DBA to drop a workspace from Oracle AI Database Telemetry Streaming.

Syntax

drop_workspace(
            workspace_name VARCHAR2,
            force          BOOLEAN default false);

Parameters

Table 3 DROP_WORKSPACE Procedure

Parameter	Description
`workspace_name`	Name of the workspace to be dropped
`force`	Default is `false`. If `true` then all the users associated with the workspace are removed.

ENABLE_WORKSPACE_ADMIN Procedure

This procedure enables a user with the Oracle DBA role to add an existing database user as a workspace administrator of a Oracle AI Database Telemetry Streaming workspace.

Syntax

ENABLE_WORKSPACE_ADMIN(
         workspace_name VARCHAR2,
         admin_user     VARCHAR2);

Parameters

Table 4 ENABLE_WORKSPACE_ADMIN

Parameter Description

workspace_name Name of the workspace for which a workspace administrator needs to be enabled

Parameter	Description
`workspace_name`	Name of the workspace for which a workspace administrator needs to be enabled
`admin_user`	Name of an already existing database user who needs to be enabled as an administrator for the workspace The name of the workspace can be any valid database username and can contain non-ASCII characters.

admin_user

Name of an already existing database user who needs to be enabled as an administrator for the workspace

The name of the workspace can be any valid database username and can contain non-ASCII characters.

Note: Multiple workspaces can have the same workspace administrators (admin_user) and same workspace can have multiple workspace administrators.

DISABLE_WORKSPACE_ADMIN Procedure

This procedure disables a user with the workspace administrator role in a Oracle AI Database Telemetry Streaming workspace.

Syntax

DISABLE_WORKSPACE_ADMIN(
         workspace_name VARCHAR2,
         admin_user     VARCHAR2);

Parameters

Table 5 DISABLE_WORKSPACE_ADMIN

Parameter	Description
`workspace_name`	Name of the workspace from which a workspace administrator needs to be disabled
`admin_user`	Name of the workspace administrator who needs to be disabled