Struct vibrant::db::Database

pub struct Database {
    pub base: StarterDatabase,
    pub auth: AuthDatabase,
    pub logs: LogDatabase,
}

Fields

base: StarterDatabase

auth: AuthDatabase

logs: LogDatabase

Implementations

impl Database

pub async fn new(opts: DatabaseOpts) -> Database

pub async fn init(&self)

pub fn sort_hashmap_by_keys<T>( &self, hashmap: HashMap<String, T> ) -> Vec<(String, T)>

Sort a hashmap by its keys from shortest to longest

pub async fn general_query( &self, query: String ) -> DefaultReturn<Vec<HashMap<String, String>>>

Run a general SQL query and return the result

pub async fn get_project_by_id( &self, name: String ) -> DefaultReturn<Option<Project>>

Get a Project by its name.

Arguments:

• name - project name

pub async fn get_projects_by_owner_limited( &self, owner: String, offset: Option<i32> ) -> DefaultReturn<Option<Vec<PCreateProject>>>

Get all projects owned by a specific user (limited), sorted by billing period start

Arguments:

• owner - String of the owner’s username
• offset - optional value representing the SQL fetch offset

pub async fn create_project( &self, props: &mut PCreateProject, as_user: Option<String> ) -> DefaultReturn<Option<PCreateProject>>

Create a new Project given various properties

Arguments:

• props - (PROPS)CreateProject
• as_user - The username of the user creating the project

pub async fn edit_fields_by_name( &self, name: String, fields: PEditFieldsByName, edit_as: Option<String>, bypass_user_checks: bool ) -> DefaultReturn<Option<String>>

Update a Project’s fields by its name

pub async fn incr_project_requests(&self, name: String) -> bool

Increment a Project’s billing request limit (redis)

Arguments:

• name - project name

pub async fn edit_project_metadata_by_name( &self, name: String, metadata: ProjectMetadata, edit_as: Option<String> ) -> DefaultReturn<Option<String>>

Update a Project’s metadata by its name

pub async fn edit_project_private_metadata_by_name( &self, name: String, metadata: ProjectPrivateMetadata ) -> DefaultReturn<Option<String>>

Update a Project’s private metadata by its name

pub async fn delete_project( &self, name: String, delete_as: Option<String> ) -> DefaultReturn<Option<String>>

Delete a Project given its name

pub async fn get_file_in_project( &self, name: String, path: String, as_user: Option<String>, bypass_user_checks: bool, protected: bool ) -> DefaultReturn<Option<Vec<u8>>>

Get a file by path in the given Project

pub async fn get_project_files( &self, name: String, as_user: Option<String>, bypass_user_checks: bool ) -> DefaultReturn<Vec<String>>

Get all file (names) in the given Project

pub async fn store_file_in_project( &self, name: String, path: String, content: String, edit_as: Option<String> ) -> DefaultReturn<Option<String>>

Create a file by path in the given Project

pub async fn update_file_in_project( &self, name: String, path: String, content: String, edit_as: Option<String> ) -> DefaultReturn<Option<String>>

Update a file by path in the given Project

pub async fn delete_file_in_project( &self, name: String, path: String, edit_as: Option<String> ) -> DefaultReturn<Option<String>>

Delete a file by path in the given Project

pub async fn move_file_in_project( &self, name: String, path: String, new_path: String, edit_as: Option<String> ) -> DefaultReturn<Option<String>>

Move a file by path to new_path in the given Project

pub async fn get_project_favorites(&self, name: String) -> DefaultReturn<i32>

Get the number of ProjectFavoriteLogs a Project has

pub async fn get_user_project_favorite( &self, user: String, project: String, skip_existing_check: bool ) -> DefaultReturn<Option<Log>>

pub async fn toggle_user_project_favorite( &self, user: String, project: String ) -> DefaultReturn<Option<String>>

Toggle a ProjectFavoriteLog on a Project by user and project

pub async fn get_project_score( &self, project: String ) -> DefaultReturn<Option<Score>>

Get a Project score from the /.secrets/palette.toml file

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a copy of the value.

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

Performs copy-assignment from source.