Oracle Cloud Infrastructure Documentation

Manage Autonomous Database Built-in Tools

Autonomous Database includes built-in tools that you can enable and disable when you provision or clone a database, or at any time for an existing database.

Parent topic: Manage the Service

About Autonomous Database Built-in Tools

Provides a complete list of Autonomous Database built-in tools and a description of each tool.

Tool Description
Oracle APEX

Oracle APEX is a low-code development platform that you can use to build scalable, secure enterprise applications that can be deployed anywhere.

See Create Applications with Oracle APEX in Autonomous Database for more information.

Database Actions

Oracle Database Actions is a web-based interface that uses Oracle REST Data Services to provide development, data tools, administration and monitoring features for Oracle Autonomous Database.

See Connect with Built-In Oracle Database Actions for more information.

Graph Studio

Graph Studio automates the creation of knowledge (RDF) and property graphs and includes interactive tooling for query, analysis, and visualization of these graphs in the Autonomous Database. You must log in as a graph-enabled user to access Graph Studio. Create this user in Database Actions.

See Using Oracle Graph with Autonomous Database for more information.

Oracle ML User Interface

Oracle Machine Learning User Interface provides immediate access to the Oracle Machine Learning components and functionality on Autonomous Database, including OML Notebooks, OML AutoML UI, OML Models, and template example notebook. This includes:

Data Transforms

Oracle Data Transforms allows you to design graphical data transformations in the form of data flows and workflows. The data flows define how the data is moved and transformed between different systems, while the workflows define the sequence in which the data flows run.
Web Access (ORDS)

Oracle REST Data Services (ORDS) provides HTTPS interfaces for working with the contents of your Oracle Database in one or more REST enabled schema

See Develop with Oracle REST Data Services on Autonomous Database for more information.

MongoDB API

Oracle Database API for MongoDB enables MongoDB-compatible clients and drivers to connect directly to Autonomous Database.

See Using Oracle Database API for MongoDB for more information.

SODA Drivers

Simple Oracle Document Access (SODA) is a set of APIs that let you work with JSON documents managed by the Oracle Database without needing to use SQL. SODA drivers are available for REST, Java, Node.js, Python, PL/SQL, and C.

See Use SODA for REST with Autonomous Database for more information.

Parent topic: Manage Autonomous Database Built-in Tools

About Configuring Built-in Tools Compute Resource Limits

When your Autonomous Database instance is using the ECPU compute model, some built-in tools have compute resource limits. Optionally you can configure the compute resource limits for these tools.

For several built-in tools, the ECPU count and Maximum idle time configuration options let you specify resource allocation for the VMs that run the associated built-in tool. When you configure a built-in tool, the values for these configuration options mean the following in terms of resource usage and billing:

  • You do not pay for a tool's ECPU allocation if you do not use the tool.

  • The VMs associated with a tool are provisioned when you start using a tool. For example, if Graph Studio is disabled, billing does not begin when you enable the tool. Billing begins when you start using the Graph Studio.

  • The ECPU count specifies the CPU allocation that is dedicated to the tool. The value you enter for ECPU count applies in addition to the database ECPU count you specify for the instance. After you start using a tool with a specified ECPU count, you are billed per ECPU hour reserved from the time the built-in Tool is launched.

  • Billing stops for a built-in tool's allocated ECPUs when the built-in tool is disabled, the instance stops or is terminated, or when the built-in tool is idle for more than the specified Maximum idle time.

    The default maximum idle times depend on the tool:

    Built-in Tool Default Maximum Idle Time (Minutes)

    Graph Studio

    240

    Oracle Machine Learning User Interface

    60

    Data Transforms

    10

View Autonomous Database Built-in Tools Status

Describes the steps to view the status of built-in tools on your Autonomous Database instance.

Perform the following prerequisite steps as necessary:

  • Open the Oracle Cloud Infrastructure Console by clicking the navigation icon next to Oracle Cloud.

  • From the Oracle Cloud Infrastructure left navigation menu click Oracle Database and then, depending on your workload click one of: Autonomous Data Warehouse, Autonomous JSON Database, or Autonomous Transaction Processing.

  • On the Autonomous Databases page select an Autonomous Database from the links under the Display name column.

  1. Navigate to the Autonomous Database details page.
  2. Select the Tool configuration tab.

    This displays the tools configuration details and status.

    Description of adb_tools_status.png follows

