Struct SqliteStorage

pub struct SqliteStorage { /* private fields */ }

SqliteStorage provides an interface for interacting with a SQLite database to store and retrieve application data, primarily [Command] and [VariableValue] entities

Implementations

impl SqliteStorage

pub async fn setup_workspace_storage(&self) -> Result<()>

Creates temporary tables for workspace-specific commands for the current session by reflecting the schema of the main command table.

pub async fn is_empty(&self) -> Result<bool>

Determines if the storage is empty, i.e., if there are no commands in the database

pub async fn find_tags( &self, filter: SearchCommandsFilter, tag_prefix: Option<String>, tuning: &SearchCommandTuning, ) -> Result<Vec<(String, u64, bool)>, SearchError>

Retrieves all tags from the database along with their usage statistics and if it’s an exact match for the prefix

pub async fn find_commands( &self, filter: SearchCommandsFilter, working_path: impl Into<String>, tuning: &SearchCommandTuning, ) -> Result<(Vec<Command>, bool), SearchError>

Finds and retrieves commands from the database.

When a search term is present, if there’s a command which alias exactly match the term, that’ll be the only one returned.

pub async fn import_commands( &self, commands: impl Stream<Item = Result<Command>> + Send + 'static, filter: Option<Regex>, overwrite: bool, workspace: bool, ) -> Result<(u64, u64)>

Imports a collection of commands into the database.

This function allows for bulk insertion or updating of commands from a stream. The behavior for existing commands depends on the overwrite flag.

Returns the number of new commands inserted and skipped/updated.

pub async fn export_user_commands( &self, filter: Option<Regex>, ) -> impl Stream<Item = Result<Command>> + Send + 'static

Export user commands

pub async fn delete_tldr_commands( &self, category: Option<String>, ) -> Result<u64>

Removes tldr commands

pub async fn insert_command( &self, command: Command, ) -> Result<Command, InsertError>

Inserts a new command into the database.

If a command with the same id or cmd already exists in the database, an error will be returned.

pub async fn update_command( &self, command: Command, ) -> Result<Command, UpdateError>

Updates an existing command in the database.

If the command to be updated does not exist, an error will be returned.

pub async fn increment_command_usage( &self, command_id: Uuid, path: impl AsRef<str> + Send + 'static, ) -> Result<i32, UpdateError>

Increments the usage of a command

pub async fn delete_command(&self, command_id: Uuid) -> Result<()>

Deletes an existing command from the database.

If the command to be deleted does not exist, an error will be returned.

impl SqliteStorage

pub async fn find_variable_values( &self, root_cmd: impl AsRef<str>, variable_name: impl AsRef<str>, working_path: impl Into<String>, context: &BTreeMap<String, String>, tuning: &SearchVariableTuning, ) -> Result<Vec<VariableValue>>

Finds variable values for a given root command, variable name and context.

The variable_name input can be a single term or multiple terms delimited by |. The method searches for values matching any of these individual (flattened) terms, as well as the (flattened) composite variable itself.

Results are returned for the original input variable, even if they don’t explicitly exists, ordered to prioritize overall relevance.

pub async fn insert_variable_value( &self, value: VariableValue, ) -> Result<VariableValue, InsertError>

Inserts a new variable value into the database if it doesn’t already exist

pub async fn update_variable_value( &self, value: VariableValue, ) -> Result<VariableValue, UpdateError>

Updates an existing variable value

pub async fn increment_variable_value_usage( &self, value_id: i32, path: impl AsRef<str> + Send + 'static, context: &BTreeMap<String, String>, ) -> Result<i32, UpdateError>

Increments the usage of a variable value

pub async fn delete_variable_value(&self, value_id: i32) -> Result<()>

Deletes an existing variable value from the database.

If the value to be deleted does not exist, an error will be returned.

impl SqliteStorage

pub async fn get_version_info(&self) -> Result<(Version, DateTime<Utc>)>

Gets the current version info from the database

pub async fn update_version_info( &self, latest_version: Version, last_checked_at: DateTime<Utc>, ) -> Result<()>

Updates the version info in the database

impl SqliteStorage

pub async fn new(data_dir: impl AsRef<Path>) -> Result<Self>

Creates a new instance of SqliteStorage using a persistent database file.

If INTELLI_STORAGE environment variable is set, it will use the specified path for the database file.

pub async fn query(&self, sql: String) -> Result<String>

Trait Implementations

impl Clone for SqliteStorage

fn clone(&self) -> SqliteStorage

Returns a duplicate of the value.

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

Performs copy-assignment from source.