Struct Options 

pub struct Options {

    pub embedded_db: bool,
    pub(crate) postgres_options: PostgresOptions,
    pub(crate) sqlite_options: SqliteOptions,
    pub(crate) uri: Option<String>,
    pub(crate) prune: bool,
    pub(crate) pruning: PruningOptions,
    pub(crate) consensus_pruning: ConsensusPruningOptions,
    pub(crate) serializable_retry: SerializableRetryOptions,
    pub(crate) fetch_rate_limit: Option<usize>,
    pub(crate) active_fetch_delay: Option<Duration>,
    pub(crate) chunk_fetch_delay: Option<Duration>,
    pub(crate) ranges_concurrency: Option<NonZeroUsize>,
    pub(crate) sync_status_chunk_size: Option<usize>,
    pub(crate) sync_status_ttl: Option<Duration>,
    pub(crate) proactive_scan_chunk_size: Option<usize>,
    pub(crate) proactive_scan_interval: Option<Duration>,
    pub(crate) proactive_fetch_timeout: Option<Duration>,
    pub(crate) disable_proactive_fetching: bool,
    pub(crate) archive: bool,
    pub(crate) archive_state_min_retention: u64,
    pub(crate) archive_full_state: bool,
    pub(crate) lightweight: bool,
    pub(crate) idle_connection_timeout: Duration,
    pub(crate) connection_timeout: Duration,
    pub(crate) slow_statement_threshold: Duration,
    pub(crate) statement_timeout: Duration,
    pub(crate) min_connections: u32,
    pub(crate) query_min_connections: Option<u32>,
    pub(crate) max_connections: u32,
    pub(crate) query_max_connections: Option<u32>,
    pub(crate) pool: Option<SqlPool>,
    pub(crate) consensus_only: bool,
}

Options for database-backed persistence, supporting both Postgres and SQLite.

Fields

embedded_db: bool

Store data in an embedded SQLite database instead of Postgres.

The database lives under ESPRESSO_NODE_STORAGE_PATH, and the Postgres options are ignored.

postgres_options: PostgresOptions

sqlite_options: SqliteOptions

uri: Option<String>

Database URI for Postgres or SQLite.

This is a shorthand for setting a number of other options all at once. The URI has the following format ([brackets] indicate optional segments):

• Postgres: postgres[ql]://[username[:password]@][host[:port],]/database[?parameter_list]
• SQLite: sqlite://path/to/db.sqlite

Options set explicitly via other env vars or flags will take precedence, so you can use this URI to set a baseline and then use other parameters to override or add configuration. In addition, there are some parameters which cannot be set via the URI, such as TLS.

prune: bool

This will enable the pruner and set the default pruning parameters unless provided. Default parameters:

• pruning_threshold: 3 TB
• minimum_retention: 1 day
• target_retention: 7 days
• batch_size: 100
• max_usage: 80%
• interval: 1 hour

A pruned node with no merklized state starts it from a recent epoch boundary. Its trees then lack block proofs below that boundary, and fee accounts that no block after it touched. They stay incomplete after a switch to --archive: complete trees need a replay from genesis, which runs only on a database with no merklized state.

A pruned node keeps no transaction or payload totals, which count from genesis: it does not run the aggregator, and the routes that serve the totals return 404.

pruning: PruningOptions

Pruning parameters.

consensus_pruning: ConsensusPruningOptions

Pruning parameters for ephemeral consensus storage.

serializable_retry: SerializableRetryOptions

Retry/backoff parameters for PostgreSQL serialization conflicts.

fetch_rate_limit: Option<usize>

Specifies the maximum number of concurrent fetch requests allowed from peers.

active_fetch_delay: Option<Duration>

The minimum delay between active fetches in a stream.

chunk_fetch_delay: Option<Duration>

The minimum delay between loading chunks in a stream.

ranges_concurrency: Option<NonZeroUsize>

How many of a request’s height ranges to serve at once.

sync_status_chunk_size: Option<usize>

The number of items to process in a single transaction when scanning the database for missing objects.

sync_status_ttl: Option<Duration>

Duration to cache sync status results for.

proactive_scan_chunk_size: Option<usize>

The number of items to process at a time when scanning for proactive fetching.

proactive_scan_interval: Option<Duration>

The time interval between proactive fetching scans.

proactive_fetch_timeout: Option<Duration>

How long a proactive scan waits for one request of missing ranges before fetching its chunks one at a time instead.

