loki/pkg/dataobj/internal/metadata/indexpointersmd/indexpointersmd.proto

// indexpointersmd.proto holds metadata for the indexpointers section of a data object. The
// indexpointers contains references to other dataobjects in storage, intended for use with indexing.
syntax = "proto3";

package dataobj.metadata.indexpointers.v1;

import "pkg/dataobj/internal/metadata/datasetmd/datasetmd.proto";

option go_package = "github.com/grafana/loki/v3/pkg/dataobj/internal/metadata/indexpointersmd";

// Metadata describes the metadata for the indexpointers section.
message Metadata {
  // Columns within the indexpointers section.
  repeated ColumnDesc columns = 1;

  // Section sort information.
  dataobj.metadata.dataset.v1.SectionSortInfo sort_info = 2;
}

// ColumnDesc describes an individual column within the indexpointers table.
message ColumnDesc {
  // Information about the column.
  dataobj.metadata.dataset.v1.ColumnInfo info = 1;

  // Column type.
  ColumnType type = 2;
}

// ColumnType represents the valid types that a indexpointer's column can have.
enum ColumnType {
  // Invalid column type.
  COLUMN_TYPE_UNSPECIFIED = 0;

  // COLUMN_TYPE_PATH is a column containing the data object path in object storage.
  COLUMN_TYPE_PATH = 1;

  // COLUMN_TYPE_MIN_TIMESTAMP is a column containing the minimum timestamp of
  // a data object.
  COLUMN_TYPE_MIN_TIMESTAMP = 2;

  // COLUMN_TYPE_MAX_TIMESTAMP is a column containing the maximum timestamp of
  // a data object.
  COLUMN_TYPE_MAX_TIMESTAMP = 3;
}

// ColumnMetadata describes the metadata for a column.
message ColumnMetadata {
  // Pages within the column.
  repeated PageDesc pages = 1;
}

// PageDesc describes an individual page within a column.
message PageDesc {
  // Information about the page.
  dataobj.metadata.dataset.v1.PageInfo info = 1;
}