DataMessage.Record (com.oceanbase:oblogclient-common 1.1.2 API)

java.lang.Object
- com.oceanbase.oms.logmessage.DataMessage.Record

直接已知子类:

LogMessage

封闭类:

DataMessage
```
public static class DataMessage.Record
extends Object
```
Record contains data of one record.

嵌套类概要

嵌套类
限定符和类型类和说明

static class DataMessage.Record.Field
Field contains data of one field

static class DataMessage.Record.Type

嵌套类
限定符和类型	类和说明
`static class`	`DataMessage.Record.Field` Field contains data of one field
`static class`	`DataMessage.Record.Type`

字段概要

字段
限定符和类型	字段和说明
`protected Map<String,String>`	`attributes`
`protected List<DataMessage.Record.Field>`	`fields`
`protected static ThreadLocal<String>`	`globalSafeTimestamp`
`protected String`	`safeTimestamp`
`protected String`	`timestamp`
`static String`	`TRACEID_STRING`
`protected static ThreadLocal<Boolean>`	`txEnd`
`protected DataMessage.Record.Type`	`type`
`static String`	`UTF8MB4_ENCODING`

构造器概要

构造器
构造器和说明

Record()

构造器
构造器和说明
`Record()`

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法和说明
`void`	`addAttribute(String key, String value)` Add one attribute to the record.
`void`	`fieldListParse(FieldParseListener fieldParseListener)` filedParseListener
`String`	`getAttribute(String key)`
`Map<String,String>`	`getAttributes()`
`String`	`getCheckpoint()`
`String`	`getDbName()`
`DbTypeEnum`	`getDbType()`
`int`	`getFieldCount()`
`List<DataMessage.Record.Field>`	`getFieldList()` Get the field list.
`List<ByteString>`	`getFirstPKValue()`
`String`	`getId()`
`boolean`	`getIsConnectionFirstRecord()`
`Set<String>`	`getKeysValue()`
`Long`	`getLogSeqNum()`
`long`	`getMessageUniqueId()`
`String`	`getMessageUniqueIdStr()`
`String`	`getMetadataVersion()` 已过时。
`String`	`getOB10UniqueId()`
`DataMessage.Record.Type`	`getOpt()` Get the type of the record in insert, delete, update and heartbeat.
`String`	`getPrevId()`
`String`	`getPrevServerSeq()`
`List<int[]>`	`getPrimaryAndUniqueConstraintColumnIndexTuples()` Get tuples of index.
`String`	`getPrimaryKeys()`
`List<String>`	`getPrimaryKeysList()`
`List<String>`	`getPrimaryKeyValue()`
`List<String>`	`getPrimaryValues()`
`byte[]`	`getRawData()`
`String`	`getRegionId()`
`String`	`getSafeTimestamp()`
`String`	`getServerId()`
`String`	`getServerSeq()`
`String`	`getTableName()`
`String`	`getThreadId()`
`String`	`getTimestamp()`
`String`	`getTimestampUsec()`
`String`	`getTraceId()`
`String`	`getTraceInfo()`
`String`	`getUniqueColNames()`
`boolean`	`isFirstInLogEvent()` Now the api takes on different behavior between MYSQL and OCEANBASE, for MYSQL, it returns true because the record is the LAST record in the logevent, while for OCEANBASE, it is true because the record is the first one.
`boolean`	`isKeyChange()`
`boolean`	`isQueryBack()`
`void`	`mergeFrom(DataInputStream reader)` Abstract record information from the DataInputStream.
`void`	`parse(byte[] data)`
`void`	`setColFilter(List<String> colFilter)`
`void`	`setIsConnectionFirstRecord(boolean value)`
`void`	`setRegionId(String regionId)`
`void`	`setType(DataMessage.Record.Type type)` Set the type of the record.
`String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

字段详细资料

UTF8MB4_ENCODING

public static final String UTF8MB4_ENCODING

另请参阅:: 常量字段值

TRACEID_STRING

public static final String TRACEID_STRING

另请参阅:: 常量字段值

type
```
protected DataMessage.Record.Type type
```

attributes

protected Map<String,String> attributes

fields

protected List<DataMessage.Record.Field> fields

timestamp
```
protected String timestamp
```

safeTimestamp
```
protected String safeTimestamp
```

globalSafeTimestamp

protected static ThreadLocal<String> globalSafeTimestamp

txEnd

protected static ThreadLocal<Boolean> txEnd

构造器详细资料
- Record
```
public Record()
```

方法详细资料

setColFilter

public void setColFilter(List<String> colFilter)

getPrimaryKeyValue

public List<String> getPrimaryKeyValue()

getKeysValue

public Set<String> getKeysValue()
                         throws Exception

抛出:: Exception

getPrimaryValues

public List<String> getPrimaryValues()
                              throws Exception

抛出:: Exception

getRegionId
```
public String getRegionId()
```

setRegionId

public void setRegionId(String regionId)

getFirstPKValue

public List<ByteString> getFirstPKValue()

setIsConnectionFirstRecord

public void setIsConnectionFirstRecord(boolean value)

getIsConnectionFirstRecord

public boolean getIsConnectionFirstRecord()

getLogSeqNum
```
public Long getLogSeqNum()
```

mergeFrom
```
public void mergeFrom(DataInputStream reader)
               throws IOException
