LogMessage (com.oceanbase:oblogclient-common 1.1.2 API)

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

public class LogMessage
extends DataMessage.Record

嵌套类概要
- 从类继承的嵌套类/接口 com.oceanbase.oms.logmessage.DataMessage.Record
  DataMessage.Record.Field, DataMessage.Record.Type

字段概要

字段
限定符和类型字段和说明

static String DEFAULT_ENCODING

static String UTF8_ENCODING
- 从类继承的字段 com.oceanbase.oms.logmessage.DataMessage.Record
  attributes, fields, globalSafeTimestamp, safeTimestamp, TRACEID_STRING, txEnd, type, UTF8MB4_ENCODING

字段
限定符和类型	字段和说明
`static String`	`DEFAULT_ENCODING`
`static String`	`UTF8_ENCODING`

构造器概要

构造器
构造器和说明

LogMessage(boolean isCheckCRC)

构造器
构造器和说明
`LogMessage(boolean isCheckCRC)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`fieldListParse(FieldParseListener fieldParseListener)` filedParseListener
`io.netty.buffer.ByteBuf`	`getByteBuff()`
`String`	`getCheckpoint()`
`String`	`getDbName()`
`DbTypeEnum`	`getDbType()`
`String`	`getEncodingStr()`
`int`	`getFieldCount()`
`List<DataMessage.Record.Field>`	`getFieldList()` Get the field list.
`long`	`getFileNameOffset()`
`long`	`getFileOffset()`
`List<ByteString>`	`getFirstPKValue()`
`String`	`getId()`
`Set<String>`	`getKeysValue()` 获得pk uk value,combine
`long`	`getMetaVersion()`
`String`	`getOB10UniqueId()`
`DataMessage.Record.Type`	`getOpt()` Get the type of the record in insert, delete, update and heartbeat.
`List<int[]>`	`getPrimaryAndUniqueConstraintColumnIndexTuples()` Get tuples of index.
`List<Integer>`	`getPrimaryKeyIndex()`
`String`	`getPrimaryKeys()`
`List<String>`	`getPrimaryKeysList()`
`List<String>`	`getPrimaryKeyValue()` 获取主键value
`List<String>`	`getPrimaryValues()`
`byte[]`	`getRawData()` Get the primary data to avoid parsing
`String`	`getServerId()`
`String`	`getTableName()`
`String`	`getThreadId()`
`List<Long>`	`getTimeMarks()`
`String`	`getTimestamp()`
`String`	`getTimestampUsec()`
`String`	`getTraceId()`
`String`	`getUniqueColNames()`
`int`	`getVersion()`
`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`	`parse(byte[] data)`
`void`	`releaseContents()`
`void`	`setByteBuf(io.netty.buffer.ByteBuf byteBuf)` 解析buffer
`String`	`toString()`

从类继承的方法 com.oceanbase.oms.logmessage.DataMessage.Record
addAttribute, getAttribute, getAttributes, getIsConnectionFirstRecord, getLogSeqNum, getMessageUniqueId, getMessageUniqueIdStr, getMetadataVersion, getPrevId, getPrevServerSeq, getRegionId, getSafeTimestamp, getServerSeq, getTraceInfo, mergeFrom, setColFilter, setIsConnectionFirstRecord, setRegionId, setType

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

- 字段详细资料
  - DEFAULT_ENCODING
```
public static final String DEFAULT_ENCODING
```
    另请参阅:
    
    常量字段值
  - UTF8_ENCODING
```
public static final String UTF8_ENCODING
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - LogMessage
```
public LogMessage(boolean isCheckCRC)
```
- 方法详细资料
  - isKeyChange
```
public boolean isKeyChange()
```
    覆盖:
    
    isKeyChange 在类中 DataMessage.Record
  - getVersion
```
public int getVersion()
```
  - getDbType
```
public DbTypeEnum getDbType()
```
    覆盖:
    
    getDbType 在类中 DataMessage.Record
  - isQueryBack
```
public boolean isQueryBack()
```
    覆盖:
    
    isQueryBack 在类中 DataMessage.Record
  - isFirstInLogEvent
```
public boolean isFirstInLogEvent()
```
    从类复制的说明: DataMessage.Record
    
    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
    
    覆盖:
    
    isFirstInLogEvent 在类中 DataMessage.Record
    
    返回:
    
    true if this is the first record
  - getOpt
```
public DataMessage.Record.Type getOpt()
```
    从类复制的说明: DataMessage.Record
    
    Get the type of the record in insert, delete, update and heartbeat.
    
    覆盖:
    
    getOpt 在类中 DataMessage.Record
    
    返回:
    
    the type of the record.
  - getId
```
public String getId()
```
    覆盖:
    
    getId 在类中 DataMessage.Record
  - getDbName
```
public String getDbName()
```
    覆盖:
    
    getDbName 在类中 DataMessage.Record
  - getTableName
```
public String getTableName()
```
    覆盖:
    
    getTableName 在类中 DataMessage.Record
  - getCheckpoint
```
public String getCheckpoint()
```
    覆盖:
    
    getCheckpoint 在类中 DataMessage.Record
  - getTimestamp
```
public String getTimestamp()
```
    覆盖:
    
    getTimestamp 在类中 DataMessage.Record
  - getServerId
```
public String getServerId()
```
    覆盖:
    
    getServerId 在类中 DataMessage.Record
  - fieldListParse
