Get Table¶

Get a table

URI Template

GET /api/archive/{instance}/tables/{name}

{instance}: Yamcs instance name.
{name}: Table name.

Response Type

interface TableInfo {

  // Table name
  name: string;
  keyColumn: ColumnInfo[];
  valueColumn: ColumnInfo[];
  script: string;
  histogramColumn: string[];
  storageEngine: string;
  formatVersion: number;
  tablespace: string;
  compressed: boolean;
  partitioningInfo: PartitioningInfo;
}

Related Types

interface ColumnInfo {

  // Colum name
  name: string;

  // Column type
  type: string;
  enumValue: EnumValue[];

  // Attribute indicating automatic auto increment upon
  // record insertion. Only set for table column info.
  autoIncrement: boolean;
}

interface EnumValue {
  value: number;
  label: string;
}

interface PartitioningInfo {
  type: PartitioningType;
  timeColumn: string;
  timePartitionSchema: string;
  valueColumn: string;
  valueColumnType: string;
}

enum PartitioningType {
  TIME = "TIME",
  VALUE = "VALUE",
  TIME_AND_VALUE = "TIME_AND_VALUE",
}