```
Abstract record information from the DataInputStream.

参数:

reader - is the input stream.

抛出:

IOException - if an I/O error occurs

getOpt
```
public DataMessage.Record.Type getOpt()
```
Get the type of the record in insert, delete, update and heartbeat.

返回:

the type of the record.

getId
```
public String getId()
```

getDbName
```
public String getDbName()
```

getTableName
```
public String getTableName()
```

getCheckpoint
```
public String getCheckpoint()
```

getMetadataVersion

@Deprecated
public String getMetadataVersion()

已过时。

getTimestamp
```
public String getTimestamp()
```

getTimestampUsec

public String getTimestampUsec()
                        throws IOException

抛出:: IOException

getSafeTimestamp
```
public String getSafeTimestamp()
```

getServerId
```
public String getServerId()
```

getPrevId
```
public String getPrevId()
```

getServerSeq
```
public String getServerSeq()
```

getPrevServerSeq
```
public String getPrevServerSeq()
```

getPrimaryAndUniqueConstraintColumnIndexTuples
```
public List<int[]> getPrimaryAndUniqueConstraintColumnIndexTuples()
```
Get tuples of index. For example, column 1 is the primary key and column 2 and 3 are unique keys. The returned format is the list of two arrays, the first array is {0} and the seconds array is {1,2}

返回:

the tuples of index for primary and unique constraints.

getPrimaryKeys
```
public String getPrimaryKeys()
```

isKeyChange
```
public boolean isKeyChange()
```

getPrimaryKeysList

public List<String> getPrimaryKeysList()

getTraceInfo
```
public String getTraceInfo()
```

getOB10UniqueId

public String getOB10UniqueId()
                       throws Exception

抛出:: Exception

getUniqueColNames
```
public String getUniqueColNames()
```

getDbType
```
public DbTypeEnum getDbType()
```

isQueryBack
```
public boolean isQueryBack()
```

isFirstInLogEvent
```
public boolean isFirstInLogEvent()
```
Now the api takes on different behavior between MYSQL and OCEANBASE, for MYSQL, it returns true because the record is the LAST record in the logevent, while for OCEANBASE, it is true because the record is the first one. TBD: server for mysql need change its behavior the same as OCEANBASE

返回:

true if this is the first record

getAttribute

public String getAttribute(String key)

getAttributes

public Map<String,String> getAttributes()

getFieldCount
```
public int getFieldCount()
```

getFieldList

public List<DataMessage.Record.Field> getFieldList()

Get the field list.

返回:: the field list.

fieldListParse
```
public void fieldListParse(FieldParseListener fieldParseListener)
                    throws Exception
```
filedParseListener

参数:

fieldParseListener - fieldParseListener

抛出:

Exception - if an exception occurs

setType
```
public void setType(DataMessage.Record.Type type)
```
Set the type of the record.

参数:

type - one in insert, delete, update and heartbeat.

addAttribute
```
public void addAttribute(String key,
                         String value)
```
Add one attribute to the record.

参数:

key - the name of the attribute.

value - the value of the attribute.

getRawData
```
public byte[] getRawData()
```

getThreadId

public String getThreadId()
                   throws Exception

抛出:: Exception

getTraceId

public String getTraceId()
                  throws Exception

抛出:: Exception

parse

public void parse(byte[] data)
           throws Exception

抛出:: Exception

getMessageUniqueId

public long getMessageUniqueId()
                        throws Exception

抛出:: Exception

getMessageUniqueIdStr

public String getMessageUniqueIdStr()
                             throws Exception

抛出:: Exception

toString
```
public String toString()
```
覆盖:

toString 在类中 Object

类 DataMessage.Record

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

UTF8MB4_ENCODING

TRACEID_STRING

type

attributes

fields

timestamp

safeTimestamp

globalSafeTimestamp

txEnd

构造器详细资料

Record

方法详细资料

setColFilter

getPrimaryKeyValue

getKeysValue

getPrimaryValues

getRegionId

setRegionId

getFirstPKValue

setIsConnectionFirstRecord

getIsConnectionFirstRecord

getLogSeqNum

mergeFrom

getOpt

getId

getDbName

getTableName

getCheckpoint

getMetadataVersion

getTimestamp

getTimestampUsec

getSafeTimestamp

getServerId

getPrevId

getServerSeq

getPrevServerSeq

getPrimaryAndUniqueConstraintColumnIndexTuples

getPrimaryKeys

isKeyChange

getPrimaryKeysList

getTraceInfo

getOB10UniqueId

getUniqueColNames

getDbType

isQueryBack

isFirstInLogEvent

getAttribute

getAttributes

getFieldCount

getFieldList

fieldListParse

setType

addAttribute

getRawData

getThreadId

getTraceId

parse

getMessageUniqueId

getMessageUniqueIdStr

toString