Struct solana_accountsdb_plugin_postgres::accountsdb_plugin_postgres::AccountsDbPluginPostgres

pub struct AccountsDbPluginPostgres { /* fields omitted */ }

Implementations

impl AccountsDbPluginPostgres

pub fn new() -> Self

Trait Implementations

impl AccountsDbPlugin for AccountsDbPluginPostgres

fn on_load(&mut self, config_file: &str) -> Result<()>

Do initialization for the PostgreSQL plugin.

Format of the config file:

• The accounts_selector section allows the user to controls accounts selections. “accounts_selector” : { “accounts” : [“pubkey-1”, “pubkey-2”, …, “pubkey-n”], } or: “accounts_selector” = { “owners” : [“pubkey-1”, “pubkey-2”, …, “pubkey-m”] } Accounts either satisyfing the accounts condition or owners condition will be selected. When only owners is specified, all accounts belonging to the owners will be streamed. The accounts field supports wildcard to select all accounts: “accounts_selector” : { “accounts” : [“*”], }
• “host”, optional, specifies the PostgreSQL server.
• “user”, optional, specifies the PostgreSQL user.
• “port”, optional, specifies the PostgreSQL server’s port.
• “connection_str”, optional, the custom PostgreSQL connection string. Please refer to https://docs.rs/postgres/0.19.2/postgres/config/struct.Config.html for the connection configuration. When connection_str is set, the values in “host”, “user” and “port” are ignored. If connection_str is not given, host and user must be given. “store_account_historical_data”, optional, set it to ‘true’, to store historical account data to account_audit table.
• “threads” optional, specifies the number of worker threads for the plugin. A thread maintains a PostgreSQL connection to the server. The default is ‘10’.
• “batch_size” optional, specifies the batch size of bulk insert when the AccountsDb is created from restoring a snapshot. The default is ‘10’.
• “panic_on_db_errors”, optional, contols if to panic when there are errors replicating data to the PostgreSQL database. The default is ‘false’.
• “transaction_selector”, optional, controls if and what transaction to store. If this field is missing None of the transction is stored. “transaction_selector” : { “mentions” : [“pubkey-1”, “pubkey-2”, …, “pubkey-n”], } The mentions field support wildcard to select all transaction or all ‘vote’ transactions: For example, to select all transactions: “transaction_selector” : { “mentions” : [“*”], } To select all vote transactions: “transaction_selector” : { “mentions” : [“all_votes”], }

Examples

{ “libpath”: “/home/solana/target/release/libsolana_accountsdb_plugin_postgres.so”, “host”: “host_foo”, “user”: “solana”, “threads”: 10, “accounts_selector” : { “owners” : [“9oT9R5ZyRovSVnt37QvVoBttGpNqR3J7unkb567NP8k3”] } }

fn account_data_notifications_enabled(&self) -> bool

Check if the plugin is interested in account data Default is true – if the plugin is not interested in account data, please return false.

fn transaction_notifications_enabled(&self) -> bool

Check if the plugin is interested in transaction data

fn name(&self) -> &'static str

fn on_unload(&mut self)

The callback called right before a plugin is unloaded by the system Used for doing cleanup before unload.

fn update_account(
    &mut self,
    account: ReplicaAccountInfoVersions<'_>,
    slot: u64,
    is_startup: bool
) -> Result<()>

Called when an account is updated at a slot. When is_startup is true, it indicates the account is loaded from snapshots when the validator starts up. When is_startup is false, the account is updated during transaction processing.

fn update_slot_status(
    &mut self,
    slot: u64,
    parent: Option<u64>,
    status: SlotStatus
) -> Result<()>

Called when a slot status is updated

fn notify_end_of_startup(&mut self) -> Result<()>

Called when all accounts are notified of during startup.

fn notify_transaction(
    &mut self,
    transaction_info: ReplicaTransactionInfoVersions<'_>,
    slot: u64
) -> Result<()>

Called when a transaction is updated at a slot.

fn notify_block_metadata(
    &mut self,
    block_info: ReplicaBlockInfoVersions<'_>
) -> Result<()>

Called when block’s metadata is updated.

impl Debug for AccountsDbPluginPostgres

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

Formats the value using the given formatter.

impl Default for AccountsDbPluginPostgres

fn default() -> AccountsDbPluginPostgres

Returns the “default value” for a type.