If your Autonomous Database instance is on a private endpoint and you enable the Allow public access option, the tools tab shows both a Private access URL and a Public access URL. The Private access URL provides the URL to access a tool from within the VCN where the database resides. The Public access URL provides the URL to access a tool from the public internet, to provide access from allowed public IPs or from allowed public VCNs. See Use a Private Endpoint with Public Access Allowed for more information.

For example:

Description of adb_tools_status_private_public.png follows

Configure Autonomous Database Built-in Tools

You can enable or disable Autonomous Database built-in tools for an existing Autonomous Database instance. In addition, with the ECPU compute model you can configure limits for the number of ECPUs and the idle time allowed for several of the built-in tools.

Parent topic: Manage Autonomous Database Built-in Tools

Configure Autonomous Database Built-in Tools (ECPU compute model)

Describes how to enable or disable Autonomous Database built-in tools for an existing Autonomous Database instance.

Tool status is retained across starts and restarts for an Autonomous Database instance. For example, if a tool is disabled before you stop or restart an instance, the tool maintains the same status (disabled) after a start or restart.

Perform the following prerequisite steps as necessary:

  • Open the Oracle Cloud Infrastructure Console by clicking the navigation icon next to Oracle Cloud.

  • From the Oracle Cloud Infrastructure left navigation menu click Oracle Database and then, depending on your workload click one of: Autonomous Data Warehouse, Autonomous JSON Database, or Autonomous Transaction Processing.

  • On the Autonomous Databases page select an Autonomous Database from the links under the Display name column.

  1. On the Autonomous Database details page, select the Tool configuration tab.
  2. Click Edit tool configuration.
  3. Select or deselect in the Enable tool field to enable or disable a tool.
  4. (Optional) When enabled, Graph Studio, Oracle Machine Learning User Interface, and Data Transforms provide default ECPU count and Maximum idle count values and let you configure these values.

    Change the ECPU count value if you want to provide more or less resources for a built-in tool.

    Change the Maximum idle time value to specify the time, in minutes, after which an idle Graph Studio, Data Transforms, or Oracle Machine Learning VM is terminated.

    See About Configuring Built-in Tools Compute Resource Limits for more information.

  5. Click Apply to apply your changes.
    Description of adb_tools_configure_ecpu.png follows

The Lifecycle State changes to Updating. When the request completes, the Lifecycle State shows Available.

Configure Autonomous Database Built-in Tools (OCPU compute model)

Describes how to enable or disable Autonomous Database built-in tools for an existing Autonomous Database instance.

Tool status is retained across starts and restarts for an Autonomous Database instance. For example, if a tool is disabled before you stop or restart an instance, the tool maintains the same status (disabled) after a start or restart.

Perform the following prerequisite steps as necessary:

  • Open the Oracle Cloud Infrastructure Console by clicking the navigation icon next to Oracle Cloud.

  • From the Oracle Cloud Infrastructure left navigation menu click Oracle Database and then, depending on your workload click one of: Autonomous Data Warehouse, Autonomous JSON Database, or Autonomous Transaction Processing.

  • On the Autonomous Databases page select an Autonomous Database from the links under the Display name column.

  1. On the Autonomous Database details page, select the Tool configuration tab.
  2. Click Edit tool configuration.
  3. Select or deselect in the Enable tool field to enable or disable a tool.
  4. Click Apply to apply your changes.
    Description of adb_tools_configure.png follows

The Lifecycle State changes to Updating. When the request completes, the Lifecycle State shows Available.

Configure Autonomous Database Built-in Tools when you Provision or Clone an Instance

During provisioning or when you clone an instance, you can enable or disable Autonomous Database built-in tools.

Parent topic: Manage Autonomous Database Built-in Tools

Configure Autonomous Database Built-in Tools when you Provision or Clone an Instance (ECPU compute model)

Describes how to enable or disable Autonomous Database built-in tools when you provision or clone an instance.

When you are cloning, note the following:

  • When you are cloning and you select Full Clone or Metadata Clone, the built-in tools default settings are based on the defaults for the workload type of the clone. In this case, the defaults are not based on source database built-in tools settings.

  • When you are cloning and you select Refreshable Clone, the refreshable clone inherits the built-in tool status from the source database. Editing the built-in tool status for refreshable clone is not be possible during or after provisioning. If the source database of refreshable clone changes its tool configuration, this is reflected in the refreshable clone after the next refresh.

