- Activities
- Alarms
- Audit
- Buckets
- Clearance
- Commands
- COP-1
- Database
- Events
- File Transfer
- IAM
- Indexes
- Instances
- Links
- MDB Override
- MDB
- Packets
- Parameter Archive
- Parameter Lists
- Parameter Values
- Processing
- Queues
- Replication
- RocksDB
- Server
- Services
- Sessions
- Stream Archive
- Table
- Time Correlation
- Time
- Timeline
Yamcs Server Manual
Yamcs Release Notes
Source Code Documentation
Get Table DataΒΆ
Get table data
URI Template
GET /api/archive/{instance}/tables/{name}/data
{instance}
Yamcs instance name.
{name}
Table name.
Query Parameters
cols
The columns to be included in the result. If unspecified, all table and/or additional tuple columns will be included.
pos
The zero-based row number at which to start outputting results. Default:
0
Note that in the current rocksdb storage engine there is no way to jump to a row by its number. This is why such a request will do a table scan and can be slow for large values of pos.limit
The maximum number of returned records per page. Choose this value too high and you risk hitting the maximum response size limit enforced by the server. Default:
100
order
The direction of the sort. Sorting is always done on the key of the table. Can be either
asc
ordesc
. Default:desc
Response Type
interface TableData {
record: TableRecord[];
}
Related Types
interface TableRecord {
column: ColumnData[];
}
interface ColumnData {
name: string;
value: Value;
}
// Union type for storing a value
interface Value {
type: Type;
floatValue: number;
doubleValue: number;
sint32Value: number;
uint32Value: number;
binaryValue: string; // Base64
stringValue: string;
timestampValue: string; // String decimal
uint64Value: string; // String decimal
sint64Value: string; // String decimal
booleanValue: boolean;
aggregateValue: AggregateValue;
arrayValue: Value[];
}
// An aggregate value is an ordered list of (member name, member value).
// Two arrays are used in order to be able to send just the values (since
// the names will not change)
interface AggregateValue {
name: string[];
value: Value[];
}
enum Type {
FLOAT = "FLOAT",
DOUBLE = "DOUBLE",
UINT32 = "UINT32",
SINT32 = "SINT32",
BINARY = "BINARY",
STRING = "STRING",
TIMESTAMP = "TIMESTAMP",
UINT64 = "UINT64",
SINT64 = "SINT64",
BOOLEAN = "BOOLEAN",
AGGREGATE = "AGGREGATE",
ARRAY = "ARRAY",
// Enumerated values have both an integer (sint64Value) and a string representation
ENUMERATED = "ENUMERATED",
NONE = "NONE",
}