ormlite package

Module contents

class ormlite.Row(model, extra)

Bases: Generic[Model]

extra: dict

model: TypeVar(Model)

ormlite.connect_to_sqlite(file_name)

Opens a new sqlite connection in Auto-commit mode.

Parameters:

file_name (str) – sqlite database file to open (or create if it doesn’t exist yet). Use the special argument of “:memory:” to only hold the database in memory and skip writing to file.

Return type:

Connection

ormlite.field(*, pk=False, fk=None, **kwargs)

ormlite.migrate(db)

Warning: This will destructively delete your data. Don’t use this if want to keep old tables data around even if there’s no corresponding python model.

Your python code is treated as the source of truth, and migrate forces your sqlite schema to match.

Every python class with the @model decorator is synced with a sqlite table. Every sqlite table that has no corresponding model is deleted.

Specifically, this:

• Creates new tables to match new models

• Drops tables that don’t correspond to any defined models

• Adds new columns to existing tables

• Drops old columns from existing tables

ormlite.model(sql_table_name)

ormlite.select(model)

Begin a select query. Literally just an alias for the SelectQuery constructor.

Parameters:

model (type[TypeVar(Model)]) – Model class; this determines which model is when binding the sql rows into python objects

Return type:

SelectQuery[TypeVar(Model)]

ormlite.upsert(db, records, *, update)

Insert records, on conflict, update fields but only specific ones

Parameters:

• db (DatabaseConnection) – A sqlite database connection

• records (list[TypeVar(Model)]) – Records to insert or update

• update (list[str]) – List of column names to update in case of conflict

ormlite.query module

class ormlite.query.SelectQuery(model)

Select query builder. This object is mutable and chainable way to describe a sql query. These methods mutate the builder and return the builder to continue the chain:

• extra

• where

• limit

• join

• order_by

These methods execute the current query:

• rows

• models

• dicts

dicts(db)

Return type:

list[dict[str, Any]]

extra(*fields)

Return type:

SelectQuery[TypeVar(Model)]

join(model, /)

Join with another table. :param: model

Return type:

SelectQuery[TypeVar(Model)]

limit(limit, /)

Applies a sql LIMIT. Note that calling this multiple times on the same query, will override the previously set limit.

Return type:

SelectQuery[TypeVar(Model)]

models(db)

Return type:

list[TypeVar(Model)]

order_by(clause, /)

Return type:

SelectQuery[TypeVar(Model)]

rows(db)

Return type:

list[Row[TypeVar(Model)]]

where(condition=None, /, **kwargs)

Return type:

SelectQuery[TypeVar(Model)]

ormlite.errors module

exception ormlite.errors.InvalidForeignKeyError

Bases: Exception

exception ormlite.errors.MissingAdapterError

Bases: Exception

exception ormlite.errors.MultiplePrimaryKeysError

Bases: Exception

exception ormlite.errors.RegexMatchError

Bases: Exception