greptimedb/tests/cases/standalone/common/information_schema/table_semantics.sql

DESC TABLE information_schema.table_semantics;

CREATE TABLE metrics_tagged (
  ts TIMESTAMP TIME INDEX,
  val DOUBLE,
)
WITH (
  'greptime.semantic.signal_type' = 'metric',
  'greptime.semantic.source' = 'opentelemetry',
  'greptime.semantic.source_version' = '2.0',
  'greptime.semantic.pipeline' = 'greptime_metric_v1',
  'greptime.semantic.metric.metadata_quality' = 'declared',
  'greptime.semantic.metric.type' = 'counter',
  'greptime.semantic.metric.unit' = 'By'
);

CREATE TABLE traces_tagged (
  ts TIMESTAMP TIME INDEX,
  span_name STRING,
)
WITH (
  'greptime.semantic.signal_type' = 'trace',
  'greptime.semantic.source' = 'opentelemetry',
  'greptime.semantic.trace.conventions' = 'https://opentelemetry.io/schemas/1.27.0'
);

-- A table with no semantic options must not appear in the view.
CREATE TABLE plain_table (
  ts TIMESTAMP TIME INDEX,
  val DOUBLE,
);

SELECT table_schema, table_name, signal_type, source, source_version, pipeline, metadata_quality, semantic_options
FROM information_schema.table_semantics
WHERE table_schema = 'public'
ORDER BY table_name;

-- System table scope is exposed without changing the view's columns.
SELECT table_name, semantic_options
FROM information_schema.table_semantics
WHERE table_schema = 'information_schema'
  AND table_name IN ('build_info', 'partitions', 'process_list', 'table_semantics')
ORDER BY table_name;

-- Predicate pushdown on a promoted column.
SELECT table_name, signal_type
FROM information_schema.table_semantics
WHERE signal_type = 'metric'
ORDER BY table_name;

DROP TABLE metrics_tagged;

DROP TABLE traces_tagged;

DROP TABLE plain_table;

-- ALTER TABLE manages semantic declarations on existing tables: SET appears in
-- the view, UNSET disappears from it.
CREATE TABLE altered_semantics (
  ts TIMESTAMP TIME INDEX,
  svc STRING,
  payload BINARY,
  val DOUBLE,
);

ALTER TABLE altered_semantics SET 'greptime.semantic.signal_type' = 'metric', 'greptime.semantic.entity.service.id' = 'svc';

SELECT table_name, signal_type, semantic_options
FROM information_schema.table_semantics
WHERE table_name = 'altered_semantics';

-- Semantic options never share a statement with regular table options.
ALTER TABLE altered_semantics SET 'greptime.semantic.source' = 'prometheus', 'ttl' = '7d';

-- Unknown semantic keys are rejected on SET.
ALTER TABLE altered_semantics SET 'greptime.semantic.nonsense' = 'x';

-- Values outside the key's domain are rejected.
ALTER TABLE altered_semantics SET 'greptime.semantic.signal_type' = 'garbage';

-- Entity columns must exist.
ALTER TABLE altered_semantics SET 'greptime.semantic.entity.host.id' = 'no_such_column';

-- Entity columns must render as strings.
ALTER TABLE altered_semantics SET 'greptime.semantic.entity.host.id' = 'payload';

ALTER TABLE altered_semantics UNSET 'greptime.semantic.entity.service.id';

SELECT table_name, signal_type, semantic_options
FROM information_schema.table_semantics
WHERE table_name = 'altered_semantics';

DROP TABLE altered_semantics;

-- Logical metric tables take the same metadata-only path.
CREATE TABLE phy_sem (ts TIMESTAMP TIME INDEX, val DOUBLE) engine=metric with ("physical_metric_table" = "");

CREATE TABLE logical_sem (ts TIMESTAMP TIME INDEX, val DOUBLE, host STRING PRIMARY KEY) engine=metric with ("on_physical_table" = "phy_sem");

ALTER TABLE logical_sem SET 'greptime.semantic.signal_type' = 'metric', 'greptime.semantic.entity.host.id' = 'host';

