db_system_shapes

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

Overview

Name	db_system_shapes
Type	Resource
Id	oci.database.db_system_shapes

Fields

The following fields are returned by SELECT queries:

list

The shape of the DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.<br /><br />For Exadata fixed and flexible shapes, detailed specifications can be found in https:​//docs.oracle.com/en/engineered-systems/exadata-cloud-service/ecscm/exa-service-desc.html#GUID-9E090174-5C57-4EB1-9243-B470F9F10D6B<br /><br />To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator.<br />If you're an administrator who needs to write policies to give users access,<br />see [Getting Started with Policies](/Content/Identity/Concepts/policygetstarted.htm).<br />

Name	Datatype	Description
name	string	The name of the shape used for the DB system.
areServerTypesSupported	boolean	If true, the shape supports configurable DB and Storage Server types.
availableCoreCount	integer	The maximum number of CPU cores that can be enabled on the DB system for this shape.
availableCoreCountPerNode	integer (int32)	The maximum number of CPU cores per database node that can be enabled for this shape. Only applicable to the flex Exadata shape, ExaCC Elastic shapes and VM Flex shapes.
availableDataStorageInTBs	integer	The maximum DATA storage that can be enabled for this shape.
availableDataStoragePerServerInTBs	number (double)	The maximum data storage available per storage server for this shape. Only applicable to ExaCC Elastic shapes.
availableDbNodePerNodeInGBs	integer	The maximum Db Node storage available per database node for this shape. Only applicable to ExaCC Elastic shapes.
availableDbNodeStorageInGBs	integer	The maximum Db Node storage that can be enabled for this shape.
availableMemoryInGBs	integer	The maximum memory that can be enabled for this shape.
availableMemoryPerNodeInGBs	integer	The maximum memory available per database node for this shape. Only applicable to ExaCC Elastic shapes.
computeModel	string	The compute model of the Base Database, Exadata Infrastructure, VM Cluster and Autonomous AI Database. (ECPU, OCPU) (x-default-description: Null used when unspecified.)
coreCountIncrement	integer	The discrete number by which the CPU core count for this shape can be increased or decreased.
displayName	string	The display name of the shape used for the DB system.
maxStorageCount	integer	The maximum number of Exadata storage servers available for the Exadata infrastructure.
maximumNodeCount	integer	The maximum number of compute servers available for this shape.
minCoreCountPerNode	integer	The minimum number of CPU cores that can be enabled per node for this shape.
minDataStorageInTBs	integer	The minimum data storage that need be allocated for this shape.
minDbNodeStoragePerNodeInGBs	integer	The minimum Db Node storage that need be allocated per node for this shape.
minMemoryPerNodeInGBs	integer	The minimum memory that need be allocated per node for this shape.
minStorageCount	integer	The minimum number of Exadata storage servers available for the Exadata infrastructure.
minimumCoreCount	integer	The minimum number of CPU cores that can be enabled on the DB system for this shape.
minimumNodeCount	integer	The minimum number of compute servers available for this shape.
runtimeMinimumCoreCount	integer	The runtime minimum number of CPU cores that can be enabled on the DB system for this shape.
shape	string	Deprecated. Use name instead of shape.
shapeAttributes	array	The shapeAttributes of the DB system shape.
shapeFamily	string	The family of the shape used for the DB system.
shapeType	string	The shape type for the virtual machine DB system. Shape type is determined by CPU hardware. Valid values are AMD , INTEL, INTEL_FLEX_X9 or AMPERE_FLEX_A1. (AMD, INTEL, INTEL_FLEX_X9, AMPERE_FLEX_A1)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	compartmentId, region	availabilityDomain, limit, page, shapeAttribute	Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.

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
compartmentId	string	The compartment [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)
availabilityDomain	string	The name of the Availability Domain.
limit	integer	The maximum number of items to return per page.
page	string	The pagination token to continue listing from.
shapeAttribute	string	If provided and applicable, return DB System shape parameters based on the shapeAttribute provided

SELECT examples

list

Gets a list of the shapes that can be used to launch a new DB system. The shape determines resources to allocate to the DB system - CPU cores and memory for VM shapes; CPU cores, memory and storage for non-VM (or bare metal) shapes.

SELECT
name,
areServerTypesSupported,
availableCoreCount,
availableCoreCountPerNode,
availableDataStorageInTBs,
availableDataStoragePerServerInTBs,
availableDbNodePerNodeInGBs,
availableDbNodeStorageInGBs,
availableMemoryInGBs,
availableMemoryPerNodeInGBs,
computeModel,
coreCountIncrement,
displayName,
maxStorageCount,
maximumNodeCount,
minCoreCountPerNode,
minDataStorageInTBs,
minDbNodeStoragePerNodeInGBs,
minMemoryPerNodeInGBs,
minStorageCount,
minimumCoreCount,
minimumNodeCount,
runtimeMinimumCoreCount,
shape,
shapeAttributes,
shapeFamily,
shapeType
FROM oci.database.db_system_shapes
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND availabilityDomain = '{{ availabilityDomain }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND shapeAttribute = '{{ shapeAttribute }}'
;