Skip to main content

exascale_db_storage_vaults

Creates, updates, deletes, gets or lists an exascale_db_storage_vaults resource.

Overview​

Nameexascale_db_storage_vaults
TypeResource
Idoci.database.exascale_db_storage_vaults

Fields​

The following fields are returned by SELECT queries:

Information about the Exadata Database Storage Vault.

NameDatatypeDescription
idstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata Database Storage Vault.
additionalFlashCacheInPercentinteger (int32)The size of additional Flash Cache in percentage of High Capacity database storage.
attachedShapeAttributesarrayThe shapeAttribute of the Exadata VM cluster(s) associated with the Exadata Database Storage Vault.
autoscaleLimitInGBsintegerThe maximum limit, in gigabytes, to which the Vault storage size can automatically scale when auto scaling is enabled for the Database Storage Vault
availabilityDomainstringThe name of the availability domain in which the Exadata Database Storage Vault is located.
clusterPlacementGroupIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the cluster placement group of the Exadata Infrastructure.
compartmentIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
definedTagsobjectDefined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
descriptionstringExadata Database Storage Vault description.
displayNamestringThe user-friendly name for the Exadata Database Storage Vault. The name does not need to be unique.
exadataInfrastructureIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the Exadata infrastructure.
freeformTagsobjectFree-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"}
highCapacityDatabaseStorageobjectExadata Database Storage Details
isAutoscaleEnabledbooleanIndicates if autoscale feature is enabled for the Database Storage Vault. The default value is FALSE.
lifecycleDetailsstringAdditional information about the current lifecycle state.
lifecycleStatestringThe current state of the Exadata Database Storage Vault. (PROVISIONING, AVAILABLE, UPDATING, TERMINATING, TERMINATED, FAILED)
subscriptionIdstringThe [OCID](/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
systemTagsobjectSystem tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
timeCreatedstring (date-time)The date and time that the Exadata Database Storage Vault was created.
timeZonestringThe time zone that you want to use for the Exadata Database Storage Vault. For details, see [Time Zones](/Content/Database/References/timezones.htm).
vmClusterCountintegerThe number of Exadata VM clusters used the Exadata Database Storage Vault.
vmClusterIdsarrayThe List of Exadata VM cluster on Exascale Infrastructure [OCIDs](/Content/General/Concepts/identifiers.htm) Note: If Exadata Database Storage Vault is not used for any Exadata VM cluster on Exascale Infrastructure, this list is empty.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectexascaleDbStorageVaultId, regionopc-request-idGets information about the specified Exadata Database Storage Vaults in the specified compartment.<br />
listselectcompartmentId, regionlimit, page, sortBy, sortOrder, lifecycleState, clusterPlacementGroupId, attachedShapeAttributesNotEqualTo, attachedShapeAttributes, vmClusterCountLessThanOrEqualTo, vmClusterCountGreaterThanOrEqualTo, displayName, opc-request-id, exadataInfrastructureIdGets a list of the Exadata Database Storage Vaults in the specified compartment.<br />
createinsertregion, compartmentId, displayName, highCapacityDatabaseStorage, availabilityDomainopc-retry-token, opc-request-idCreates an Exadata Database Storage Vault<br />
updateupdateexascaleDbStorageVaultId, regionif-match, opc-request-idUpdates the specified Exadata Database Storage Vault.<br />
deletedeleteexascaleDbStorageVaultId, regionif-match, opc-request-idDeletes the specified Exadata Database Storage Vault.<br />
change_compartmentexecexascaleDbStorageVaultId, region, compartmentIdopc-retry-token, opc-request-id, if-matchMoves a Exadata Database Storage Vault to another compartment.<br />
change_exascale_db_storage_vault_subscriptionexecexascaleDbStorageVaultId, regionopc-retry-token, opc-request-id, if-matchAssociate a Exadata Database Storage Vault with a different subscription.<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.

NameDatatypeDescription
compartmentIdstringThe compartment [OCID](/Content/General/Concepts/identifiers.htm).
exascaleDbStorageVaultIdstringThe Exadata Database Storage Vault [OCID](/Content/General/Concepts/identifiers.htm).
regionstringOCI 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)
attachedShapeAttributesstringA filter to return only Exadata Database Storage Vaults which match the given attachedShapeAttributes or has null attachedShapeAttributes
attachedShapeAttributesNotEqualTostringA filter to return only Exadata Database Storage Vaults which do not match the given attachedShapeAttributes
clusterPlacementGroupIdstringA filter to return only resources that match the given cluster placement group ID exactly.
displayNamestringA filter to return only resources that match the entire display name given. The match is not case sensitive.
exadataInfrastructureIdstringA filter to return only list of Vaults that are linked to the exadata infrastructure Id.
if-matchstringFor 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.
lifecycleStatestringA filter to return only Exadata Database Storage Vaults that match the given lifecycle state exactly.
limitintegerThe maximum number of items to return per page.
opc-request-idstringUnique identifier for the request.
opc-retry-tokenstringA 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).
pagestringThe pagination token to continue listing from.
sortBystringThe field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
sortOrderstringThe sort order to use, either ascending (ASC) or descending (DESC).
vmClusterCountGreaterThanOrEqualTointegerA filter to return only Exadata Database Storage Vaults with associated Exadata VM Clusters greater than or equal to the given count
vmClusterCountLessThanOrEqualTointegerA filter to return only Exadata Database Storage Vaults with associated Exadata VM Clusters less than or equal to the given count

