Struct OnchainDataQuery 

pub struct OnchainDataQuery {
    pub cache: Option<QueryResultCacheConfiguration>,
    pub sql: OnchainDataQuerySql,
}

Request to execute a SQL query against indexed blockchain data.

JSON schema

{
 "description": "Request to execute a SQL query against indexed blockchain data.",
 "type": "object",
 "required": [
   "sql"
 ],
 "properties": {
   "cache": {
     "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
       }
     }
   },
   "sql": {
     "description": "SQL query to execute against the indexed blockchain data.",
     "examples": [
       "SELECT block_number, transaction_hash FROM base.transactions WHERE block_number > 1000000 LIMIT 10"
     ],
     "type": "string",
     "maxLength": 100000,
     "minLength": 1
   }
 }
}

Fields

cache: Option<QueryResultCacheConfiguration>

sql: OnchainDataQuerySql

SQL query to execute against the indexed blockchain data.

Implementations

impl OnchainDataQuery

pub fn builder() -> OnchainDataQuery

Trait Implementations

impl Clone for OnchainDataQuery

fn clone(&self) -> OnchainDataQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OnchainDataQuery

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OnchainDataQuery

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&OnchainDataQuery> for OnchainDataQuery

fn from(value: &OnchainDataQuery) -> Self

Converts to this type from the input type.

impl From<OnchainDataQuery> for OnchainDataQuery

fn from(value: OnchainDataQuery) -> Self

Converts to this type from the input type.

impl Serialize for OnchainDataQuery

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<OnchainDataQuery> for OnchainDataQuery

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.