Perform the steps to provision or clone an instance:

  1. Click Show advanced options to select advanced options.
  2. In advanced options, select the Tools tab.
  3. Click Edit tool configuration.
  4. Select or deselect a tool in the Enable tool field to enable or disable the tool.
  5. (Optional) When enabled, Graph Studio, Oracle Machine Learning User Interface, and Data Transforms provide default ECPU count and Maximum idle count values and let you configure these values.

    Change the ECPU count value if you want to provide more or less resources for a built-in tool.

    Change the Maximum idle time value to specify the time, in minutes, after which an idle Graph Studio, Data Transforms, or Oracle Machine Learning VM is terminated.

    See About Configuring Built-in Tools Compute Resource Limits for more information.

  6. Click Apply to apply the configuration changes and return to the provision or clone steps.
    Description of adb_provision_clone_builtin_tools_ecpu.png follows

Configure Autonomous Database Built-in Tools when you Provision or Clone an Instance (OCPU compute model)

Describes how to enable or disable Autonomous Database built-in tools when you provision or clone an instance

When you are cloning, note the following:

  • When you are cloning and you select Full Clone or Metadata Clone, the built-in tools default settings are based on the defaults for the workload type of the clone. In this case, the defaults are not based on source database built-in tools settings.

  • When you are cloning and you select Refreshable Clone, the refreshable clone inherits the built-in tool status from the source database. Editing the built-in tool status for refreshable clone is not be possible during or after provisioning. If the source database of refreshable clone changes its tool configuration, this is reflected in the refreshable clone after the next refresh.

Perform the steps to provision or clone an instance:

  1. Click Show advanced options to select advanced options.
  2. In advanced options, select the Tools tab.
  3. Click Edit tool configuration.
  4. Select or deselect a tool in the Enable tool field to enable or disable the tool.
  5. Click Apply to apply the configuration changes and return to the provision or clone steps.
    Description of adb_provision_clone_builtin_tools.png follows

Notes for Autonomous Database Built-in Tools

Provides additional Autonomous Database built-in tools notes and lists differences that apply depending on the workload type of your Autonomous Database instance.

  • Disabling ORDS affects built-in tools such as Database Actions, APEX, and MongoDB API. Therefore, if you disable ORDS, this also disables APEX, Database Actions, and MongoDB API.

  • When ORDS is disabled, Database Actions, APEX, and MongoDB API are disabled. If you subsequently enable ORDS this does not automatically enable APEX, Database Actions, or the MongoDb APIs. You must manually enable each built-in tool that is dependent on ORDS. Enable ORDS first, then you can enable APEX, Database Actions, or the MongoDB APIs

  • Always Free Autonomous Database does not provide configuration options for Autonomous Database tools and does not allow you to enable or disable Autonomous Database tools.

  • By default when you provision an Autonomous Database with Autonomous Data Warehouse or Autonomous Transaction Processing workload types, the MongoDB API is disabled. If MongoDB API is disabled, you can enable it during provisioning or cloning, or in an existing database.

    You can enable MongoDB API only if you have an ACL or if you are on a private endpoint. See Configure Access for MongoDB for more information.

  • For JSON Database, Graph Studio is not supported and enabling or disabling Graph Studio for JSON Database is not possible.

    For JSON Database, MongoDB API is enabled by default and you can disable it during the provisioning or cloning, or in an existing database.

  • When you are cloning and you select Full Clone or Metadata Clone, the built-in tools default settings are based on the defaults for the workload type of the clone. In this case, the defaults are not based on source database built-in tools settings.

  • When you are cloning and you select Refreshable Clone, the refreshable clone inherits the built-in tool status from the source database. Editing the built-in tool status for refreshable clone is not be possible during or after provisioning. If the source database of refreshable clone changes its tool configuration, this is reflected in the refreshable clone after the next refresh.

  • When you provision or clone an Autonomous Database with the APEX workload type (APEX service), the only supported built-in tools are Oracle APEX, Web Access (ORDS), and Database Actions. In the APEX service, you can only disable Database Actions.

  • All existing sessions end after you disable a built-in tool. In addition, disabling Oracle APEX or Web Access (ORDS) also affects the existing applications that are based on these tools. For example, a user application based on ORDS does not continue to work after you disable ORDS.