SELECT examples​

Gets information about the specified Exadata Database Storage Vaults in the specified compartment.<br />

SELECT
id,
additionalFlashCacheInPercent,
attachedShapeAttributes,
autoscaleLimitInGBs,
availabilityDomain,
clusterPlacementGroupId,
compartmentId,
definedTags,
description,
displayName,
exadataInfrastructureId,
freeformTags,
highCapacityDatabaseStorage,
isAutoscaleEnabled,
lifecycleDetails,
lifecycleState,
subscriptionId,
systemTags,
timeCreated,
timeZone,
vmClusterCount,
vmClusterIds
FROM oci.database.exascale_db_storage_vaults
WHERE exascaleDbStorageVaultId = '{{ exascaleDbStorageVaultId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

INSERT examples​

Creates an Exadata Database Storage Vault<br />

INSERT INTO oci.database.exascale_db_storage_vaults (
additionalFlashCacheInPercent,
autoscaleLimitInGBs,
availabilityDomain,
clusterPlacementGroupId,
compartmentId,
definedTags,
description,
displayName,
exadataInfrastructureId,
freeformTags,
highCapacityDatabaseStorage,
isAutoscaleEnabled,
subscriptionId,
timeZone,
region,
opc-retry-token,
opc-request-id
)
SELECT 
{{ additionalFlashCacheInPercent }},
{{ autoscaleLimitInGBs }},
'{{ availabilityDomain }}' /* required */,
'{{ clusterPlacementGroupId }}',
'{{ compartmentId }}' /* required */,
'{{ definedTags }}',
'{{ description }}',
'{{ displayName }}' /* required */,
'{{ exadataInfrastructureId }}',
'{{ freeformTags }}',
'{{ highCapacityDatabaseStorage }}' /* required */,
{{ isAutoscaleEnabled }},
'{{ subscriptionId }}',
'{{ timeZone }}',
'{{ region }}',
'{{ opc-retry-token }}',
'{{ opc-request-id }}'
RETURNING
id,
additionalFlashCacheInPercent,
attachedShapeAttributes,
autoscaleLimitInGBs,
availabilityDomain,
clusterPlacementGroupId,
compartmentId,
definedTags,
description,
displayName,
exadataInfrastructureId,
freeformTags,
highCapacityDatabaseStorage,
isAutoscaleEnabled,
lifecycleDetails,
lifecycleState,
subscriptionId,
systemTags,
timeCreated,
timeZone,
vmClusterCount,
vmClusterIds
;

UPDATE examples​

Updates the specified Exadata Database Storage Vault.<br />

UPDATE oci.database.exascale_db_storage_vaults
SET 
additionalFlashCacheInPercent = {{ additionalFlashCacheInPercent }},
autoscaleLimitInGBs = {{ autoscaleLimitInGBs }},
definedTags = '{{ definedTags }}',
description = '{{ description }}',
displayName = '{{ displayName }}',
freeformTags = '{{ freeformTags }}',
highCapacityDatabaseStorage = '{{ highCapacityDatabaseStorage }}',
isAutoscaleEnabled = {{ isAutoscaleEnabled }}
WHERE 
exascaleDbStorageVaultId = '{{ exascaleDbStorageVaultId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
AND opc-request-id = '{{ opc-request-id}}'
RETURNING
id,
additionalFlashCacheInPercent,
attachedShapeAttributes,
autoscaleLimitInGBs,
availabilityDomain,
clusterPlacementGroupId,
compartmentId,
definedTags,
description,
displayName,
exadataInfrastructureId,
freeformTags,
highCapacityDatabaseStorage,
isAutoscaleEnabled,
lifecycleDetails,
lifecycleState,
subscriptionId,
systemTags,
timeCreated,
timeZone,
vmClusterCount,
vmClusterIds;

DELETE examples​

Deletes the specified Exadata Database Storage Vault.<br />

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

Lifecycle Methods​

Moves a Exadata Database Storage Vault to another compartment.<br />

EXEC oci.database.exascale_db_storage_vaults.change_compartment 
@exascaleDbStorageVaultId='{{ exascaleDbStorageVaultId }}' --required, 
@region='{{ region }}' --required, 
@opc-retry-token='{{ opc-retry-token }}', 
@opc-request-id='{{ opc-request-id }}', 
@if-match='{{ if-match }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;