SELECT table_name, signal_type, semantic_options
FROM information_schema.table_semantics
WHERE table_name = 'logical_sem';

-- Regular options still cannot be altered on logical tables.
ALTER TABLE logical_sem SET 'ttl' = '7d';

ALTER TABLE logical_sem UNSET 'greptime.semantic.entity.host.id';

SELECT table_name, signal_type, semantic_options
FROM information_schema.table_semantics
WHERE table_name = 'logical_sem';

DROP TABLE logical_sem;

DROP TABLE phy_sem;

-- entity_declarations reports what a table actually contributes to the graph,
-- including the declarations the built-in conventions derive. A whitelisted
-- OTel descriptor table declares its entities without any entity option, and
-- the generic container records the identity it yields to.
CREATE TABLE greptime_otel_resource_info (
  greptime_timestamp TIMESTAMP TIME INDEX,
  greptime_value DOUBLE,
  "job" STRING,
  "instance" STRING,
  "service.name" STRING,
  "host.id" STRING,
  "container.id" STRING,
  "container.name" STRING,
  "k8s.pod.uid" STRING,
  "k8s.pod.name" STRING,
  "k8s.container.name" STRING,
  PRIMARY KEY ("job", "instance", "service.name", "host.id", "container.id", "container.name", "k8s.pod.uid", "k8s.pod.name", "k8s.container.name")
)
WITH (
  'greptime.semantic.signal_type' = 'metric',
  'greptime.semantic.source' = 'opentelemetry',
  'greptime.semantic.metric.type' = 'info'
);

SELECT table_name, entity_declarations
FROM information_schema.table_semantics
WHERE table_name = 'greptime_otel_resource_info';

-- The same table under the wrong source stamp derives nothing: the column is
-- empty and `source` names the reason.
CREATE TABLE kube_pod_info (
  greptime_timestamp TIMESTAMP TIME INDEX,
  greptime_value DOUBLE,
  "namespace" STRING,
  "pod" STRING,
  "uid" STRING,
  "node" STRING,
  PRIMARY KEY ("namespace", "pod", "uid", "node")
)
WITH (
  'greptime.semantic.signal_type' = 'metric',
  'greptime.semantic.source' = 'influxdb'
);

SELECT table_name, source, entity_declarations
FROM information_schema.table_semantics
WHERE table_name = 'kube_pod_info';

ALTER TABLE kube_pod_info SET 'greptime.semantic.source' = 'prometheus';

SELECT table_name, source, entity_declarations
FROM information_schema.table_semantics
WHERE table_name = 'kube_pod_info';

DROP TABLE greptime_otel_resource_info;

DROP TABLE kube_pod_info;

-- A missing id column drops that entity alone: without `uid` there is no
-- k8s.pod, and the k8s.node next to it still lands.
CREATE TABLE kube_pod_info (
  greptime_timestamp TIMESTAMP TIME INDEX,
  greptime_value DOUBLE,
  "namespace" STRING,
  "pod" STRING,
  "node" STRING,
  PRIMARY KEY ("namespace", "pod", "node")
)
WITH (
  'greptime.semantic.signal_type' = 'metric',
  'greptime.semantic.source' = 'prometheus'
);

SELECT table_name, entity_declarations
FROM information_schema.table_semantics
WHERE table_name = 'kube_pod_info';

DROP TABLE kube_pod_info;

-- A trace table carries no semantic option at all, yet the conventions derive
-- its entities: it must still be visible here, or the view cannot answer why
-- it is in the graph.
CREATE TABLE traces_untagged (
  "timestamp" TIMESTAMP(9) TIME INDEX,
  trace_id STRING,
  span_id STRING,
  service_name STRING,
  "resource_attributes.host.id" STRING,
  PRIMARY KEY (service_name)
) WITH ('table_data_model' = 'greptime_trace_v1', 'append_mode' = 'true');

SELECT table_name, signal_type, semantic_options, entity_declarations
FROM information_schema.table_semantics
WHERE table_name = 'traces_untagged';

DROP TABLE traces_untagged;