com.netease.arctic.table.MetadataColumns Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of arctic-spark-3.1-runtime Show documentation
The newest version!
/*
 * 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 com.netease.arctic.table;

import com.netease.arctic.shade.org.apache.iceberg.types.Types;
import com.netease.arctic.shade.org.apache.iceberg.types.Types.NestedField;

/**
 * Addition metadata columns for {@link ArcticTable}
 */
public class MetadataColumns {

  // IDs Integer.MAX_VALUE - (1001-9999) are used for arctic metadata columns
  public static final String TRANSACTION_ID_FILED_NAME = "_transaction_id";
  public static final int TRANSACTION_ID_FILED_ID = Integer.MAX_VALUE - 1001;
  public static final NestedField TRANSACTION_ID_FILED = NestedField
      .optional(TRANSACTION_ID_FILED_ID, TRANSACTION_ID_FILED_NAME, Types.LongType.get());

  public static final String FILE_OFFSET_FILED_NAME = "_file_offset";
  public static final int FILE_OFFSET_FILED_ID = Integer.MAX_VALUE - 1002;
  public static final NestedField FILE_OFFSET_FILED = NestedField
      .optional(FILE_OFFSET_FILED_ID, FILE_OFFSET_FILED_NAME, Types.LongType.get());

  public static final String CHANGE_ACTION_NAME = "_change_action";
  public static final int CHANGE_ACTION_ID = Integer.MAX_VALUE - 1003;
  public static final NestedField CHANGE_ACTION_FIELD = NestedField
      .optional(CHANGE_ACTION_ID, CHANGE_ACTION_NAME, Types.StringType.get());

  private MetadataColumns() {
  }

}