API Reference for Jorm.jl

struct RawSQL  
    value: String

A struct to hold raw SQL Queries

backup_postgresql_db(db_name::String, host::String="localhost", user::String="postgres", password::String="", backup_file::String="backup.sql") 
# Usage
backup_postgresql_db("mydb", "localhost", "postgres", "mypassword", "backup.sql")

backup_sqlite_db(db::SQLite.DB, model) 
# usage
backup_sqlite_db("example.db", "example_backup.db")

connect(connection_string::String)
    -> LibPQ.Connection

Establish a connection to an SQLite database using the provided connection string.

connect(connection_string::String)
    -> SQLite.DB

Establish a connection to an SQLite database using the provided connection string.

create_table(db::SQLite.DB, model, tableName)
Creates a table in the database based on the model.

delete!(db::SQLite.DB, model, id)
Delete data for a given model

delete_all(db::SQLite.DB, model) 
Deletes all data in the table for the given model

delete_db(connection_string::Jorm.PostgreSQLConnectionString)
Deletes or removes a an PostgreSQL database

delete_db(connection_string::Jorm.SQLiteConnectionString)
Deletes or removes a an sqlite database

disconnect(db::LibPQ.Connection)
    -> Nothing

Close the connection to the PostgreSQL database.

disconnect(db::SQLite.DB)
    -> Nothing

Close the connection to the SQLite database.

drop_all_tables(connection_string::SQLiteConnectionString) 
Delete or Drop all tables for a given table

execute_query(db::SQLite.DB, query::RawSQL, params::Vector{Any}=Any[]) 
Returns the executed sql

execute_query(db::LibPQ.Connection, query::RawSQL, params::Vector{Any}=Any[]) 
Returns the executed sql

filter_by(db::SQLite.DB, model, table_name; kwargs...) 
Returns the result of the given condition from the Database. This uses `SELECT`

filter_by_sql(table_name; kwargs...)
Filter data by condition from the database

getfirst(db::SQLite.DB, model, column,value) 
Returns a given model object when given the column and the search value

groupby_sql(table_name; group_by_columns, select_columns = "*", having_conditions = nothing, order_by_columns = nothing) 
Returns the result of the given condition from the Database. This uses `SELECT`

insert!(db::SQLite.DB, model::Type, data) 
Insert or Add data to the DB for a given model

list_tables(connection_string::SQLiteConnectionString) 
Returns the list of tables in DB

ls_tables(connection_string::SQLiteConnectionString) 
Returns the list of tables in DB

read_all(db::SQLite.DB, model) 
Returns all data of a given model object

read_one(db::SQLite.DB, model, id) 
Returns a given model object when given the ID

serialize_to_list(outputmodel::Type,queryresult)
Convert an SQL Query result into serialized list
outputmodel:: Same Model but with id::Int defined to handle auto generated ID 
from autoincrement

tablename(model) 
Generate the table name for a given model. The table name is derived from the model's type name, converting it to lowercase and joining words with underscores.

struct MyModel end println(tablename(MyModel)) # Output: "my_model"

update!(db::SQLite.DB, model, id, data)
Update data to the DB for a given model

macro raw_sql(v::String)
    -> RawSQL

Create a RawSQL instance from a given SQL query string.