Struct IndexerConfig

pub struct IndexerConfig {
    pub store: PathBuf,
    pub secondary_path: PathBuf,
    pub poll_interval: u64,
    pub index_tx_pool: bool,
    pub block_filter: Option<String>,
    pub cell_filter: Option<String>,
    pub db_background_jobs: Option<NonZeroUsize>,
    pub db_keep_log_file_num: Option<NonZeroUsize>,
    pub init_tip_hash: Option<H256>,
    pub request_limit: Option<usize>,
    pub rich_indexer: RichIndexerConfig,
}

Indexer config options.

Fields

store: PathBuf

The index store path, default data_dir / indexer / store

secondary_path: PathBuf

The secondary_db path, default data_dir / indexer / secondary_path

poll_interval: u64

The poll interval by secs

index_tx_pool: bool

Whether to index the pending txs in the ckb tx-pool

block_filter: Option<String>

Customize block filter

cell_filter: Option<String>

Customize cell filter

db_background_jobs: Option<NonZeroUsize>

Maximum number of concurrent db background jobs (compactions and flushes)

db_keep_log_file_num: Option<NonZeroUsize>

Maximal db info log files to be kept.

init_tip_hash: Option<H256>

The init tip block hash

request_limit: Option<usize>

limit of indexer request

rich_indexer: RichIndexerConfig

Rich indexer config options

Implementations

impl IndexerConfig

pub fn adjust<P: AsRef<Path>>(&mut self, root_dir: &Path, indexer_dir: P)

Canonicalizes paths in the config options.

If self.store is not set, set it to data_dir / indexer / store.

If self.secondary_path is not set, set it to data_dir / indexer / secondary_path.

If self.rich_indexer is Sqlite, and self.rich_indexer.sqlite.store is not set, set it to data_dir / indexer / sqlite / sqlite.db.

If any of the above paths is relative, convert them to absolute path using root_dir as current working directory.

Trait Implementations

impl Clone for IndexerConfig

fn clone(&self) -> IndexerConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IndexerConfig

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

Formats the value using the given formatter.

impl Default for IndexerConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for IndexerConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&IndexerConfig> for IndexerSyncConfig

fn from(config: &IndexerConfig) -> IndexerSyncConfig

Converts to this type from the input type.

impl Serialize for IndexerConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.