Tagging and Search in Database Management

Database Management is integrated with the Oracle Cloud Infrastructure Tagging and Search services.

Use Tags in Database Management

You can use tags in Database Management to organize and manage resources such as Managed Databases and Database Groups.

Oracle Cloud Infrastructure Tagging allows you to add metadata to resources, which enables you to define keys and values and associate them with resources. Tags can be added to Database Management resources at various stages of using Database Management (in the console and using CLI).

Using tags, you can:

  • Organize and manage resources
  • Filter resources
  • Control access to resources
Note

The Tagging feature in Database Management is currently available for:
  • Oracle Database resources, which include Database Groups, jobs, named credentials, and private endpoints.
  • External Database System resources, which include External Database System components and connectors.
  • Exadata Infrastructure resources, which include storage servers and connectors.

For the list of Database Management resources that can be tagged, see Resources That Can Be Tagged.

There are two types of tags that you can add to your resources based on your requirements:

  • Defined tags: An administrator can set up these tags in a tenancy. Only users with the permissions required to work with the defined tags can add them to Oracle Cloud Infrastructure resources.
  • Free-form tags: Any user can add these tags, as long as they have the permissions on the resource.

For information on the limits on tags, see Limits on Tags.

Here are a few scenarios that illustrate the use of tags in Database Management:

  • Add tags during resource creation or discovery. You can add tags when:
    • Creating various Database Management resources such as Database Groups (dbmgmt-managed-database-groups), private endpoints (dbmgmt-private-endpoints), named credentials (dbmgmt-named-credentials), and jobs (dbmgmt-jobs).
    • Discovering an External Database System (dbmgmt-external-dbsystems) and Exadata Infrastructure (dbmgmt-external-exadata) in Database Management.
  • Perform tag-related tasks on resource pages. You can view, add, and edit tags for resources such as Managed Databases, External Database Systems, and Exadata Infrastructure, on the corresponding details pages. For example, you can add tags for a Managed Database on the Managed database details page.
    Note

    The tags added for an Oracle Database in the Oracle Cloud Infrastructure Database service such as the Base Database and External Database services cannot be used for the database in Database Management. You can only use the tags added for these resources in Database Management.
  • Filter resources using tags. You can filter resources such as Managed Databases and Database Groups using Tag filters. For example, you can filter Managed Databases using tags on the Oracle Database fleet summary page.
  • Control access to resources using tags. You can control and limit access to a particular resource by adding a tag and writing a policy. For example, you can add tags to a set of PDBs and write the following policy to limit access to these PDBs. In the following policy, the users in the DBM-USERS user group are granted access to all the resources in compartment ABC that have the defined tag, TestTagNamespace.DbType='PDB':
    Allow group DBM-USERS to manage dbmgmt-managed-databases in compartment ABC where target.resource.tag.TestTagNamespace.DbType='PDB'

    For more information, see Using Tags to Manage Access.

For information on tagging concepts, the permissions required to work with tags, and how to use tags, see Overview of Tagging.

Use Search in Database Management

You can use the Oracle Cloud Infrastructure Search service to find Database Management resources within a tenancy, Oracle Cloud Infrastructure Console pages in services, and documentation.

To search for a resource, you can use a free text search based on keywords. You can also use structured resource query language to build an advanced query based on a single resource attribute, such as the resource's creation date, or a tag attribute, such as the resource's free-form and defined tags. The results for resource searches are limited to the tenancy and the currently selected region. For information on search concepts, the permissions required to work with search, and how to use search, see Overview of Search.

Examples of Search Queries for Database Management Resources

Example 1: Search for all Managed Databases

query DbmgmtManagedDatabase resources

Example 2: Search for all Managed Databases with a particular free-form tag

query DbmgmtManagedDatabase resources where (freeformTags.key = '<key>' && freeformTags.value = '<value>')

Example 3: Search for all Managed Databases with a particular defined tag

query DbmgmtManagedDatabase resources where (definedTags.namespace = '<namespace>' && definedTags.key = '<key>' && definedTags.value = '<value>')

Database Management is integrated with Search and the following resources are supported. For more information, see Supported Resources.

