pagetop/extensions/pagetop-seaorm

PageTop SeaORM

Proporciona a PageTop acceso basado en SeaORM a bases de datos relacionales.

Sobre PageTop

PageTop es un entorno de desarrollo que reivindica la esencia de la web clásica para crear soluciones web SSR (renderizadas en el servidor) modulares, extensibles y configurables, basadas en HTML, CSS y JavaScript.

Guía rápida

Añade la dependencia a tu Cargo.toml activando el motor de base de datos que necesites:

[dependencies]
pagetop-seaorm = { version = "...", features = ["sqlite"] }

Las features disponibles son mysql, postgres y sqlite.

Configura la conexión en el archivo de configuración de la aplicación:

[database]
db_type = "sqlite"
db_name = "my_app.db"
max_pool_size = 5

Para MySQL o PostgreSQL añade también db_user, db_pass y db_host. El campo db_port es opcional; si se omite se usa el puerto predeterminado del motor.

Declara la extensión en tu aplicación o en la extensión que la requiera:

use pagetop::prelude::*;
use pagetop_seaorm::install_migrations;

mod migration;

struct MyApp;

impl Extension for MyApp {
    fn dependencies(&self) -> Vec<ExtensionRef> {
        vec![
            &pagetop_seaorm::SeaORM,
        ]
    }

    fn initialize(&self) {
        install_migrations!(m20240101_000001_create_users);
    }
}

#[pagetop::main]
async fn main() -> std::io::Result<()> {
    Application::prepare(&MyApp).run()?.await
}

Escribe las migraciones usando la API de [migration]:

// src/migration/m20240101_000001_create_users.rs
use pagetop_seaorm::migration::*;

pub struct Migration;

#[async_trait::async_trait]
impl MigrationTrait for Migration {
    async fn up(&self, manager: &SchemaManager) -> Result<(), DbErr> {
        manager
            .create_table(
                table_auto(Users::Table)
                    .col(pk_auto(Users::Id))
                    .col(string_uniq(Users::Email))
                    .col(string(Users::Name))
                    .to_owned(),
            )
            .await
    }
}

#[derive(DeriveIden)]
enum Users {
    Table,
    Id,
    Email,
    Name,
}

Define las entidades en un módulo entity/ usando las macros de derivación de [db]:

// src/entity/user.rs
use pagetop_seaorm::db::*;

#[derive(Clone, Debug, DeriveEntityModel, PartialEq)]
#[sea_orm(table_name = "users")]
pub struct Model {
    #[sea_orm(primary_key)]
    pub id: i32,
    pub email: String,
    pub name: String,
}

#[derive(Clone, Copy, Debug, DeriveRelation, EnumIter)]
pub enum Relation {}

impl ActiveModelBehavior for ActiveModel {}

Opera con la base de datos pasando la conexión [db::dbconn()] a cada consulta:

use pagetop_seaorm::db::*;

// Asumiendo que existe un módulo `user` con la entidad definida arriba.
async fn example() -> Result<(), DbErr> {
    // Listar todos los registros:
    let users = user::Entity::find().all(dbconn()).await?;

    // Buscar por clave primaria:
    let found = user::Entity::find_by_id(1).one(dbconn()).await?;

    // Insertar un registro:
    let new_user = user::ActiveModel {
        email: Set("alice@example.com".to_owned()),
        name: Set("Alice".to_owned()),
        ..Default::default()
    };
    user::Entity::insert(new_user).exec(dbconn()).await?;
    Ok(())
}

Créditos

Este crate se apoya en bibliotecas del ecosistema SeaQL como:

• SeaORM, ORM asíncrono que usa internamente SQLx para el acceso y la ejecución de consultas a la base de datos.

• SeaQuery, generador de consultas SQL sobre el que se construye el motor de migraciones y los helpers de esquema.

• sea-schema, librería de introspección de esquemas SQL, usada por el módulo de migraciones para interrogar la estructura real de la base de datos (tablas, columnas, índices y claves externas).

El módulo de migraciones (src/migration/) incorpora una adaptación de sea-orm-migration. El código que se integra procede de la versión 1.1.20 en lugar de usarlo como dependencia ya que su paradigma de CLI no es compatible con el ciclo de vida de las extensiones de PageTop, donde las migraciones deben ejecutarse durante la inicialización de cada extensión. Los ficheros adaptados del original son:

Archivos	Observaciones
lib.rs	Incluido en migration.rs, descarta módulos y exportaciones del CLI
connection.rs	Integración completa
manager.rs	Adapta features propias
migrator.rs	Adapta features propias y omite gestión de errores del CLI
prelude.rs	Absorbido en migration.rs, descarta exportaciones del CLI
schema.rs	Integra con ajustes, adaptado de loco
seaql_migrations.rs	Integración completa

Advertencia

PageTop es un proyecto personal para aprender Rust y conocer su ecosistema. Su API está sujeta a cambios frecuentes. No se recomienda su uso en producción, al menos hasta que se libere la versión 1.0.0.

Licencia

El código está disponible bajo una doble licencia:

• Licencia MIT (LICENSE-MIT o también https://opensource.org/licenses/MIT)

• Licencia Apache, Versión 2.0 (LICENSE-APACHE o también https://www.apache.org/licenses/LICENSE-2.0)

Puedes elegir la licencia que prefieras. Este enfoque de doble licencia es el estándar de facto en el ecosistema Rust.