Manage Table Supplemental Logging
post
/services/{version}/connections/{connection}/trandata/table
Manage Supplemental Logging for Database Tables
Request
Supported Media Types
- application/json
Path Parameters
-
connection: string
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.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
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:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:trandataTable" ]
-
allColumns(optional):
boolean
Default Value:
false
-
columns(optional):
array columns
Minimum Number of Items:
1
Maximum Number of Items:8192
-
fileGroup(optional):
string
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. -
operation:
Allowed Values:
[ "add" ]
-
prepareCsnMode(optional):
Default Value:
nowait
Allowed Values:[ "nowait", "wait", "lock", "none" ]
-
primaryKey(optional):
boolean
Default Value:
true
-
schedulingColumns(optional):
boolean
Default Value:
true
-
tableName:
tableName
Qualified table name where any name component may contain wildcard characters
Nested Schema : Manage Supplemental Logging for Database Tables-x-oneOf[1]
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:trandataTable" ]
-
allColumns(optional):
boolean
Default Value:
false
-
operation:
Allowed Values:
[ "delete" ]
-
schedulingColumns(optional):
boolean
Default Value:
true
-
tableName:
tableName
Qualified table name where any name component may contain wildcard characters
Nested Schema : Manage Supplemental Logging for Database Tables-x-oneOf[2]
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:trandataTable" ]
-
operation:
Allowed Values:
[ "info", "checkSupport" ]
-
tableName:
tableName
Qualified table name where the table name component may contain wildcard characters
Nested Schema : columns
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
8192
-
Array of:
string
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
Nested Schema : tableName
Qualified table name where any name component may contain wildcard characters
Match Any
Show Source
Nested Schema : tableName
Qualified table name where the table name component may contain wildcard characters
Match Any
Show Source
Example Request (application/json)
{
"operation":"add",
"tableName":"oggadmin.table01"
}
Response
Supported Media Types
- application/json
200 Response
Supplemental logging command completed successfully.
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:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:trandataTableResponse" ]
-
tables:
array tables
Minimum Number of Items:
1
Maximum Number of Items:65535
-
type:
Allowed Values:
[ "info" ]
Nested Schema : Manage Supplemental Logging for Database Tables-x-oneOf[1]
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:trandataTableResponse" ]
-
tables:
array tables
Minimum Number of Items:
1
Maximum Number of Items:65535
-
type:
Allowed Values:
[ "support" ]
Nested Schema : tables
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
65535
Nested Schema : items
Type:
Show Source
object
-
allColumns:
boolean
Default Value:
false
True if supplemental logging for all columns of the table is enabled -
columns(optional):
array columns
Minimum Number of Items:
1
Maximum Number of Items:8192
List of columns being logged -
enabled:
boolean
True if supplemental logging for this table is enabled
-
preparedCsn(optional):
preparedCsn
Prepared instantiation CSN
-
primaryKey:
boolean
Default Value:
true
True if supplemental logging of primary key columns is enabled -
schedulingColumns:
boolean
Default Value:
true
True if supplemental logging of primary key, foreign key and unique key columns are enabled -
tableName:
tableName
Nested Schema : columns
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
8192
List of columns being logged
Show Source
-
Array of:
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : tables
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
65535
Nested Schema : items
Type:
Show Source
object
-
$schema(optional):
Allowed Values:
[ "ogg:trandataTableSupport" ]
-
columns(optional):
array columns
Minimum Number of Items:
1
Maximum Number of Items:8192
-
details:
array details
Minimum Number of Items:
0
Maximum Number of Items:16
-
disqualifiedUniqueKey(optional):
array disqualifiedUniqueKey
Minimum Number of Items:
1
Maximum Number of Items:8192
-
oggKeycolList(optional):
array oggKeycolList
Minimum Number of Items:
1
Maximum Number of Items:8192
-
schemaName:
schemaName
Schema name for table
-
tableName:
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
Table name
Nested Schema : columns
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
8192
-
Array of:
object items
Description of a table column
Nested Schema : details
Type:
array
Minimum Number of Items:
0
Maximum Number of Items:
Show Source
16
Nested Schema : disqualifiedUniqueKey
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
Show Source
8192
-
Array of:
string
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:
Show Source
8192
-
Array of:
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : items
Type:
object
Description of a table column
Show Source
-
name:
string
Minimum Length:
1
Maximum Length:130
Pattern:^([^.*?"]{1,128}|["].{1,128}["])$
Column name in table -
type(optional):
string
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/table",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/connections/OracleGoldenGate.oggadmin/trandata/table",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
{
"$schema":"ogg:message",
"code":"OGG-15132",
"issued":"2021-07-13T16:39:45Z",
"severity":"INFO",
"title":"Logging of supplemental redo data enabled for table OGGADMIN.TABLE01.",
"type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-15132"
},
{
"$schema":"ogg:message",
"code":"OGG-15133",
"issued":"2021-07-13T16:39:45Z",
"severity":"INFO",
"title":"TRANDATA for scheduling columns has been added on table OGGADMIN.TABLE01.",
"type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-15133"
},
{
"$schema":"ogg:message",
"code":"OGG-15135",
"issued":"2021-07-13T16:39:45Z",
"severity":"INFO",
"title":"TRANDATA for instantiation CSN has been added on table OGGADMIN.TABLE01.",
"type":"http://docs.oracle.com/goldengate/c2130/gg-winux/GMESG/oggus.htm#OGG-15135"
}
]
}