Struct QueryResultCacheConfiguration 

pub struct QueryResultCacheConfiguration {
    pub max_age_ms: i64,
}

Enables control over how often queries need to be fully re-executed on the backing store. This can be useful in scenarios where API calls might be made frequently, API latency is critical, and some freshness lag (ex: 750ms, 2s, 5s) is tolerable. By default, each query result is returned from cache so long as the result is from an identical query and less than 500ms old. This freshness tolerance can be modified upwards, to a maximum of 900000ms (i.e. 900s, 15m).

JSON schema

{
 "title": "Query result cache configuration",
 "description": "Enables control over how often queries need to be fully re-executed on the backing store.\nThis can be useful in scenarios where API calls might be made frequently, API latency is critical, and some freshness lag (ex: 750ms, 2s, 5s) is tolerable.\nBy default, each query result is returned from cache so long as the result is from an identical query and less than 500ms old. This freshness tolerance can be modified upwards, to a maximum of 900000ms (i.e. 900s, 15m).\n",
 "examples": [
   {
     "maxAgeMs": 1000
   }
 ],
 "type": "object",
 "properties": {
   "maxAgeMs": {
     "description": "The maximum tolerable staleness of the query result cache in milliseconds. If a previous execution result of an identical query is older than this age, the query will be re-executed. If the data is less than this age, the result will be returned from cache.",
     "default": 500,
     "examples": [
       1000
     ],
     "type": "integer",
     "maximum": 900000.0,
     "minimum": 500.0
   }
 }
}

Fields

max_age_ms: i64

The maximum tolerable staleness of the query result cache in milliseconds. If a previous execution result of an identical query is older than this age, the query will be re-executed. If the data is less than this age, the result will be returned from cache.

Implementations

impl QueryResultCacheConfiguration

pub fn builder() -> QueryResultCacheConfiguration

Trait Implementations

impl Clone for QueryResultCacheConfiguration

fn clone(&self) -> QueryResultCacheConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QueryResultCacheConfiguration

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

Formats the value using the given formatter.

impl Default for QueryResultCacheConfiguration

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QueryResultCacheConfiguration

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&QueryResultCacheConfiguration> for QueryResultCacheConfiguration

fn from(value: &QueryResultCacheConfiguration) -> Self

Converts to this type from the input type.

impl From<QueryResultCacheConfiguration> for QueryResultCacheConfiguration

fn from(value: QueryResultCacheConfiguration) -> Self

Converts to this type from the input type.

impl Serialize for QueryResultCacheConfiguration

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<QueryResultCacheConfiguration> for QueryResultCacheConfiguration

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from( value: QueryResultCacheConfiguration, ) -> Result<Self, ConversionError>

Performs the conversion.