disable_proactive_fetching: bool

Disable the proactive scanner task.

archive: bool

Disable pruning and reconstruct previously pruned data.

While running without pruning is the default behavior, the default will not try to reconstruct data that was pruned in a previous run where pruning was enabled. This option instructs the service to run without pruning and reconstruct all previously pruned data by fetching from peers.

Historical merklized state older than the light client contract history is garbage collected, but never less than ESPRESSO_NODE_ARCHIVE_STATE_MIN_RETENTION heights behind the head. Use ESPRESSO_NODE_ARCHIVE_FULL_STATE to retain all of it.

archive_state_min_retention: u64

Block heights of merklized state an archive node retains regardless of the light client.

Collection stops at whichever reaches further back, this floor or the light client contract’s history. Set it to zero to follow the contract alone.

archive_full_state: bool

Retain all historical merklized state on an archive node.

Disables the state garbage collector that archive nodes run by default.

lightweight: bool

Turns on leaf only data storage

A lightweight node keeps no transaction or payload totals: it does not run the aggregator, and the routes that serve the totals return 404.

idle_connection_timeout: Duration

The maximum idle time of a database connection.

Any connection which has been open and unused longer than this duration will be automatically closed to reduce load on the server.

connection_timeout: Duration

The maximum lifetime of a database connection.

Any connection which has been open longer than this duration will be automatically closed (and, if needed, replaced), even if it is otherwise healthy. It is good practice to refresh even healthy connections once in a while (e.g. daily) in case of resource leaks in the server implementation.

slow_statement_threshold: Duration

statement_timeout: Duration

The maximum time a single SQL statement is allowed to run before being canceled.

This helps prevent queries from running indefinitely and consuming resources. Set to 10 minutes by default

min_connections: u32

The minimum number of database connections to maintain at any time.

The database client will, to the best of its ability, maintain at least min open connections at all times. This can be used to reduce the latency hit of opening new connections when at least this many simultaneous connections are frequently needed.

query_min_connections: Option<u32>

Allows setting a different maximum number of connections for query operations. Default value of None implies using the min_connections value. Postgres only.

max_connections: u32

The maximum number of database connections to maintain at any time.

Once max connections are in use simultaneously, further attempts to acquire a connection (or begin a transaction) will block until one of the existing connections is released.

query_max_connections: Option<u32>

Allows setting a different maximum number of connections for query operations. Default value of None implies using the max_connections value. Postgres only.

pool: Option<SqlPool>

consensus_only: bool

Implementations

impl Options

pub fn into_backend(self) -> SqlBackendOptions

These options for the backend embedded_db selects.

Trait Implementations

impl Args for Options

fn group_id() -> Option<Id>

Report the [ArgGroup::id][crate::ArgGroup::id] for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate Self via [FromArgMatches::from_arg_matches_mut]

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to [Command] so it can instantiate self via [FromArgMatches::update_from_arg_matches_mut]

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Options

fn command<'b>() -> Command

Build a [Command] that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a [Command] that can update self.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl From<&Options> for SqlStorageConfig

fn from(o: &Options) -> Self

Converts to this type from the input type.

impl From<PostgresOptions> for Options

fn from(opt: PostgresOptions) -> Self

Converts to this type from the input type.

impl From<SqliteOptions> for Options

fn from(opt: SqliteOptions) -> Self

Converts to this type from the input type.

impl FromArgMatches for Options

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from [ArgMatches], parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl ModuleInfo for Options

const NAME: &'static str = "storage-sql"

fn requires() -> Vec<&'static str>

impl Parser for Options

fn parse() -> Self

Parse from std::env::args_os(), [exit][Error::exit] on error.

fn try_parse() -> Result<Self, Error>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, [exit][Error::exit] on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, [exit][Error::exit] on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl TryFrom<&Options> for Config

type Error = Error

The type returned in the event of a conversion error.

fn try_from(opt: &SqlOptions) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Options> for Config

type Error = Error

The type returned in the event of a conversion error.

fn try_from(opt: &SqlOptions) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Options> for Options

type Error = Error

The type returned in the event of a conversion error.

fn try_from(opt: SqlOptions) -> Result<Options>

Performs the conversion.

impl TryFrom<Options> for Options

type Error = Error

The type returned in the event of a conversion error.

fn try_from(opt: SqlOptions) -> Result<Options>

Performs the conversion.