pluggable_database_snapshots

Creates, updates, deletes, gets or lists a pluggable_database_snapshots resource.

Overview

Name	pluggable_database_snapshots
Type	Resource
Id	oci.database.pluggable_database_snapshots

Fields

The following fields are returned by SELECT queries:

get

Information about the Exadata Pluggable Database Snapshot.

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database Snapshot.
name	string	The user-friendly name for the Database Snapshot. The name should be unique.
clusterId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster.
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
freeformTags	object	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleDetails	string	Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot.
lifecycleState	string	The current state of the Exadata Pluggable Database Snapshot. (CREATING, AVAILABLE, TERMINATING, TERMINATED, FAILED)
pluggableDatabaseId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database.
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeCreated	string (date-time)	The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z

list

Details of the Exadata Pluggable Database Snapshot.<br />

Name	Datatype	Description
id	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database Snapshot.
name	string	The user-friendly name for the Database Snapshot. The name should be unique.
clusterId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the VM cluster.
compartmentId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
definedTags	object	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
freeformTags	object	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: {"Department": "Finance"}
lifecycleDetails	string	Additional information about the current lifecycle state of the Exadata Pluggable Database Snapshot.
lifecycleState	string	The current state of the Exadata Pluggable Database Snapshot. (x-obmcs-enumref: #/definitions/PluggableDatabaseSnapshot/lifecycleState)
pluggableDatabaseId	string	The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database.
systemTags	object	System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeCreated	string (date-time)	The date and time that the Exadata Pluggable Database Snapshot was created, as expressed in RFC 3339 format. For example: 2023-06-27T21:10:29Z

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	pluggableDatabaseSnapshotId, region	opc-request-id	Gets information about the specified Exadata Pluggable Database Snapshot in the specified compartment.<br />
list	select	region	compartmentId, limit, page, sortBy, name, sortOrder, lifecycleState, clusterId, pluggableDatabaseId, opc-request-id	Gets a list of the Exadata Pluggable Database Snapshots in the specified compartment.<br />
create	insert	region, name, pluggableDatabaseId	opc-retry-token, opc-request-id	Creates a Pluggable Database Snapshot<br />
delete	delete	pluggableDatabaseSnapshotId, region	if-match, opc-request-id	Deletes the specified Exadata Pluggable Database Snapshot.<br />

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
pluggableDatabaseSnapshotId	string	The Exadata Pluggable Database Snapshot [OCID](/Content/General/Concepts/identifiers.htm).
region	string	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
clusterId	string	A filter to return only Exadata Database Node Snapshots that match the given VM cluster.
compartmentId	string	The compartment [OCID](/Content/General/Concepts/identifiers.htm).
if-match	string	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
lifecycleState	string	A filter to return only Exadata Pluggable Database Snapshots that match the given lifecycle state exactly.
limit	integer	The maximum number of items to return per page.
name	string	A filter to return only resources that match the entire name given. The match is not case sensitive.
opc-request-id	string	Unique identifier for the request.
opc-retry-token	string	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
page	string	The pagination token to continue listing from.
pluggableDatabaseId	string	A filter to return only Exadata Pluggable Database Snapshots that match the given database [OCID](/Content/General/Concepts/identifiers.htm).
sortBy	string	The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive.
sortOrder	string	The sort order to use, either ascending (ASC) or descending (DESC).

SELECT examples

get

Gets information about the specified Exadata Pluggable Database Snapshot in the specified compartment.<br />

SELECT
id,
name,
clusterId,
compartmentId,
definedTags,
freeformTags,
lifecycleDetails,
lifecycleState,
pluggableDatabaseId,
systemTags,
timeCreated
FROM oci.database.pluggable_database_snapshots
WHERE pluggableDatabaseSnapshotId = '{{ pluggableDatabaseSnapshotId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

list

Gets a list of the Exadata Pluggable Database Snapshots in the specified compartment.<br />

SELECT
id,
name,
clusterId,
compartmentId,
definedTags,
freeformTags,
lifecycleDetails,
lifecycleState,
pluggableDatabaseId,
systemTags,
timeCreated
FROM oci.database.pluggable_database_snapshots
WHERE region = '{{ region }}' -- required
AND compartmentId = '{{ compartmentId }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND name = '{{ name }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND clusterId = '{{ clusterId }}'
AND pluggableDatabaseId = '{{ pluggableDatabaseId }}'
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples

create

Creates a Pluggable Database Snapshot<br />

INSERT INTO oci.database.pluggable_database_snapshots (
definedTags,
freeformTags,
name,
pluggableDatabaseId,
region,
opc-retry-token,
opc-request-id
)
SELECT 
'{{ definedTags }}',
'{{ freeformTags }}',
'{{ name }}' /* required */,
'{{ pluggableDatabaseId }}' /* required */,
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
name,
clusterId,
compartmentId,
definedTags,
freeformTags,
lifecycleDetails,
lifecycleState,
pluggableDatabaseId,
systemTags,
timeCreated
;

Manifest

# Description fields are for documentation purposes
- name: pluggable_database_snapshots
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the pluggable_database_snapshots resource.
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a namespace.
      For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
      For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: name
    value: "{{ name }}"
    description: |
      The user-friendly name for the Database Snapshot. The name should be unique.
  - name: pluggableDatabaseId
    value: "{{ pluggableDatabaseId }}"
    description: |
      The [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Pluggable Database.
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). 
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: Unique identifier for the request. 
    description: Unique identifier for the request. 

DELETE examples

delete

Deletes the specified Exadata Pluggable Database Snapshot.<br />

DELETE FROM oci.database.pluggable_database_snapshots
WHERE pluggableDatabaseSnapshotId = '{{ pluggableDatabaseSnapshotId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match }}'
AND opc-request-id = '{{ opc-request-id }}'
;