Skip to content

database

cortexmancer edited this page Jun 25, 2026 · 2 revisions

database

Provides database connection and SQL queries throught ORM.


DatabaseType Objects

class DatabaseType(StrEnum)

Enum to name databases


DatabaseConnection Objects

class DatabaseConnection()

Class to hold database engine.


init_db

def init_db(db_path, db_type) -> None

Init an DatabaseConnection, if there is no tables, creates then


insert_credentials

def insert_credentials(user_id, password)

Insert an Credentials model entrie in Client Database.


insert_hidro

def insert_hidro(collection: List[HidroBase], has_id=False) -> None

Insert a list of Hidro ORM Model into Hidro Database


insert_jobs

def insert_jobs(jobs: List[HidroJob]) -> None

Insert a list of Jobs into Client Database.


update_jobs

def update_jobs(jobs: List[HidroJob], job_config: JobConfig) -> None

Updates a list of Jobs.


count_client

def count_client(model: ClientBase)

Counts a given Model in Client Database.


get_credentials

def get_credentials() -> Credentials

Gets the first registered Credential on Client Database and returns it.


add_token

def add_token(client_id, token, expires)

Add an Token to Client Database


get_token_model

def get_token_model() -> Token

Returns the first found Token on Client Database


update_token

def update_token(RegistroID, new_token, new_expires)

Updates an Token on Client Database


get_station_jobs

def get_station_jobs(status) -> StationJobs

Returns all Stations Jobs on Client Database


get_jobs_yield

def get_jobs_yield(job_config, status)

Returns all Series Jobs on Client Database, yield then in batches


count_job

def count_job(job_config: JobConfig, status=None)

Counts jobs registered in Client Database.


count_hidro

def count_hidro(model: HidroBase)

Counts a given Model in Hidro Database.


get_states

def get_states() -> State

Returns registered States in Hidro Database.


get_rain_period

def get_rain_period()

Returns Stations with Rain Periods in Hidro Database.


get_discharge_period

def get_discharge_period()

Returns Stations with Discharge Periods in Hidro Database.


get_sediments_period

def get_sediments_period()

Returns Stations with Sediments Periods in Hidro Database.


get_water_period

def get_water_period()

Returns Stations with Water Periods in Hidro Database.


get_stage_period

def get_stage_period()

Returns Stations with Stage Periods in Hidro Database.

Clone this wiki locally