mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-30 03:40:37 +00:00
2 lines
9.6 KiB
HTML
2 lines
9.6 KiB
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 `recorder` mod in crate `common_event_recorder`."><title>common_event_recorder::recorder - 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-17e0aaed.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.96.0-nightly (ac7f9ec7d 2026-03-20)" data-channel="nightly" data-search-js="search-63369b7b.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-5013f961.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 recorder</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.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module recorder</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="#traits" title="Traits">Traits</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</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>recorder</span> <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/recorder.rs.html#15-674">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.EventHandlerOptions.html" title="struct common_event_recorder::recorder::EventHandlerOptions">Event<wbr>Handler<wbr>Options</a></dt><dd>EventHandlerOptions is the options for the event handler.</dd><dt><a class="struct" href="struct.EventProcessor.html" title="struct common_event_recorder::recorder::EventProcessor">Event<wbr>Processor</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="struct" href="struct.EventRecorderImpl.html" title="struct common_event_recorder::recorder::EventRecorderImpl">Event<wbr>Recorder<wbr>Impl</a></dt><dd>Implementation of <a href="trait.EventRecorder.html" title="trait common_event_recorder::recorder::EventRecorder">EventRecorder</a> that records the events and processes them in the background by the <a href="trait.EventHandler.html" title="trait common_event_recorder::recorder::EventHandler">EventHandler</a>.</dd><dt><a class="struct" href="struct.EventRecorderOptions.html" title="struct common_event_recorder::recorder::EventRecorderOptions">Event<wbr>Recorder<wbr>Options</a></dt><dd>Configuration options for the event recorder.</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.DEFAULT_BUFFER_SIZE.html" title="constant common_event_recorder::recorder::DEFAULT_BUFFER_SIZE">DEFAULT_<wbr>BUFFER_<wbr>SIZE</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.DEFAULT_CHANNEL_SIZE.html" title="constant common_event_recorder::recorder::DEFAULT_CHANNEL_SIZE">DEFAULT_<wbr>CHANNEL_<wbr>SIZE</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.DEFAULT_COMPACTION_TIME_WINDOW.html" title="constant common_event_recorder::recorder::DEFAULT_COMPACTION_TIME_WINDOW">DEFAULT_<wbr>COMPACTION_<wbr>TIME_<wbr>WINDOW</a></dt><dd>The default compaction time window for the events table.</dd><dt><a class="constant" href="constant.DEFAULT_EVENTS_TABLE_NAME.html" title="constant common_event_recorder::recorder::DEFAULT_EVENTS_TABLE_NAME">DEFAULT_<wbr>EVENTS_<wbr>TABLE_<wbr>NAME</a></dt><dd>The default table name for storing the events.</dd><dt><a class="constant" href="constant.DEFAULT_EVENTS_TABLE_TTL.html" title="constant common_event_recorder::recorder::DEFAULT_EVENTS_TABLE_TTL">DEFAULT_<wbr>EVENTS_<wbr>TABLE_<wbr>TTL</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>The default TTL(90 days) for the events table.</dd><dt><a class="constant" href="constant.DEFAULT_FLUSH_INTERVAL_SECONDS.html" title="constant common_event_recorder::recorder::DEFAULT_FLUSH_INTERVAL_SECONDS">DEFAULT_<wbr>FLUSH_<wbr>INTERVAL_<wbr>SECONDS</a></dt><dd>The time interval for flushing batched events to the event handler.</dd><dt><a class="constant" href="constant.DEFAULT_MAX_RETRY_TIMES.html" title="constant common_event_recorder::recorder::DEFAULT_MAX_RETRY_TIMES">DEFAULT_<wbr>MAX_<wbr>RETRY_<wbr>TIMES</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.EVENTS_TABLE_PAYLOAD_COLUMN_NAME.html" title="constant common_event_recorder::recorder::EVENTS_TABLE_PAYLOAD_COLUMN_NAME">EVENTS_<wbr>TABLE_<wbr>PAYLOAD_<wbr>COLUMN_<wbr>NAME</a></dt><dd>The column name for the event payload.</dd><dt><a class="constant" href="constant.EVENTS_TABLE_TIMESTAMP_COLUMN_NAME.html" title="constant common_event_recorder::recorder::EVENTS_TABLE_TIMESTAMP_COLUMN_NAME">EVENTS_<wbr>TABLE_<wbr>TIMESTAMP_<wbr>COLUMN_<wbr>NAME</a></dt><dd>The column name for the event timestamp.</dd><dt><a class="constant" href="constant.EVENTS_TABLE_TYPE_COLUMN_NAME.html" title="constant common_event_recorder::recorder::EVENTS_TABLE_TYPE_COLUMN_NAME">EVENTS_<wbr>TABLE_<wbr>TYPE_<wbr>COLUMN_<wbr>NAME</a></dt><dd>The column name for the event type.</dd></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Event.html" title="trait common_event_recorder::recorder::Event">Event</a></dt><dd>Event trait defines the interface for events that can be recorded and persisted as the system table.
|
|
By default, the event will be persisted as the system table with the following schema:</dd><dt><a class="trait" href="trait.EventHandler.html" title="trait common_event_recorder::recorder::EventHandler">Event<wbr>Handler</a></dt><dd>EventHandler trait defines the interface for how to handle the event.</dd><dt><a class="trait" href="trait.EventRecorder.html" title="trait common_event_recorder::recorder::EventRecorder">Event<wbr>Recorder</a></dt><dd>EventRecorder trait defines the interface for recording events.</dd><dt><a class="trait" href="trait.Eventable.html" title="trait common_event_recorder::recorder::Eventable">Eventable</a></dt><dd>Eventable trait defines the interface for objects that can be converted to <a href="trait.Event.html" title="trait common_event_recorder::recorder::Event">Event</a>.</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.build_row_inserts_request.html" title="fn common_event_recorder::recorder::build_row_inserts_request">build_<wbr>row_<wbr>inserts_<wbr>request</a></dt><dd>Builds the row inserts request for the events that will be persisted to the events table. The <code>events</code> should have the same event type, or it will return an error.</dd><dt><a class="fn" href="fn.group_events_by_type.html" title="fn common_event_recorder::recorder::group_events_by_type">group_<wbr>events_<wbr>by_<wbr>type</a></dt><dd>Groups events by its <code>event_type</code>.</dd><dt><a class="fn" href="fn.validate_events.html" title="fn common_event_recorder::recorder::validate_events">validate_<wbr>events</a><span title="Restricted Visibility"> 🔒</span> </dt></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.EventRecorderRef.html" title="type common_event_recorder::recorder::EventRecorderRef">Event<wbr>Recorder<wbr>Ref</a></dt><dd>EventRecorderRef is the reference to the event recorder.</dd></dl></section></div></main></body></html> |