ModifyCommentOperationLog.java

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package org.apache.doris.persist;

import org.apache.doris.common.io.Text;
import org.apache.doris.common.io.Writable;
import org.apache.doris.persist.gson.GsonUtils;

import com.google.gson.annotations.SerializedName;

import java.io.DataInput;
import java.io.DataOutput;
import java.io.IOException;
import java.util.Map;

// Persist the info when removing batch of expired txns
public class ModifyCommentOperationLog implements Writable {

    public enum Type {
        COLUMN, TABLE
    }

    @SerializedName(value = "type")
    private Type type;
    @SerializedName(value = "dbId")
    private long dbId;
    @SerializedName(value = "tblId")
    private long tblId;
    @SerializedName(value = "colToComment")
    // col name to comment
    private Map<String, String> colToComment;
    @SerializedName(value = "tblComment")
    private String tblComment;

    private ModifyCommentOperationLog(Type type, long dbId, long tblId,
            Map<String, String> colToComment, String tblComment) {
        this.type = type;
        this.dbId = dbId;
        this.tblId = tblId;
        this.colToComment = colToComment;
        this.tblComment = tblComment;
    }

    public static ModifyCommentOperationLog forColumn(long dbId, long tblId, Map<String, String> colToComment) {
        return new ModifyCommentOperationLog(Type.COLUMN, dbId, tblId, colToComment, null);
    }

    public static ModifyCommentOperationLog forTable(long dbId, long tblId, String comment) {
        return new ModifyCommentOperationLog(Type.TABLE, dbId, tblId, null, comment);
    }

    public Type getType() {
        return type;
    }

    public long getDbId() {
        return dbId;
    }

    public long getTblId() {
        return tblId;
    }

    public Map<String, String> getColToComment() {
        return colToComment;
    }

    public String getTblComment() {
        return tblComment;
    }

    @Override
    public void write(DataOutput out) throws IOException {
        String json = GsonUtils.GSON.toJson(this);
        Text.writeString(out, json);
    }

    public static ModifyCommentOperationLog read(DataInput in) throws IOException {
        String json = Text.readString(in);
        return GsonUtils.GSON.fromJson(json, ModifyCommentOperationLog.class);
    }

    public String toJson() {
        return GsonUtils.GSON.toJson(this);
    }
}