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 and completions for the current session by reflecting the schema of the main tables.

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)>>

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)>

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 delete_tldr_commands( &self, category: Option<String>, ) -> Result<u64>

Removes tldr commands

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

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>

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>

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 list_variable_completion_root_cmds(&self) -> Result<Vec<String>>

Lists all unique root commands for variable completions

pub async fn list_variable_completions( &self, flat_root_cmd: Option<String>, flat_variable_names: Option<Vec<String>>, skip_workspace: bool, ) -> Result<Vec<VariableCompletion>>

Lists variable completions, optionally filtering by root command and variable

Stored completions take precedence over workspace ones

pub async fn get_completions_for( &self, flat_root_cmd: impl Into<String>, flat_variable_names: Vec<String>, ) -> Result<Vec<VariableCompletion>>

Retrieves the variable completions that must be considered for a given root command and variable, considering the order preference:

1. A completion matching the specific root command is preferred over a generic one
2. A user-defined completion is preferred over a workspace one

pub async fn insert_variable_completion( &self, var: VariableCompletion, ) -> Result<VariableCompletion>

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

pub async fn update_variable_completion( &self, var: VariableCompletion, ) -> Result<VariableCompletion>

Updates an existing variable completion

pub async fn delete_variable_completion( &self, completion_id: Uuid, ) -> Result<()>

Deletes an existing variable completion from the database

pub async fn delete_variable_completion_by_key( &self, flat_root_cmd: impl Into<String>, flat_variable_name: impl Into<String>, ) -> Result<Option<VariableCompletion>>

Deletes an existing variable completion from the database given its unique key

impl SqliteStorage

pub async fn import_items( &self, items: impl Stream<Item = Result<ImportExportItem>> + Send + 'static, overwrite: bool, workspace: bool, ) -> Result<ImportStats>

Imports a collection of commands and completions into the database.

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

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

Export user commands

pub async fn export_user_variable_completions( &self, flat_root_cmd_and_var: impl IntoIterator<Item = (String, String)>, ) -> Result<Vec<VariableCompletion>>

Exports user variable completions for a given set of (flat_root_cmd, flat_variable_name) pairs.

For each pair, it resolves the best match by first looking for a completion with the specific flat_root_cmd, falling back to one with an empty one if not found.

Note: This method does not consider workspace-specific completions, only user tables.

impl SqliteStorage

pub async fn find_variable_values( &self, flat_root_cmd: impl Into<String>, flat_variable_name: impl Into<String>, flat_variable_names: Vec<String>, working_path: impl Into<String>, context: &BTreeMap<String, String>, tuning: &SearchVariableTuning, ) -> Result<Vec<(VariableValue, f64)>>

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

The method searches for values matching any of these individual flat_variable_names terms, as well as the flat_variable_name 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>

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>

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>

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.