Struct Database

pub struct Database { /* private fields */ }

The main database interface for command-vault.

Handles all database operations including:

• Command storage and retrieval
• Tag management
• Search functionality

Example

use anyhow::Result;
use command_vault::db::Database;
 
fn main() -> Result<()> {
    let db = Database::new("commands.db")?;
    db.init()?;
    Ok(())
}

Implementations

impl Database

pub fn new(path: &str) -> Result<Self>

Creates a new database connection.

Arguments

• path - Path to the SQLite database file

Returns

• Result<Database> - A new database instance

pub fn init(&self) -> Result<()>

Initializes the database schema.

Creates the following tables if they don’t exist:

• commands: Stores command information
• tags: Stores tag information
• command_tags: Links commands to tags

pub fn add_command(&mut self, command: &Command) -> Result<i64>

Adds a new command to the database.

Arguments

• command - The command to add

Returns

• Result<i64> - The ID of the newly added command

pub fn add_tags_to_command( &mut self, command_id: i64, tags: &[String], ) -> Result<()>

Adds tags to an existing command.

Arguments

• command_id - The ID of the command to add tags to
• tags - The tags to add

Returns

• Result<()> - Success or failure

pub fn remove_tag_from_command( &mut self, command_id: i64, tag_name: &str, ) -> Result<()>

Removes a tag from a command.

Arguments

• command_id - The ID of the command to remove the tag from
• tag_name - The name of the tag to remove

Returns

• Result<()> - Success or failure

pub fn search_commands(&self, query: &str, limit: usize) -> Result<Vec<Command>>

Searches for commands containing a given query string.

Arguments

• query - The query string to search for
• limit - The maximum number of results to return

Returns

• Result<Vec<Command>> - A list of matching commands

pub fn search_by_tag(&self, tag: &str, limit: usize) -> Result<Vec<Command>>

Searches for commands with a given tag.

Arguments

• tag - The tag to search for
• limit - The maximum number of results to return

Returns

• Result<Vec<Command>> - A list of matching commands

pub fn list_tags(&self) -> Result<Vec<(String, i64)>>

Lists all tags in the database.

Returns

• Result<Vec<(String, i64)>> - A list of tags with their respective counts

pub fn list_commands( &self, limit: usize, ascending: bool, ) -> Result<Vec<Command>>

Lists all commands in the database.

Arguments

• limit - The maximum number of results to return
• ascending - Whether to return results in ascending order

Returns

• Result<Vec<Command>> - A list of commands

pub fn get_command(&self, id: i64) -> Result<Option<Command>>

Gets a command by its ID.

Arguments

• id - The ID of the command to retrieve

Returns

• Result<Option<Command>> - The command if found

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

Updates an existing command.

Arguments

• command - The updated command

Returns

• Result<()> - Success or failure

pub fn delete_command(&mut self, command_id: i64) -> Result<()>

Deletes a command by its ID.

Arguments

• command_id - The ID of the command to delete

Returns

• Result<()> - Success or failure