Struct ProjectState 

pub struct ProjectState {
    pub models: BTreeMap<(String, String), ModelState>,
}

Project state for migration detection

Django equivalent: ProjectState in django/db/migrations/state.py

Examples

use reinhardt_db::migrations::{ProjectState, ModelState, FieldState, FieldType};

let mut state = ProjectState::new();
let mut model = ModelState::new("myapp", "User");
model.add_field(FieldState::new("id", FieldType::Integer, false));
state.add_model(model);

assert!(state.get_model("myapp", "User").is_some());

Fields

models: BTreeMap<(String, String), ModelState>

Models: (app_label, model_name) -> ModelState

Implementations

impl ProjectState

pub fn to_database_schema(&self) -> DatabaseSchema

Available on native and crate feature database only.

Converts to database schema.

pub fn to_database_schema_for_app(&self, app_label: &str) -> DatabaseSchema

Available on native and crate feature database only.

Convert ProjectState to DatabaseSchema for a specific app

This method filters models by app_label before converting to DatabaseSchema, allowing per-app migration generation.

Examples

use reinhardt_db::migrations::ProjectState;

let state = ProjectState::from_global_registry();
let schema = state.to_database_schema_for_app("users");
// schema contains only tables for the "users" app

pub fn new() -> ProjectState

Available on native and crate feature database only.

Create a new empty ProjectState

Examples

use reinhardt_db::migrations::ProjectState;

let state = ProjectState::new();
assert_eq!(state.models.len(), 0);

pub fn add_model(&mut self, model: ModelState)

Available on native and crate feature database only.

Add a model to this project state

Examples

use reinhardt_db::migrations::{ProjectState, ModelState};

let mut state = ProjectState::new();
let model = ModelState::new("myapp", "User");
state.add_model(model);

assert_eq!(state.models.len(), 1);
assert!(state.get_model("myapp", "User").is_some());

pub fn get_model( &self, app_label: &str, model_name: &str, ) -> Option<&ModelState>

Available on native and crate feature database only.

Get a model by app_label and model_name

Examples

use reinhardt_db::migrations::{ProjectState, ModelState};

let mut state = ProjectState::new();
let model = ModelState::new("myapp", "User");
state.add_model(model);

let retrieved = state.get_model("myapp", "User");
assert!(retrieved.is_some());
assert_eq!(retrieved.unwrap().name, "User");

pub fn get_model_mut( &mut self, app_label: &str, model_name: &str, ) -> Option<&mut ModelState>

Available on native and crate feature database only.

Get a mutable reference to a model

Examples

use reinhardt_db::migrations::{ProjectState, ModelState, FieldState, FieldType};

let mut state = ProjectState::new();
let model = ModelState::new("myapp", "User");
state.add_model(model);

if let Some(model) = state.get_model_mut("myapp", "User") {
    let field = FieldState::new("email", FieldType::VarChar(255), false);
    model.add_field(field);
}

assert!(state.get_model("myapp", "User").unwrap().has_field("email"));

pub fn get_model_by_table_name( &self, app_label: &str, table_name: &str, ) -> Option<&ModelState>

Available on native and crate feature database only.

Get a model by table name

Examples

use reinhardt_db::migrations::{ProjectState, ModelState};

let mut state = ProjectState::new();
let mut model = ModelState::new("myapp", "User");
model.table_name = "myapp_user".to_string();
state.add_model(model);

let retrieved = state.get_model_by_table_name("myapp", "myapp_user");
assert!(retrieved.is_some());
assert_eq!(retrieved.unwrap().name, "User");

pub fn filter_by_app(&self, app_label: &str) -> ProjectState

Available on native and crate feature database only.

Filter models by app_label and return a new ProjectState containing only those models

This method is used to create app-specific ProjectState for per-app migration generation.

Examples

use reinhardt_db::migrations::{ProjectState, ModelState};

let mut state = ProjectState::new();
state.add_model(ModelState::new("users", "User"));
state.add_model(ModelState::new("users", "Profile"));
state.add_model(ModelState::new("posts", "Post"));

let users_state = state.filter_by_app("users");
assert_eq!(users_state.models.len(), 2);
assert!(users_state.get_model("users", "User").is_some());
assert!(users_state.get_model("users", "Profile").is_some());
assert!(users_state.get_model("posts", "Post").is_none());

pub fn remove_model( &mut self, app_label: &str, model_name: &str, ) -> Option<ModelState>

Available on native and crate feature database only.

Remove a model from this project state

Examples

use reinhardt_db::migrations::{ProjectState, ModelState};

let mut state = ProjectState::new();
let model = ModelState::new("myapp", "User");
state.add_model(model);

state.remove_model("myapp", "User");
assert!(state.get_model("myapp", "User").is_none());

pub fn rename_model( &mut self, app_label: &str, old_name: &str, new_name: String, )

Available on native and crate feature database only.

Rename a model

Examples

use reinhardt_db::migrations::{ProjectState, ModelState};

let mut state = ProjectState::new();
let model = ModelState::new("myapp", "User");
state.add_model(model);

state.rename_model("myapp", "User", "Account".to_string());
assert!(state.get_model("myapp", "User").is_none());
assert!(state.get_model("myapp", "Account").is_some());

pub fn from_global_registry() -> ProjectState

Available on native and crate feature database only.

Load ProjectState from the global model registry

Django equivalent: ProjectState.from_apps() in django/db/migrations/state.py:594-600

Examples

use reinhardt_db::migrations::ProjectState;

let state = ProjectState::from_global_registry();
// state will contain all models registered in the global registry

pub fn from_migrations(migrations: &[Migration]) -> ProjectState

Available on native and crate feature database only.

Load ProjectState from a list of migrations

This method constructs a ProjectState by applying all operations from the provided migrations in order. This is useful for determining what the database schema should look like after applying all migrations.

Examples

use reinhardt_db::migrations::{ProjectState, Migration};

let migrations = vec![/* ... */];
let state = ProjectState::from_migrations(&migrations);
// state will contain all models as they would exist after applying all migrations

pub fn apply_migration_operations( &mut self, operations: &[Operation], app_label: &str, )

Available on native and crate feature database only.

Apply migration operations to this project state

This method processes each operation and updates the ProjectState accordingly. It handles:

• CreateTable: Creates a new model
• DropTable: Removes a model
• AddColumn: Adds a field to a model
• DropColumn: Removes a field from a model
• AlterColumn: Modifies a field
• RenameTable: Renames a model’s table
• RenameColumn: Renames a field
• Other operations are logged but not applied to state

pub fn find_model_by_table(&self, table_name: &str) -> Option<&ModelState>

Available on native and crate feature database only.

Helper: Find a model by table name (immutable)

pub fn find_model_by_table_mut( &mut self, table_name: &str, ) -> Option<&mut ModelState>

Available on native and crate feature database only.

Helper: Find a model by table name (mutable)

Trait Implementations

impl Clone for ProjectState

fn clone(&self) -> ProjectState

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProjectState

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for ProjectState

fn default() -> ProjectState

Returns the “default value” for a type.