mirror of
https://github.com/GreptimeTeam/greptimedb.git
synced 2026-05-15 20:40:39 +00:00
11 lines
12 KiB
HTML
11 lines
12 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 `event` mod in crate `servers`."><title>servers::http::event - 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="servers" 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 event</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../servers/index.html">servers</a><span class="version">1.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module event</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="#enums" title="Enums">Enums</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><a href="../index.html">In servers::<wbr>http</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">servers</a>::<wbr><a href="../index.html">http</a></div><h1>Module <span>event</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/servers/http/event.rs.html#15-1055">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.EventPayloadResolver.html" title="struct servers::http::event::EventPayloadResolver">Event<wbr>Payload<wbr>Resolver</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="struct" href="struct.EventPayloadResolverInnerIter.html" title="struct servers::http::event::EventPayloadResolverInnerIter">Event<wbr>Payload<wbr>Resolver<wbr>Inner<wbr>Iter</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>An iterator over the variants of <a href="enum.EventPayloadResolverInner.html" title="enum servers::http::event::EventPayloadResolverInner">EventPayloadResolverInner</a></dd><dt><a class="struct" href="struct.JSON_CONTENT_TYPE.html" title="struct servers::http::event::JSON_CONTENT_TYPE">JSON_<wbr>CONTENT_<wbr>TYPE</a></dt><dt><a class="struct" href="struct.LogIngesterQueryParams.html" title="struct servers::http::event::LogIngesterQueryParams">LogIngester<wbr>Query<wbr>Params</a></dt><dd>LogIngesterQueryParams is used for query params of log ingester API.</dd><dt><a class="struct" href="struct.LogState.html" title="struct servers::http::event::LogState">LogState</a></dt><dd>axum state struct to hold log handler and validator</dd><dt><a class="struct" href="struct.NDJSON_CONTENT_TYPE.html" title="struct servers::http::event::NDJSON_CONTENT_TYPE">NDJSON_<wbr>CONTENT_<wbr>TYPE</a></dt><dt><a class="struct" href="struct.PB_CONTENT_TYPE.html" title="struct servers::http::event::PB_CONTENT_TYPE">PB_<wbr>CONTENT_<wbr>TYPE</a></dt><dt><a class="struct" href="struct.PipelineContent.html" title="struct servers::http::event::PipelineContent">Pipeline<wbr>Content</a></dt><dt><a class="struct" href="struct.PipelineDryrunParams.html" title="struct servers::http::event::PipelineDryrunParams">Pipeline<wbr>Dryrun<wbr>Params</a></dt><dd>Dryrun pipeline with given data
|
|
pipeline_name and pipeline_version to specify pipeline stored in db
|
|
pipeline to specify pipeline raw content
|
|
data to specify data
|
|
data maght be list of string or list of object</dd><dt><a class="struct" href="struct.PipelineIngestRequest.html" title="struct servers::http::event::PipelineIngestRequest">Pipeline<wbr>Ingest<wbr>Request</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>LogIngestRequest is the internal request for log ingestion. The raw log input can be transformed into multiple LogIngestRequests.
|
|
Multiple LogIngestRequests will be ingested into the same database with the same pipeline.</dd><dt><a class="struct" href="struct.TEXT_CONTENT_TYPE.html" title="struct servers::http::event::TEXT_CONTENT_TYPE">TEXT_<wbr>CONTENT_<wbr>TYPE</a></dt><dt><a class="struct" href="struct.TEXT_UTF8_CONTENT_TYPE.html" title="struct servers::http::event::TEXT_UTF8_CONTENT_TYPE">TEXT_<wbr>UTF8_<wbr>CONTENT_<wbr>TYPE</a></dt></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.EventPayloadResolverInner.html" title="enum servers::http::event::EventPayloadResolverInner">Event<wbr>Payload<wbr>Resolver<wbr>Inner</a><span title="Restricted Visibility"> 🔒</span> </dt></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.CREATE_TABLE_SQL_SUFFIX_EXISTS.html" title="constant servers::http::event::CREATE_TABLE_SQL_SUFFIX_EXISTS">CREATE_<wbr>TABLE_<wbr>SQL_<wbr>SUFFIX_<wbr>EXISTS</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.CREATE_TABLE_SQL_TABLE_EXISTS.html" title="constant servers::http::event::CREATE_TABLE_SQL_TABLE_EXISTS">CREATE_<wbr>TABLE_<wbr>SQL_<wbr>TABLE_<wbr>EXISTS</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.GREPTIME_INTERNAL_PIPELINE_NAME_PREFIX.html" title="constant servers::http::event::GREPTIME_INTERNAL_PIPELINE_NAME_PREFIX">GREPTIME_<wbr>INTERNAL_<wbr>PIPELINE_<wbr>NAME_<wbr>PREFIX</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="constant" href="constant.GREPTIME_PIPELINE_SKIP_ERROR_KEY.html" title="constant servers::http::event::GREPTIME_PIPELINE_SKIP_ERROR_KEY">GREPTIME_<wbr>PIPELINE_<wbr>SKIP_<wbr>ERROR_<wbr>KEY</a><span title="Restricted Visibility"> 🔒</span> </dt></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.LogValidator.html" title="trait servers::http::event::LogValidator">LogValidator</a></dt></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.add_pipeline.html" title="fn servers::http::event::add_pipeline">add_<wbr>pipeline</a></dt><dt><a class="fn" href="fn.add_step_info_for_pipeline_dryrun_error.html" title="fn servers::http::event::add_step_info_for_pipeline_dryrun_error">add_<wbr>step_<wbr>info_<wbr>for_<wbr>pipeline_<wbr>dryrun_<wbr>error</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.check_data_valid.html" title="fn servers::http::event::check_data_valid">check_<wbr>data_<wbr>valid</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Check if the data length less than 10</dd><dt><a class="fn" href="fn.check_pipeline_dryrun_params_valid.html" title="fn servers::http::event::check_pipeline_dryrun_params_valid">check_<wbr>pipeline_<wbr>dryrun_<wbr>params_<wbr>valid</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Check if the payload is valid json
|
|
Check if the payload contains pipeline or pipeline_name and data
|
|
Return Some if valid, None if invalid</dd><dt><a class="fn" href="fn.check_pipeline_name_exists.html" title="fn servers::http::event::check_pipeline_name_exists">check_<wbr>pipeline_<wbr>name_<wbr>exists</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Check if the pipeline_name exists</dd><dt><a class="fn" href="fn.delete_pipeline.html" title="fn servers::http::event::delete_pipeline">delete_<wbr>pipeline</a></dt><dt><a class="fn" href="fn.dryrun_pipeline_inner.html" title="fn servers::http::event::dryrun_pipeline_inner">dryrun_<wbr>pipeline_<wbr>inner</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Dryrun pipeline with given data</dd><dt><a class="fn" href="fn.extract_pipeline_params_map_from_headers.html" title="fn servers::http::event::extract_pipeline_params_map_from_headers">extract_<wbr>pipeline_<wbr>params_<wbr>map_<wbr>from_<wbr>headers</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.extract_pipeline_value_by_content_type.html" title="fn servers::http::event::extract_pipeline_value_by_content_type">extract_<wbr>pipeline_<wbr>value_<wbr>by_<wbr>content_<wbr>type</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.ingest_logs_inner.html" title="fn servers::http::event::ingest_logs_inner">ingest_<wbr>logs_<wbr>inner</a><span title="Restricted Visibility"> 🔒</span> </dt><dt><a class="fn" href="fn.log_ingester.html" title="fn servers::http::event::log_ingester">log_<wbr>ingester</a></dt><dt><a class="fn" href="fn.parse_dryrun_data.html" title="fn servers::http::event::parse_dryrun_data">parse_<wbr>dryrun_<wbr>data</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Parse the data with given content type
|
|
If the content type is invalid, return error
|
|
content type is one of application/json, text/plain, application/x-ndjson</dd><dt><a class="fn" href="fn.pipeline_dryrun.html" title="fn servers::http::event::pipeline_dryrun">pipeline_<wbr>dryrun</a></dt><dt><a class="fn" href="fn.query_pipeline.html" title="fn servers::http::event::query_pipeline">query_<wbr>pipeline</a></dt><dt><a class="fn" href="fn.query_pipeline_ddl.html" title="fn servers::http::event::query_pipeline_ddl">query_<wbr>pipeline_<wbr>ddl</a></dt><dd>Generate DDL from pipeline definition.</dd><dt><a class="fn" href="fn.transform_ndjson_array_factory.html" title="fn servers::http::event::transform_ndjson_array_factory">transform_<wbr>ndjson_<wbr>array_<wbr>factory</a><span title="Restricted Visibility"> 🔒</span> </dt><dd>Transform NDJSON array into a single array
|
|
always return an array</dd></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.LogValidatorRef.html" title="type servers::http::event::LogValidatorRef">LogValidator<wbr>Ref</a></dt></dl></section></div></main></body></html> |