1. Oracle GoldenGate Microservices REST API
  2. Tasks
  3. Administrative Server
  4. Database

Manage Schema Supplemental Logging

post

/services/{version}/connections/{connection}/trandata/schema

Required Role: Administrator

Manage Supplemental Logging for Database Schemas

Request

Supported Media Types
Path Parameters
  • Minimum Length: 1
    Maximum Length: 61
    Pattern: ^[a-zA-Z][a-zA-Z0-9_#$]{1,29}([.][a-zA-Z][a-zA-Z0-9_#$]{1,29})?$

    Connection name. For each alias in the credential store, a connection with the name 'domain.alias' exists.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Body ()
Root Schema : Manage Supplemental Logging for Database Schema
Type: object
Title: Manage Supplemental Logging for Database Schema
Match One
Show Source
Nested Schema : Manage Supplemental Logging for Database Schema-x-oneOf[0]
Type: object
Show Source
Nested Schema : Manage Supplemental Logging for Database Schema-x-oneOf[1]
Type: object
Show Source
Nested Schema : Manage Supplemental Logging for Database Schema-x-oneOf[2]
Type: object
Show Source
Nested Schema : schemaName
Match Any
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : schemaName
Match Any
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : schemaName
Match Any
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Example Request (application/json)
{
    "operation":"info",
    "schemaName":"oggadmin"
}
Back to Top

Response

Supported Media Types

200 Response

Supplemental logging command completed successfully.

Body ()
Root Schema : Manage Supplemental Logging for Database Schema
Type: object
Title: Manage Supplemental Logging for Database Schema
Match One
Show Source
Nested Schema : Manage Supplemental Logging for Database Schema-x-oneOf[0]
Type: object
Show Source
Nested Schema : Manage Supplemental Logging for Database Schema-x-oneOf[1]
Type: object
Show Source
Nested Schema : schemas
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 65535
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : tables
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 65535
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : columns
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 8192
Show Source
Nested Schema : details
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 16
Show Source
Nested Schema : disqualifiedUniqueKey
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 8192
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : oggKeycolList
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 8192
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : schemaName
Schema name for table
Match Any
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : items
Type: object
Description of a table column
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
    Column name in table
  • Minimum Length: 1
    Maximum Length: 255
    Column data type
Nested Schema : items
Match One
Show Source
  • Allowed Values: [ "unsupportedPartitionTable" ]
    Oracle Goldengate does not support system or referential partitioned table {0}.{1}.
  • Allowed Values: [ "unsupportedTemporalTable" ]
    Oracle Goldengate does not support temporal table {0}.{1}.
  • Allowed Values: [ "unsupportedTableWithIdentityCol" ]
    Oracle Goldengate does not support table {0}.{1} due to presence of identity column.
  • Allowed Values: [ "tableRequiresPlsqlLogging" ]
    Oracle Goldengate requires supplemental logging on PLSQL to be enabled to support table {0}.{1}.
  • Allowed Values: [ "unsupportTable" ]
    Oracle Goldengate does not support replication on table {0}.{1}.
  • Allowed Values: [ "partialSupportTable" ]
    Oracle Goldengate does not support native capture on table {0}.{1}.
  • Allowed Values: [ "fetchSizeLimit" ]
    Table {0}.{1} requires fetch, and Oracle Goldengate has limit of 4GB on any fetched column.
  • Allowed Values: [ "oggKeycolList" ]
    Oracle Goldengate marked following column as key columns on table {0}.{1}:
  • Allowed Values: [ "noUniqueKeyDefined" ]
    No unique key is defined for table {0}.
  • Allowed Values: [ "noViableUniqueKey" ]
    No viable unique key is defined for table {0}.
  • Allowed Values: [ "disqualifiedUniqueKey" ]
    Unique key {0} for table {1} cannot be used due to the inclusion of virtual columns, or user-defined datatypes, or extended long varchar columns, or function-based index columns.
  • Allowed Values: [ "fetchObjectColLobxml" ]
    This table has object column(s). If that column contains any lob or xml type attribute, the maximum fetch size is limited on those attributes to what's specifed by LOBBUFSIZE or XMLBUFSIZE parameter.
  • Allowed Values: [ "tableFullSupport" ]
    Oracle Goldengate support native capture on table {0}.{1}.
  • Allowed Values: [ "tableWithoutScalarColumn" ]
    Table {0} does not have any scalar column.
  • Allowed Values: [ "tableIsObjectype" ]
    Table {0} is an object table.
  • Allowed Values: [ "tableIsXmltype" ]
    Table {0} is an XMLTYPE table.
  • Allowed Values: [ "tableIsIot" ]
    Table {0} is an index organized table.
  • Allowed Values: [ "tableIsCluster" ]
    Table {0} is a cluster table.
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/trandata/schema",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/trandata/schema",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:trandataSchemaResponse",
        "schemas":[
            {
                "allColumns":false,
                "enabled":false,
                "nonvalidatedKeysAllowed":false,
                "nonvalidatedKeysSupported":true,
                "numPreparedTables":"16",
                "schedulingColumns":false,
                "schemaName":"OGGADMIN"
            }
        ],
        "type":"info"
    }
}
Back to Top