Jump to

• Request
• Response

Get all partitions in the database

get

/database/objects/partitions/

Returns all records from DBA_TAB_PARTITIONS or ALL_TAB_PARTITIONS view depending on role at runtime. A client requires SQL Administrator or SQL Developer role to invoke this service.

Request

Query Parameters

• limit: integer(int32)
  The maximum number of records to return.
• q:
  Filtering is the process of limiting a collection resource by using a per-request dynamic filter definition across multiple page resources, where each page contains a subset of items found in the complete collection. Filtering enables efficient traversal of large collections.

  Examples

  Select an example FilterCriteriaExample OrderByPropertyExample FilterAndOrderExample

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Description of all partitions in the database.

Body ()

Root Schema : DatabaseObjectsPartitions

Type: object

Show Source

• count: integer
  Total number of records in the current response.
• hasMore: boolean
  Indicates if there are more records to be retrieved.
• items: array items
• limit: integer
  The actual page size limit on number of records applied by the server.
• links: array links
• offset: integer
  The actual index from which the item resources are returned.

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DatabaseObjectsPartitionsItem"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more records to be retrieved."
        },
        "limit":{
            "type":"integer",
            "description":"The actual page size limit on number of records applied by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the item resources are returned."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object DatabaseObjectsPartitionsItem
  This object represents partition-level partitioning information, partition storage parameters, and partition statistics generated by the DBMS_STATS package for a partition in the database. The list of attributes may vary depending on database version.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DatabaseObjectsPartitionsItem"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

Nested Schema : DatabaseObjectsPartitionsItem

Type: object

This object represents partition-level partitioning information, partition storage parameters, and partition statistics generated by the DBMS_STATS package for a partition in the database. The list of attributes may vary depending on database version.

Show Source

• avg_row_len: integer
  Average length of a row in the partition (in bytes).
• avg_space: integer
  Average amount of free space, in bytes, in a data block allocated to the partition.
• blocks: integer
  Number of used data blocks in the partition.
• buffer_pool: string
  Buffer pool to be used for the partition blocks.
• cell_flash_cache: string
  Cell flash cache hint to be used for partition blocks.
• cellmemory: string
  The value for columnar compression in the storage cell flash cache.
• chain_cnt: integer
  Number of rows in the partition that are chained from one data block to another, or which have migrated to a new block, requiring a link to preserve the old ROWID.
• composite: string
  Indicates whether the table is composite-partitioned (YES) or not (NO).
• compress_for: string
  Default compression for what kind of operations.
• compression: string
  Indicates the actual compression property for a partition of a simple partitioned table, or the default (if specified) for subpartitions for composite partitioned tables, otherwise NONE.
• empty_blocks: integer
  Number of empty (never used) data blocks in the partition. This column is populated only if you collect statistics on the table using the DBMS_STATS package.
• flash_cache: string
  Buffer pool to be used for the partition blocks.
• freelist_groups: integer
  Number of freelist groups allocated in this segment.
• freelists: integer
  Number of process freelists allocated in this segment.
• global_stats: string
  GLOBAL_STATS will be YES if statistics are gathered or incrementally maintained, otherwise it will be NO.
• high_value: number
  Partition bound value expression.
• high_value_length: integer
  Length of the partition bound value expression.
• indexing: string
  Indicates the actual indexing property for a partition of a simple partitioned table, or the default (if specified) for subpartitions for composite partitioned tables, otherwise NONE.
• ini_trans: integer
  Initial number of transactions.
• initial_extent: integer
  Size of the initial extent in bytes (for a range partition); size of the initial extent in blocks (for a composite partition).
• inmemory: string
  Indicates whether the In-Memory Column Store (IM column store) is enabled (ENABLED) or disabled (DISABLED) for this partition.
• inmemory_compression: string
  Indicates the compression level for the IM column store.
• inmemory_distribute: string
  Indicates how the IM column store is distributed in an Oracle Real Application Clusters (Oracle RAC) environment.
• inmemory_duplicate: string
  Indicates the duplicate setting for the IM column store in an Oracle RAC environment.
• inmemory_priority: string
  Indicates the priority for In-Memory Column Store (IM column store) population.
• inmemory_service: string
  Indicates how the IM column store is populated on various instances.
• inmemory_service_name: string
  Indicates the service name for the service on which the IM column store should be populated. This column has a value only when the corresponding INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null.
• interval: string
  Indicates whether the partition is in the interval section of an interval partitioned table (YES) or whether the partition is in the range section (NO).
• is_nested: string
  Indicates whether this is a nested table partition (YES) or not (NO).
• last_analyzed: string
  Date on which this partition was most recently analyzed.
• links: array links
• logging: string
  Indicates whether or not changes to the table are logged.
• max_extent: integer
  Maximum number of extents allowed in the segment.
• max_size: integer
  Maximum number of blocks allowed in the segment.
• max_trans: integer
  Maximum number of transactions.
• memoptimize_read: string
  Indicates whether the table is enabled for Fast Key Based Access (ENABLED) or not (DISABLED).
• min_extent: integer
  Minimum number of extents allowed in the segment.
• next_extent: integer
  Size of secondary extents in bytes (for a range partition); size of secondary extents in blocks (for a composite partition).
• num_rows: integer
  Number of rows in the partition.
• parent_table_partition: string
  Parent table's corresponding partition.
• partition_name: string
  Name of the partition.
• partition_position: integer
  Position of the partition within the table.
• pct_free: integer
  Minimum percentage of free space in a block.
• pct_increase: integer
  Percentage increase in extent size.
• pct_used: integer
  Minimum percentage of used space in a block.
• read_only: string
  Indicates the default setting for the partition.
• sample_size: integer
  Sample size used in analyzing this partition.
• segment_created: string
  Indicates the actual segment creation property for a partition of a simple partitioned table, or the default (if specified) for subpartitions for composite partitioned tables, otherwise NONE.
• subpartition_count: integer
  If this is a composite partitioned table, the number of subpartitions in the partition.
• table_name: string
  Name of the table.
• table_owner: string
  Owner of the table.
• tablespace_name: string
  Name of the tablespace containing the partition.
• user_stats: string
  Indicates whether statistics were entered directly by the user (YES) or not (NO).

{
    "type":"object",
    "description":"This object represents partition-level partitioning information, partition storage parameters, and partition statistics generated by the DBMS_STATS package for a partition in the database. The list of attributes may vary depending on database version.",
    "properties":{
        "table_owner":{
            "type":"string",
            "description":"Owner of the table."
        },
        "table_name":{
            "type":"string",
            "description":"Name of the table."
        },
        "composite":{
            "type":"string",
            "description":"Indicates whether the table is composite-partitioned (YES) or not (NO)."
        },
        "partition_name":{
            "type":"string",
            "description":"Name of the partition."
        },
        "subpartition_count":{
            "type":"integer",
            "description":"If this is a composite partitioned table, the number of subpartitions in the partition."
        },
        "high_value":{
            "type":"number",
            "description":"Partition bound value expression."
        },
        "high_value_length":{
            "type":"integer",
            "description":"Length of the partition bound value expression."
        },
        "partition_position":{
            "type":"integer",
            "description":"Position of the partition within the table."
        },
        "tablespace_name":{
            "type":"string",
            "description":"Name of the tablespace containing the partition."
        },
        "pct_free":{
            "type":"integer",
            "description":"Minimum percentage of free space in a block."
        },
        "pct_used":{
            "type":"integer",
            "description":"Minimum percentage of used space in a block."
        },
        "ini_trans":{
            "type":"integer",
            "description":"Initial number of transactions."
        },
        "max_trans":{
            "type":"integer",
            "description":"Maximum number of transactions."
        },
        "initial_extent":{
            "type":"integer",
            "description":"Size of the initial extent in bytes (for a range partition); size of the initial extent in blocks (for a composite partition)."
        },
        "next_extent":{
            "type":"integer",
            "description":"Size of secondary extents in bytes (for a range partition); size of secondary extents in blocks (for a composite partition)."
        },
        "min_extent":{
            "type":"integer",
            "description":"Minimum number of extents allowed in the segment."
        },
        "max_extent":{
            "type":"integer",
            "description":"Maximum number of extents allowed in the segment."
        },
        "max_size":{
            "type":"integer",
            "description":"Maximum number of blocks allowed in the segment."
        },
        "pct_increase":{
            "type":"integer",
            "description":"Percentage increase in extent size."
        },
        "freelists":{
            "type":"integer",
            "description":"Number of process freelists allocated in this segment."
        },
        "freelist_groups":{
            "type":"integer",
            "description":"Number of freelist groups allocated in this segment."
        },
        "logging":{
            "type":"string",
            "description":"Indicates whether or not changes to the table are logged."
        },
        "compression":{
            "type":"string",
            "description":"Indicates the actual compression property for a partition of a simple partitioned table, or the default (if specified) for subpartitions for composite partitioned tables, otherwise NONE."
        },
        "compress_for":{
            "type":"string",
            "description":"Default compression for what kind of operations."
        },
        "num_rows":{
            "type":"integer",
            "description":"Number of rows in the partition."
        },
        "blocks":{
            "type":"integer",
            "description":"Number of used data blocks in the partition."
        },
        "empty_blocks":{
            "type":"integer",
            "description":"Number of empty (never used) data blocks in the partition. This column is populated only if you collect statistics on the table using the DBMS_STATS package."
        },
        "avg_space":{
            "type":"integer",
            "description":"Average amount of free space, in bytes, in a data block allocated to the partition."
        },
        "chain_cnt":{
            "type":"integer",
            "description":"Number of rows in the partition that are chained from one data block to another, or which have migrated to a new block, requiring a link to preserve the old ROWID."
        },
        "avg_row_len":{
            "type":"integer",
            "description":"Average length of a row in the partition (in bytes)."
        },
        "sample_size":{
            "type":"integer",
            "description":"Sample size used in analyzing this partition."
        },
        "last_analyzed":{
            "type":"string",
            "description":"Date on which this partition was most recently analyzed."
        },
        "buffer_pool":{
            "type":"string",
            "description":"Buffer pool to be used for the partition blocks."
        },
        "flash_cache":{
            "type":"string",
            "description":"Buffer pool to be used for the partition blocks."
        },
        "cell_flash_cache":{
            "type":"string",
            "description":"Cell flash cache hint to be used for partition blocks."
        },
        "global_stats":{
            "type":"string",
            "description":"GLOBAL_STATS will be YES if statistics are gathered or incrementally maintained, otherwise it will be NO."
        },
        "user_stats":{
            "type":"string",
            "description":"Indicates whether statistics were entered directly by the user (YES) or not (NO)."
        },
        "is_nested":{
            "type":"string",
            "description":"Indicates whether this is a nested table partition (YES) or not (NO)."
        },
        "parent_table_partition":{
            "type":"string",
            "description":"Parent table's corresponding partition."
        },
        "interval":{
            "type":"string",
            "description":"Indicates whether the partition is in the interval section of an interval partitioned table (YES) or whether the partition is in the range section (NO)."
        },
        "segment_created":{
            "type":"string",
            "description":"Indicates the actual segment creation property for a partition of a simple partitioned table, or the default (if specified) for subpartitions for composite partitioned tables, otherwise NONE."
        },
        "indexing":{
            "type":"string",
            "description":"Indicates the actual indexing property for a partition of a simple partitioned table, or the default (if specified) for subpartitions for composite partitioned tables, otherwise NONE."
        },
        "read_only":{
            "type":"string",
            "description":"Indicates the default setting for the partition."
        },
        "inmemory":{
            "type":"string",
            "description":"Indicates whether the In-Memory Column Store (IM column store) is enabled (ENABLED) or disabled (DISABLED) for this partition."
        },
        "inmemory_priority":{
            "type":"string",
            "description":"Indicates the priority for In-Memory Column Store (IM column store) population."
        },
        "inmemory_distribute":{
            "type":"string",
            "description":"Indicates how the IM column store is distributed in an Oracle Real Application Clusters (Oracle RAC) environment."
        },
        "inmemory_compression":{
            "type":"string",
            "description":"Indicates the compression level for the IM column store."
        },
        "inmemory_duplicate":{
            "type":"string",
            "description":"Indicates the duplicate setting for the IM column store in an Oracle RAC environment."
        },
        "cellmemory":{
            "type":"string",
            "description":"The value for columnar compression in the storage cell flash cache."
        },
        "inmemory_service":{
            "type":"string",
            "description":"Indicates how the IM column store is populated on various instances."
        },
        "inmemory_service_name":{
            "type":"string",
            "description":"Indicates the service name for the service on which the IM column store should be populated. This column has a value only when the corresponding INMEMORY_SERVICE is USER_DEFINED. In all other cases, this column is null."
        },
        "memoptimize_read":{
            "type":"string",
            "description":"Indicates whether the table is enabled for Fast Key Based Access (ENABLED) or not (DISABLED)."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LinkRelation"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LinkRelation"
    }
}

Nested Schema : LinkRelation

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

Back to Top