greptimedb/common_event_recorder/event_table/index.html

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `event_table` mod in crate `common_event_recorder`."><title>common_event_recorder::event_table - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-1ed95124.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="common_event_recorder" data-themes="" data-resource-suffix="" data-rustdoc-version="1.98.1 (48a229cea 2026-09-01)" data-channel="1.98.1" data-search-js="search-9944d736.js" data-stringdex-js="stringdex-2da4960a.js" data-settings-js="settings-170eb4bf.js" ><script src="../../static.files/storage-41dd4d93.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-417ebf0a.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-f7c3ffd8.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><a class="skip-main-content" href="#main-content">Skip to main content</a><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module event_table</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../common_event_recorder/index.html">common_<wbr>event_<wbr>recorder</a><span class="version">1.4.0-alpha.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module event_<wbr>table</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate common_<wbr>event_<wbr>recorder</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content" tabindex="-1"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">common_event_recorder</a></div><h1>Module <span>event_<wbr>table</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/common_event_recorder/event_table.rs.html#15-312">Source</a> </span></div><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.EventTableColumn.html" title="struct common_event_recorder::event_table::EventTableColumn">Event<wbr>Table<wbr>Column</a></dt><dd>A canonical column in the shared event table.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.ACTOR_COLUMN.html" title="constant common_event_recorder::event_table::ACTOR_COLUMN">ACTOR_<wbr>COLUMN</a></dt><dd>The effective database user that initiated an event.</dd><dt><a class="constant" href="constant.ADMIN_FUNCTION_NAME_COLUMN.html" title="constant common_event_recorder::event_table::ADMIN_FUNCTION_NAME_COLUMN">ADMIN_<wbr>FUNCTION_<wbr>NAME_<wbr>COLUMN</a></dt><dd>The canonical ADMIN function name field.</dd><dt><a class="constant" href="constant.ADMIN_FUNCTION_OUTPUT_COLUMN.html" title="constant common_event_recorder::event_table::ADMIN_FUNCTION_OUTPUT_COLUMN">ADMIN_<wbr>FUNCTION_<wbr>OUTPUT_<wbr>COLUMN</a></dt><dd>The canonical ADMIN function output field.</dd><dt><a class="constant" href="constant.ADMIN_FUNCTION_STATUS_COLUMN.html" title="constant common_event_recorder::event_table::ADMIN_FUNCTION_STATUS_COLUMN">ADMIN_<wbr>FUNCTION_<wbr>STATUS_<wbr>COLUMN</a></dt><dd>The canonical ADMIN function execution status field.</dd><dt><a class="constant" href="constant.CATALOG_NAME_COLUMN.html" title="constant common_event_recorder::event_table::CATALOG_NAME_COLUMN">CATALOG_<wbr>NAME_<wbr>COLUMN</a></dt><dd>The canonical catalog name dimension.</dd><dt><a class="constant" href="constant.EVENT_CONTEXT_COLUMN.html" title="constant common_event_recorder::event_table::EVENT_CONTEXT_COLUMN">EVENT_<wbr>CONTEXT_<wbr>COLUMN</a></dt><dd>The optional context describing why an event was triggered.</dd><dt><a class="constant" href="constant.FLOW_ID_COLUMN.html" title="constant common_event_recorder::event_table::FLOW_ID_COLUMN">FLOW_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical Flow identifier dimension.</dd><dt><a class="constant" href="constant.FLOW_NAME_COLUMN.html" title="constant common_event_recorder::event_table::FLOW_NAME_COLUMN">FLOW_<wbr>NAME_<wbr>COLUMN</a></dt><dd>The canonical Flow name dimension.</dd><dt><a class="constant" href="constant.GC_REPORT_COLUMN.html" title="constant common_event_recorder::event_table::GC_REPORT_COLUMN">GC_<wbr>REPORT_<wbr>COLUMN</a></dt><dd>The canonical per-region GC report field.</dd><dt><a class="constant" href="constant.LATEST_OFFSET_COLUMN.html" title="constant common_event_recorder::event_table::LATEST_OFFSET_COLUMN">LATEST_<wbr>OFFSET_<wbr>COLUMN</a></dt><dd>The canonical Kafka latest offset, which is an exclusive upper bound.</dd><dt><a class="constant" href="constant.PARENT_PROCEDURE_ID_COLUMN.html" title="constant common_event_recorder::event_table::PARENT_PROCEDURE_ID_COLUMN">PARENT_<wbr>PROCEDURE_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical parent procedure identifier field for child procedure events.</dd><dt><a class="constant" href="constant.PAYLOAD_COLUMN.html" title="constant common_event_recorder::event_table::PAYLOAD_COLUMN">PAYLOAD_<wbr>COLUMN</a></dt><dd>The canonical event payload column.</dd><dt><a class="constant" href="constant.PHYSICAL_TABLE_ID_COLUMN.html" title="constant common_event_recorder::event_table::PHYSICAL_TABLE_ID_COLUMN">PHYSICAL_<wbr>TABLE_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical physical table identifier dimension.</dd><dt><a class="constant" href="constant.PROCEDURE_ERROR_COLUMN.html" title="constant common_event_recorder::event_table::PROCEDURE_ERROR_COLUMN">PROCEDURE_<wbr>ERROR_<wbr>COLUMN</a></dt><dd>The canonical procedure error envelope column.</dd><dt><a class="constant" href="constant.PROCEDURE_ID_COLUMN.html" title="constant common_event_recorder::event_table::PROCEDURE_ID_COLUMN">PROCEDURE_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical procedure identifier envelope column.</dd><dt><a class="constant" href="constant.PROCEDURE_STATE_COLUMN.html" title="constant common_event_recorder::event_table::PROCEDURE_STATE_COLUMN">PROCEDURE_<wbr>STATE_<wbr>COLUMN</a></dt><dd>The canonical procedure state envelope column.</dd><dt><a class="constant" href="constant.PROCEDURE_TRIGGER_COLUMN.html" title="constant common_event_recorder::event_table::PROCEDURE_TRIGGER_COLUMN">PROCEDURE_<wbr>TRIGGER_<wbr>COLUMN</a></dt><dd>The canonical procedure trigger envelope column.</dd><dt><a class="constant" href="constant.PRUNABLE_ENTRY_ID_COLUMN.html" title="constant common_event_recorder::event_table::PRUNABLE_ENTRY_ID_COLUMN">PRUNABLE_<wbr>ENTRY_<wbr>ID_<wbr>COLUMN</a></dt><dd>The requested WAL prune boundary. It is only an attempted boundary on non-<code>Succeeded</code>
procedure events.</dd><dt><a class="constant" href="constant.REGION_ID_COLUMN.html" title="constant common_event_recorder::event_table::REGION_ID_COLUMN">REGION_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical region identifier field for region events.</dd><dt><a class="constant" href="constant.REGION_MIGRATION_DST_NODE_ID_COLUMN.html" title="constant common_event_recorder::event_table::REGION_MIGRATION_DST_NODE_ID_COLUMN">REGION_<wbr>MIGRATION_<wbr>DST_<wbr>NODE_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical region migration destination node identifier field.</dd><dt><a class="constant" href="constant.REGION_MIGRATION_DST_PEER_ADDR_COLUMN.html" title="constant common_event_recorder::event_table::REGION_MIGRATION_DST_PEER_ADDR_COLUMN">REGION_<wbr>MIGRATION_<wbr>DST_<wbr>PEER_<wbr>ADDR_<wbr>COLUMN</a></dt><dd>The canonical region migration destination peer address field.</dd><dt><a class="constant" href="constant.REGION_MIGRATION_SRC_NODE_ID_COLUMN.html" title="constant common_event_recorder::event_table::REGION_MIGRATION_SRC_NODE_ID_COLUMN">REGION_<wbr>MIGRATION_<wbr>SRC_<wbr>NODE_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical region migration source node identifier field.</dd><dt><a class="constant" href="constant.REGION_MIGRATION_SRC_PEER_ADDR_COLUMN.html" title="constant common_event_recorder::event_table::REGION_MIGRATION_SRC_PEER_ADDR_COLUMN">REGION_<wbr>MIGRATION_<wbr>SRC_<wbr>PEER_<wbr>ADDR_<wbr>COLUMN</a></dt><dd>The canonical region migration source peer address field.</dd><dt><a class="constant" href="constant.REGION_MIGRATION_TRIGGER_REASON_COLUMN.html" title="constant common_event_recorder::event_table::REGION_MIGRATION_TRIGGER_REASON_COLUMN">REGION_<wbr>MIGRATION_<wbr>TRIGGER_<wbr>REASON_<wbr>COLUMN</a></dt><dd>The canonical region migration trigger reason field.</dd><dt><a class="constant" href="constant.REGION_NUMBER_COLUMN.html" title="constant common_event_recorder::event_table::REGION_NUMBER_COLUMN">REGION_<wbr>NUMBER_<wbr>COLUMN</a></dt><dd>The canonical region number field for region events.</dd><dt><a class="constant" href="constant.REPARTITION_GROUP_ID_COLUMN.html" title="constant common_event_recorder::event_table::REPARTITION_GROUP_ID_COLUMN">REPARTITION_<wbr>GROUP_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical repartition group identifier field.</dd><dt><a class="constant" href="constant.SCHEMA_NAME_COLUMN.html" title="constant common_event_recorder::event_table::SCHEMA_NAME_COLUMN">SCHEMA_<wbr>NAME_<wbr>COLUMN</a></dt><dd>The canonical schema name dimension.</dd><dt><a class="constant" href="constant.SOURCE_PARTITION_EXPR_COLUMN.html" title="constant common_event_recorder::event_table::SOURCE_PARTITION_EXPR_COLUMN">SOURCE_<wbr>PARTITION_<wbr>EXPR_<wbr>COLUMN</a></dt><dd>The canonical repartition source partition expression field.</dd><dt><a class="constant" href="constant.SOURCE_REGION_ID_COLUMN.html" title="constant common_event_recorder::event_table::SOURCE_REGION_ID_COLUMN">SOURCE_<wbr>REGION_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical repartition source region identifier field.</dd><dt><a class="constant" href="constant.SOURCE_REGION_NUMBER_COLUMN.html" title="constant common_event_recorder::event_table::SOURCE_REGION_NUMBER_COLUMN">SOURCE_<wbr>REGION_<wbr>NUMBER_<wbr>COLUMN</a></dt><dd>The canonical repartition source region number field.</dd><dt><a class="constant" href="constant.TABLE_ID_COLUMN.html" title="constant common_event_recorder::event_table::TABLE_ID_COLUMN">TABLE_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical table identifier field for table DDL events.</dd><dt><a class="constant" href="constant.TABLE_NAME_COLUMN.html" title="constant common_event_recorder::event_table::TABLE_NAME_COLUMN">TABLE_<wbr>NAME_<wbr>COLUMN</a></dt><dd>The canonical table name field for table DDL events.</dd><dt><a class="constant" href="constant.TARGET_PARTITION_EXPR_COLUMN.html" title="constant common_event_recorder::event_table::TARGET_PARTITION_EXPR_COLUMN">TARGET_<wbr>PARTITION_<wbr>EXPR_<wbr>COLUMN</a></dt><dd>The canonical repartition target partition expression field.</dd><dt><a class="constant" href="constant.TARGET_REGION_ID_COLUMN.html" title="constant common_event_recorder::event_table::TARGET_REGION_ID_COLUMN">TARGET_<wbr>REGION_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical repartition target region identifier field.</dd><dt><a class="constant" href="constant.TARGET_REGION_NUMBER_COLUMN.html" title="constant common_event_recorder::event_table::TARGET_REGION_NUMBER_COLUMN">TARGET_<wbr>REGION_<wbr>NUMBER_<wbr>COLUMN</a></dt><dd>The canonical repartition target region number field.</dd><dt><a class="constant" href="constant.TIMESTAMP_COLUMN.html" title="constant common_event_recorder::event_table::TIMESTAMP_COLUMN">TIMESTAMP_<wbr>COLUMN</a></dt><dd>The canonical event timestamp column.</dd><dt><a class="constant" href="constant.TOPIC_NAME_COLUMN.html" title="constant common_event_recorder::event_table::TOPIC_NAME_COLUMN">TOPIC_<wbr>NAME_<wbr>COLUMN</a></dt><dd>The canonical Kafka topic name dimension.</dd><dt><a class="constant" href="constant.TYPE_COLUMN.html" title="constant common_event_recorder::event_table::TYPE_COLUMN">TYPE_<wbr>COLUMN</a></dt><dd>The canonical event type column.</dd><dt><a class="constant" href="constant.VIEW_ID_COLUMN.html" title="constant common_event_recorder::event_table::VIEW_ID_COLUMN">VIEW_<wbr>ID_<wbr>COLUMN</a></dt><dd>The canonical View identifier dimension.</dd><dt><a class="constant" href="constant.VIEW_NAME_COLUMN.html" title="constant common_event_recorder::event_table::VIEW_NAME_COLUMN">VIEW_<wbr>NAME_<wbr>COLUMN</a></dt><dd>The canonical View name dimension.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.base_column_schemas.html" title="fn common_event_recorder::event_table::base_column_schemas">base_<wbr>column_<wbr>schemas</a></dt><dd>Builds the canonical base schema for every recorded event.</dd><dt><a class="fn" href="fn.column_schemas.html" title="fn common_event_recorder::event_table::column_schemas">column_<wbr>schemas</a></dt><dd>Builds API schemas from canonical event-table columns while preserving their order.</dd><dt><a class="fn" href="fn.jsonb_value.html" title="fn common_event_recorder::event_table::jsonb_value">jsonb_<wbr>value</a></dt><dd>Builds a JSONB API value.</dd><dt><a class="fn" href="fn.nullable_json.html" title="fn common_event_recorder::event_table::nullable_json">nullable_<wbr>json</a></dt><dd>Builds a nullable API JSONB value.</dd><dt><a class="fn" href="fn.nullable_string.html" title="fn common_event_recorder::event_table::nullable_string">nullable_<wbr>string</a></dt><dd>Builds a nullable API string value.</dd><dt><a class="fn" href="fn.nullable_value.html" title="fn common_event_recorder::event_table::nullable_value">nullable_<wbr>value</a></dt><dd>Builds an API value from an optional typed value.</dd><dt><a class="fn" href="fn.procedure_event_column_schemas.html" title="fn common_event_recorder::event_table::procedure_event_column_schemas">procedure_<wbr>event_<wbr>column_<wbr>schemas</a></dt><dd>Builds the canonical procedure event envelope schema.</dd></dl></section></div></main></body></html>