Struct Options

pub struct Options {

    pub(crate) postgres_options: PostgresOptions,
    pub(crate) uri: Option<String>,
    pub(crate) prune: bool,
    pub(crate) pruning: PruningOptions,
    pub(crate) consensus_pruning: ConsensusPruningOptions,
    pub(crate) fetch_rate_limit: Option<usize>,
    pub(crate) active_fetch_delay: Option<Duration>,
    pub(crate) chunk_fetch_delay: Option<Duration>,
    pub(crate) archive: bool,
    pub(crate) lightweight: bool,
    pub(crate) idle_connection_timeout: Duration,
    pub(crate) connection_timeout: Duration,
    pub(crate) slow_statement_threshold: Duration,
    pub(crate) min_connections: u32,
    pub(crate) max_connections: u32,
    pub(crate) types_migration_batch_size: Option<u64>,
    pub(crate) pool: Option<Pool<Db>>,
}

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

Fields

postgres_options: PostgresOptions

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: 1000
• max_usage: 80%
• interval: 1 hour

pruning: PruningOptions

Pruning parameters.

consensus_pruning: ConsensusPruningOptions

Pruning parameters for ephemeral consensus storage.

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.

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.

lightweight: bool

Turns on leaf only data storage

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

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.

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.

types_migration_batch_size: Option<u64>

Sets the batch size for the types migration. Determines how many (leaf, vid) rows are selected from the old types table and migrated at once. Default is `10000`` if not set

pool: Option<Pool<Db>>

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 DataSourceOptions for Options

type DataSource = FetchingDataSource<SeqTypes, SqlStorage, AnyProvider<SeqTypes>>

fn enable_query_module(&self, opt: Options, query: Query) -> Options

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<(PostgresOptions, Option<String>, bool, PruningOptions, ConsensusPruningOptions, Option<usize>, Option<Duration>, Option<Duration>, bool, bool, Duration, Duration, Duration, u32, u32, Option<u64>, Option<Pool<Postgres>>)> for Options

fn from( value: (PostgresOptions, Option<String>, bool, PruningOptions, ConsensusPruningOptions, Option<usize>, Option<Duration>, Option<Duration>, bool, bool, Duration, Duration, Duration, u32, u32, Option<u64>, Option<Pool<Db>>), ) -> Self

Converts to this type from the input type.

impl From<Options> for (PostgresOptions, Option<String>, bool, PruningOptions, ConsensusPruningOptions, Option<usize>, Option<Duration>, Option<Duration>, bool, bool, Duration, Duration, Duration, u32, u32, Option<u64>, Option<Pool<Db>>)

fn from(value: 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 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 PersistenceOptions for Options

type Persistence = Persistence

fn set_view_retention(&mut self, view_retention: u64)

fn create<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Self::Persistence>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn reset<'async_trait>( self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait,

impl TryFrom<&Options> for Config

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.