Resources Supported Fields
DbmgmtExternalAsm
  • compartmentId
  • definedTags
  • displayName
  • externalConnectorId
  • externalDbSystemId
  • freeformTags
  • id
  • lifecycleState
  • timeCreated
DbmgmtExternalAsmInstance
  • compartmentId
  • definedTags
  • displayName
  • externalAsmId
  • externalDbNodeId
  • externalDbSystemId
  • freeformTags
  • id
  • lifecycleState
  • timeCreated
DbmgmtExternalCluster
  • compartmentId
  • definedTags
  • displayName
  • externalConnectorId
  • externalDbSystemId
  • freeformTags
  • id
  • lifecycleState
  • timeCreated
DbmgmtExternalClusterInstance
  • compartmentId
  • definedTags
  • displayName
  • externalClusterId
  • externalConnectorId
  • externalDbNodeId
  • externalDbSystemId
  • freeformTags
  • id
  • lifecycleState
  • timeCreated
DbmgmtExternalDbHome
  • compartmentId
  • definedTags
  • displayName
  • externalDbSystemId
  • freeformTags
  • id
  • lifecycleState
  • timeCreated
DbmgmtExternalDbNode
  • compartmentId
  • definedTags
  • displayName
  • externalConnectorId
  • externalDbSystemId
  • freeformTags
  • id
  • lifecycleState
  • timeCreated
DbmgmtExternalDbSystem
  • compartmentId
  • dbSystemDiscoveryId
  • definedTags
  • discoveryAgentId
  • displayName
  • freeformTags
  • id
  • lifecycleState
  • timeCreated
DbmgmtExternalDbSystemConnector
  • agentId
  • compartmentId
  • definedTags
  • displayName
  • externalDbSystemId
  • freeformTags
  • id
  • lifecycleState
  • timeCreated
DbmgmtExternalExadataInfrastructure
  • compartmentId
  • definedTags
  • displayName
  • freeformTags
  • id
  • internalId
  • lifecycleState
  • timeCreated
DbmgmtExternalExadataStorageConnector
  • agentId
  • compartmentId
  • definedTags
  • displayName
  • exadataInfrastructureId
  • freeformTags
  • id
  • internalId
  • lifecycleState
  • storageServerId
  • timeCreated
DbmgmtExternalExadataStorageGrid
  • compartmentId
  • definedTags
  • displayName
  • exadataInfrastructureId
  • freeformTags
  • id
  • internalId
  • lifecycleState
  • timeCreated
DbmgmtExternalExadataStorageServer
  • compartmentId
  • definedTags
  • displayName
  • exadataInfrastructureId
  • freeformTags
  • id
  • internalId
  • lifecycleState
  • storageGridId
  • timeCreated
DbmgmtExternalListener
  • compartmentId
  • definedTags
  • displayName
  • externalConnectorId
  • externalDbHomeId
  • externalDbNodeId
  • externalDbSystemId
  • freeformTags
  • id
  • lifecycleState
  • timeCreated
DbmgmtJob
  • compartmentId
  • definedTags
  • freeformTags
  • id
  • lifecycleState
  • managedDatabaseGroupId
  • managedDatabaseId
  • name
  • timeCreated
DbmgmtManagedDatabase
  • compartmentId
  • dbaasDatabaseId
  • dbId
  • dbSystemId
  • dbUniqueName
  • definedTags
  • freeformTags
  • id
  • mangementAgentId
  • name
  • parentContainerId (in the case of a PDB)
  • timeCreated
DbmgmtManagedDatabaseGroup
  • compartmentId
  • definedTags
  • freeformTags
  • id
  • lifecycleState
  • managedDatabases
  • name
  • timeCreated
DbmgmtNamedCredential
  • compartmentId
  • definedTags
  • displayName
  • freeformTags
  • id
  • lifecycleState
  • timeCreated
DbmgmtPrivateEndpoint
  • compartmentId
  • definedTags
  • freeformTags
  • id
  • lifecycleState
  • name
  • nsgIds
  • subnetId
  • timeCreated
  • vcnId