Enum EnrichmentTables

pub enum EnrichmentTables {
    File(FileConfig),
    Memory(MemoryConfig),
    Geoip(GeoipConfig),
    Mmdb(MmdbConfig),
}

Configuration options for an enrichment table to be used in a remap transform. Currently supported are:

• CSV files
• MaxMind databases
• In-memory storage

For the lookup in the enrichment tables to be as performant as possible, the data is indexed according to the fields that are used in the search. Note that indices can only be created for fields for which an exact match is used in the condition. For range searches, an index isn’t used and the enrichment table drops back to a sequential scan of the data. A sequential scan shouldn’t impact performance significantly provided that there are only a few possible rows returned by the exact matches in the condition. We don’t recommend using a condition that uses only date range searches.

Variants

File(FileConfig)

Exposes data from a static file as an enrichment table.

Memory(MemoryConfig)

Exposes data from a memory cache as an enrichment table. The cache can be written to using a sink.

Geoip(GeoipConfig)

Exposes data from a MaxMind GeoIP2 database as an enrichment table.

Mmdb(MmdbConfig)

Exposes data from a MaxMind database as an enrichment table.

Trait Implementations

impl Clone for EnrichmentTables

fn clone(&self) -> EnrichmentTables

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Configurable for EnrichmentTables

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for EnrichmentTables

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EnrichmentTables

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EnrichmentTableConfig for EnrichmentTables

async fn build( &self, __enum_dispatch_arg_0: &GlobalOptions, ) -> Result<Box<dyn Table + Send + Sync>>

Builds the enrichment table with the given globals.

If the enrichment table is built successfully, Ok(...) is returned containing the enrichment table.

Errors

If an error occurs while building the enrichment table, an error variant explaining the issue is returned.

fn sink_config(&self) -> Option<Box<dyn SinkConfig>>

impl From<FileConfig> for EnrichmentTables

fn from(v: FileConfig) -> EnrichmentTables

Converts to this type from the input type.

impl From<GeoipConfig> for EnrichmentTables

fn from(v: GeoipConfig) -> EnrichmentTables

Converts to this type from the input type.

impl From<MemoryConfig> for EnrichmentTables

fn from(v: MemoryConfig) -> EnrichmentTables

Converts to this type from the input type.

impl From<MmdbConfig> for EnrichmentTables

fn from(v: MmdbConfig) -> EnrichmentTables

Converts to this type from the input type.

impl GenerateConfig for EnrichmentTables

fn generate_config() -> Value

impl NamedComponent for EnrichmentTables

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for EnrichmentTables

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for EnrichmentTables

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.

impl TryInto<FileConfig> for EnrichmentTables

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<FileConfig, <Self as TryInto<FileConfig>>::Error>

Performs the conversion.

impl TryInto<GeoipConfig> for EnrichmentTables

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<GeoipConfig, <Self as TryInto<GeoipConfig>>::Error>

Performs the conversion.

impl TryInto<MemoryConfig> for EnrichmentTables

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<MemoryConfig, <Self as TryInto<MemoryConfig>>::Error>

Performs the conversion.

impl TryInto<MmdbConfig> for EnrichmentTables

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into(self) -> Result<MmdbConfig, <Self as TryInto<MmdbConfig>>::Error>

Performs the conversion.