pinger_bot.models

DB models for the project.

Module Contents

Classes

Server	A server model. Used to store the server, that was added to bot.
Ping	Represents a single ping record in DB.
Database	Some cached info about database.

Attributes

Base	Base object for all models.
db	Initialized Database object.

Base

Base object for all models.

See also

https://docs.sqlalchemy.org/en/14/orm/mapping_api.html#sqlalchemy.orm.declarative_base

class Server

Bases: Base

A server model. Used to store the server, that was added to bot.

__tablename__ = pb_servers

id: int

Unique ID of the server, primary key.

host: str

Hostname of the server, can be number IP or domain. Always without port.

port: int

Port of the server.

max: int

Max players on the server.

alias: str | None

Alias of the server. Can be used as IP of the server.

owner: int

Owner’s Discord ID of the server.

__table_args__ = ()

Unique constraint for host and port.

class Ping

Bases: Base

Represents a single ping record in DB.

__tablename__ = pb_pings

id: int

Unique ID of the ping, primary key.

host: str

Host of the server, for which ping was made. This is a foreign key constraint.

port: int

Port of the server, for which ping was made. This is a foreign key constraint.

time: datetime.datetime

Time of the ping. Default to current time.

players: int

Players online in moment of the ping.

__mapper_args__

Some magic to make eager loading work.

See also

https://docs.sqlalchemy.org/en/14/orm/extensions/asyncio.html#synopsis-orm

__table_args__ = ()

Define Foreign Key Constraint to associate pb_pings.host and pb_pings.port to pb_pings.host and pb_pings.port.

class Database

Some cached info about database.

engine() → sqlalchemy.ext.asyncio.AsyncEngine

Async engine of the Database.

session() → Callable[[], AsyncContextManager[sqlalchemy.ext.asyncio.AsyncSession]]

Async session of the Database.

db

Initialized Database object.