```
public void fieldListParse(FieldParseListener fieldParseListener)
                    throws Exception
```
    从类复制的说明: DataMessage.Record
    
    filedParseListener
    
    覆盖:
    
    fieldListParse 在类中 DataMessage.Record
    
    参数:
    
    fieldParseListener - fieldParseListener
    
    抛出:
    
    Exception - if an exception occurs
  - getFieldList
```
public List<DataMessage.Record.Field> getFieldList()
```
    从类复制的说明: DataMessage.Record
    
    Get the field list.
    
    覆盖:
    
    getFieldList 在类中 DataMessage.Record
    
    返回:
    
    the field list.
  - getFieldCount
```
public int getFieldCount()
```
    覆盖:
    
    getFieldCount 在类中 DataMessage.Record
  - getPrimaryKeyIndex
```
public List<Integer> getPrimaryKeyIndex()
```
  - parse
```
public void parse(byte[] data)
           throws Exception
```
    覆盖:
    
    parse 在类中 DataMessage.Record
    
    抛出:
    
    Exception
  - getRawData
```
public byte[] getRawData()
```
    Get the primary data to avoid parsing
    
    覆盖:
    
    getRawData 在类中 DataMessage.Record
    
    返回:
    
    primary data
  - setByteBuf
```
public void setByteBuf(io.netty.buffer.ByteBuf byteBuf)
                throws Exception
```
    解析buffer
    
    参数:
    
    byteBuf - ByteBuf
    
    抛出:
    
    Exception - 解析出错
  - getTraceId
```
public String getTraceId()
```
    覆盖:
    
    getTraceId 在类中 DataMessage.Record
  - getOB10UniqueId
```
public String getOB10UniqueId()
```
    覆盖:
    
    getOB10UniqueId 在类中 DataMessage.Record
  - getThreadId
```
public String getThreadId()
                   throws Exception
```
    覆盖:
    
    getThreadId 在类中 DataMessage.Record
    
    抛出:
    
    Exception
  - getKeysValue
```
public Set<String> getKeysValue()
```
    获得pk uk value,combine
    
    覆盖:
    
    getKeysValue 在类中 DataMessage.Record
    
    返回:
    
    key集合
  - getPrimaryValues
```
public List<String> getPrimaryValues()
```
    覆盖:
    
    getPrimaryValues 在类中 DataMessage.Record
  - getPrimaryKeyValue
```
public List<String> getPrimaryKeyValue()
```
    获取主键value
    
    覆盖:
    
    getPrimaryKeyValue 在类中 DataMessage.Record
    
    返回:
    
    主键列的列表
  - 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}
    
    覆盖:
    
    getPrimaryAndUniqueConstraintColumnIndexTuples 在类中 DataMessage.Record
    
    返回:
    
    the tuples of index for primary and unique constraints.
  - getFirstPKValue
```
public List<ByteString> getFirstPKValue()
```
    覆盖:
    
    getFirstPKValue 在类中 DataMessage.Record
  - getPrimaryKeysList
```
public List<String> getPrimaryKeysList()
```
    覆盖:
    
    getPrimaryKeysList 在类中 DataMessage.Record
  - getPrimaryKeys
```
public String getPrimaryKeys()
```
    覆盖:
    
    getPrimaryKeys 在类中 DataMessage.Record
  - getMetaVersion
```
public long getMetaVersion()
```
  - getUniqueColNames
```
public String getUniqueColNames()
```
    覆盖:
    
    getUniqueColNames 在类中 DataMessage.Record
  - getTimeMarks
```
public List<Long> getTimeMarks()
                        throws IOException
```
    抛出:
    
    IOException
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 DataMessage.Record
  - getTimestampUsec
```
public String getTimestampUsec()
                        throws IOException
```
    覆盖:
    
    getTimestampUsec 在类中 DataMessage.Record
    
    抛出:
    
    IOException
  - getEncodingStr
```
public String getEncodingStr()
```
  - getFileNameOffset
```
public long getFileNameOffset()
```
  - getFileOffset
```
public long getFileOffset()
```
  - getByteBuff
```
public io.netty.buffer.ByteBuf getByteBuff()
```
  - releaseContents
```
public void releaseContents()
```

类 LogMessage

嵌套类概要

从类继承的嵌套类/接口 com.oceanbase.oms.logmessage.DataMessage.Record

字段概要

从类继承的字段 com.oceanbase.oms.logmessage.DataMessage.Record

构造器概要

方法概要

从类继承的方法 com.oceanbase.oms.logmessage.DataMessage.Record

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

字段详细资料

DEFAULT_ENCODING

UTF8_ENCODING

构造器详细资料

LogMessage

方法详细资料

isKeyChange

getVersion

getDbType

isQueryBack

isFirstInLogEvent

getOpt

getId

getDbName

getTableName

getCheckpoint

getTimestamp

getServerId

fieldListParse

getFieldList

getFieldCount

getPrimaryKeyIndex

parse

getRawData

setByteBuf

getTraceId

getOB10UniqueId

getThreadId

getKeysValue

getPrimaryValues

getPrimaryKeyValue

getPrimaryAndUniqueConstraintColumnIndexTuples

getFirstPKValue

getPrimaryKeysList

getPrimaryKeys

getMetaVersion

getUniqueColNames

getTimeMarks

toString

getTimestampUsec

getEncodingStr

getFileNameOffset

getFileOffset

getByteBuff

releaseContents