1. Oracle GoldenGate 23ai Microservices Architecture REST API Documentation
  2. Tasks
  3. Administration Service
  4. Database

Manage Table Supplemental Logging

post

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

Required Role: Administrator

Manage Supplemental Logging for Database Tables

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 Tables
Type: object
Title: Manage Supplemental Logging for Database Tables
Match One
Show Source
Nested Schema : Manage Supplemental Logging for Database Tables-x-oneOf[0]
Type: object
Show Source
Nested Schema : Manage Supplemental Logging for Database Tables-x-oneOf[1]
Type: object
Show Source
Nested Schema : Manage Supplemental Logging for Database Tables-x-oneOf[2]
Type: object
Show Source
Nested Schema : columns
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 : tableName
Qualified table name where any name component may contain wildcard characters
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : tableName
Qualified table name where any name component may contain wildcard characters
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Nested Schema : tableName
Qualified table name where the table name component may contain wildcard characters
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^."]{1,128}|["].{1,128}["])$
Example Request (application/json)
{
    "$schema":"ogg:trandataTable",
    "operation":"add",
    "tableName":"hr.employees"
}
Back to Top

Response

Supported Media Types

200 Response

Supplemental logging command completed successfully.

Body ()
Root Schema : Manage Supplemental Logging for Database Tables
Type: object
Title: Manage Supplemental Logging for Database Tables
Match One
Show Source
Nested Schema : Manage Supplemental Logging for Database Tables-x-oneOf[0]
Type: object
Show Source
Nested Schema : Manage Supplemental Logging for Database Tables-x-oneOf[1]
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
  • Default Value: false
    True if supplemental logging for all columns of the table is enabled
  • columns
    Minimum Number of Items: 1
    Maximum Number of Items: 8192
    List of columns being logged
  • True if supplemental logging for this table is enabled
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
    Valid for SQL Server only. Filegroup tells SQL Server where to store trandata-related database objects.
  • Default Value: NONE
    Allowed Values: [ "NONE", "FULL", "ONLY_AFTER_IMAGES" ]
    Valid for Db2 for IBM i only. Indicates what form of journaling is enabled for the table
  • Minimum Length: 3
    Maximum Length: 23
    Pattern: ^([^.*?/]{1,10}[/][^.*?/]{1,10})$
    Valid for Db2 for IBM i only. Indicates which journal to read transaction data from.
  • Allowed Values: [ "lobsNever", "lobsAlways", "lobsIfChanged", "lobsAlwaysNoIndex", "noLobs", "invalid" ]
    Applicable to Sybase. Represents the LOB replication status for columns of type IMAGE, TEXT or UNITEXT
  • Valid for Oracle only. Optional logical replication status for this table
  • Default Value: false
    Valid for Oracle only. True if Partial JSON Update is enabled for this table
  • preparedCsn
    Prepared instantiation CSN
  • Default Value: true
    True if supplemental logging of primary key columns is enabled
  • Default Value: true
    True if supplemental logging of primary key, foreign key and unique key columns are enabled
  • tableName
Nested Schema : columns
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 8192
List of columns being logged
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : preparedCsn
Prepared instantiation CSN
Match One
Show Source
  • Minimum Value: 0
    Maximum Value: 9223372036854776000
    System Change Number(Normal Format) for Oracle Database.
    Example: 6488359
  • Minimum Length: 3
    Maximum Length: 64
    Pattern: [0-9]+[.][0-9]+
    System Change Number(Alternate Format) for Oracle Database.
    Example: 6488359.3456712
Nested Schema : tableName
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
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:9012/services/v2/connections/OracleGoldenGate.ggsouth/trandata/table",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/trandata/table",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-15132",
            "issued":"2024-04-03T22:36:20Z",
            "severity":"INFO",
            "title":"Logging of supplemental redo data enabled for table HR.EMPLOYEES.",
            "type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-30197",
            "issued":"2024-04-03T22:36:20Z",
            "severity":"INFO",
            "title":"Partial JSON Update is disabled on table HR.EMPLOYEES.",
            "type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-15133",
            "issued":"2024-04-03T22:36:20Z",
            "severity":"INFO",
            "title":"TRANDATA for scheduling columns has been added on table HR.EMPLOYEES.",
            "type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-15438",
            "issued":"2024-04-03T22:36:20Z",
            "severity":"INFO",
            "title":"Enabling logical replication (with all keys) on auto capture table HR.EMPLOYEES.",
            "type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
        },
        {
            "$schema":"ogg:message",
            "code":"OGG-15135",
            "issued":"2024-04-03T22:36:20Z",
            "severity":"INFO",
            "title":"TRANDATA for instantiation CSN has been added on table HR.EMPLOYEES.",
            "type":"https://docs.oracle.com/en/middleware/goldengate/core/23.4/error-messages/"
        }
    ]
}
Back to Top