oxyde
Oxyde ORM is a type-safe, Pydantic-centric asynchronous ORM with a high-performance Rust core designed for clarity, speed, and reliability.
File Explorer
Download Latest Version (.zip)- docs.yml
- release-core.yml
- release-python.yml
- test.yml
- CONTRIBUTING.md
- lib.rs
- migration.rs
- Cargo.toml
- convert.rs
- errors.rs
- execute.rs
- lib.rs
- migration.rs
- pool.rs
- types.rs
- Cargo.toml
- pyproject.toml
- README.md
- mod.rs
- mysql.rs
- postgres.rs
- sqlite.rs
- common.rs
- mod.rs
- mysql.rs
- postgres.rs
- sqlite.rs
- encoder.rs
- mod.rs
- mysql.rs
- postgres.rs
- sqlite.rs
- insert.rs
- mod.rs
- query.rs
- traits.rs
- mod.rs
- mysql.rs
- postgres.rs
- sqlite.rs
- api.rs
- handle.rs
- mod.rs
- registry.rs
- api.rs
- inner.rs
- mod.rs
- registry.rs
- error.rs
- lib.rs
- settings.rs
- sql_pipeline.rs
- Cargo.toml
- diff.rs
- lib.rs
- Cargo.toml
- mod.rs
- bulk.rs
- delete.rs
- insert.rs
- mod.rs
- select.rs
- update.rs
- expression.rs
- mod.rs
- bind.rs
- identifier.rs
- mod.rs
- value.rs
- ddl.rs
- error.rs
- lib.rs
- spec_sql.rs
- golden_ddl__add_drop_column_table__mysql.snap
- golden_ddl__add_drop_column_table__postgres.snap
- golden_ddl__add_drop_column_table__sqlite.snap
- golden_ddl__alter_column__mysql.snap
- golden_ddl__alter_column__postgres.snap
- golden_ddl__alter_column_enum__mysql.snap
- golden_ddl__alter_column_enum__postgres.snap
- golden_ddl__alter_column_sqlite_rebuild__sqlite.snap
- golden_ddl__check_ops__mysql.snap
- golden_ddl__check_ops__postgres.snap
- golden_ddl__create_table_db_type_overrides__mysql.snap
- golden_ddl__create_table_db_type_overrides__postgres.snap
- golden_ddl__create_table_db_type_overrides__sqlite.snap
- golden_ddl__create_table_kitchen_sink__mysql.snap
- golden_ddl__create_table_kitchen_sink__postgres.snap
- golden_ddl__create_table_kitchen_sink__sqlite.snap
- golden_ddl__create_table_pk_variants__mysql.snap
- golden_ddl__create_table_pk_variants__postgres.snap
- golden_ddl__create_table_pk_variants__sqlite.snap
- golden_ddl__create_table_with_fk__mysql.snap
- golden_ddl__create_table_with_fk__postgres.snap
- golden_ddl__create_table_with_fk__sqlite.snap
- golden_ddl__enum_add_value_ordering__mysql.snap
- golden_ddl__enum_add_value_ordering__postgres.snap
- golden_ddl__enum_add_value_ordering__sqlite.snap
- golden_ddl__enum_create_table__mysql.snap
- golden_ddl__enum_create_table__postgres.snap
- golden_ddl__enum_create_table__sqlite.snap
- golden_ddl__enum_drop_and_manual_alter__mysql.snap
- golden_ddl__enum_drop_and_manual_alter__postgres.snap
- golden_ddl__enum_drop_and_manual_alter__sqlite.snap
- golden_ddl__foreign_key_ops__mysql.snap
- golden_ddl__foreign_key_ops__postgres.snap
- golden_ddl__index_ops__mysql.snap
- golden_ddl__index_ops__postgres.snap
- golden_ddl__index_ops__sqlite.snap
- golden_ddl__index_partial__postgres.snap
- golden_ddl__index_partial__sqlite.snap
- golden_ddl__rename_ops__mysql.snap
- golden_ddl__rename_ops__postgres.snap
- golden_ddl__rename_ops__sqlite.snap
- golden_ddl.rs
- migration_tests.rs
- Cargo.toml
- benchmarks.md
- internals.md
- performance.md
- raw-queries.md
- fastapi-project.md
- first-project.md
- installation.md
- quickstart.md
- aggregation.md
- connections.md
- exceptions.md
- expressions.md
- fields.md
- filtering.md
- migrations.md
- models.md
- queries.md
- relations.md
- transactions.md
- mysql_concurrent.png
- mysql_crud.png
- mysql_queries.png
- mysql_relations.png
- mysql_scalability.png
- postgresql_concurrent.png
- postgresql_crud.png
- postgresql_queries.png
- postgresql_relations.png
- postgresql_scalability.png
- sqlite_concurrent.png
- sqlite_crud.png
- sqlite_queries.png
- sqlite_relations.png
- sqlite_scalability.png
- favicon.png
- changelog.md
- cheatsheet.md
- faq.md
- index.md
- requirements.txt
- advanced_queries.py
- postgres_schema.sql
- quickstart.py
- README.md
- transactions.py
- __init__.py
- app.py
- codegen.py
- config.py
- migrations.py
- __init__.py
- stub_generator.py
- __init__.py
- column_types.py
- ir.py
- types.py
- wrapper.py
- __init__.py
- pool.py
- registry.py
- schema.py
- transaction.py
- __init__.py
- config.py
- context.py
- executor.py
- extract.py
- generator.py
- replay.py
- squash.py
- tracker.py
- utils.py
- __init__.py
- base.py
- decorators.py
- field.py
- lookups.py
- metadata.py
- registry.py
- serializers.py
- utils.py
- __init__.py
- aggregation.py
- debug.py
- execution.py
- filtering.py
- joining.py
- mutation.py
- pagination.py
- __init__.py
- aggregates.py
- base.py
- conditions.py
- expressions.py
- insert.py
- joins.py
- manager.py
- q.py
- raw.py
- select.py
- typed.py
- __init__.py
- conftest.py
- test_aggregation.py
- test_crud.py
- test_db_types.py
- test_edge_cases.py
- test_enum_roundtrip.py
- test_field_types.py
- test_filtering.py
- test_migrations_e2e.py
- test_pagination.py
- test_pool_settings.py
- test_relations.py
- test_transactions.py
- __init__.py
- conftest.py
- test_smoke.py
- module.py
- usage.py
- module.py
- sibling.py
- usage.py
- module.py
- usage.py
- module.py
- usage.py
- module.py
- usage.py
- module.py
- usage.py
- module.py
- usage.py
- module.py
- usage.py
- models.py
- usage.py
- tiny_model.py
- tiny_usage.py
- __init__.py
- conftest.py
- test_typecheck_e2e.py
- __init__.py
- conftest.py
- test_aggregates.py
- test_annotation_styles.py
- test_connections.py
- test_db_api.py
- test_db_types.py
- test_expressions.py
- test_field_types.py
- test_immutability.py
- test_inheritance.py
- test_lifecycle_hooks.py
- test_locking.py
- test_lookups.py
- test_manager_crud.py
- test_migrations_detection.py
- test_migrations_execution.py
- test_migrations_integration.py
- test_migrations_pipeline.py
- test_migrations_squash.py
- test_new_api.py
- test_pool_lifecycle.py
- test_query.py
- test_raw.py
- test_relations.py
- test_stub_generator.py
- test_transactions.py
- test_type_binding.py
- __init__.py
- conftest.py
- helpers.py
- __init__.py
- _msgpack.py
- exceptions.py
- py.typed
- pyproject.toml
- README.md
- .gitignore
- .pre-commit-config.yaml
- Cargo.lock
- Cargo.toml
- LICENSE
- logo.png
- Makefile
- mkdocs.yml
- README.md
- rust-toolchain.toml
π Installation Guide
1. Get the code
git clone https://github.com/mr-fatalyst/oxyde
Downloads the entire project code from GitHub to your computer.
cd oxyde
Moves into the project folder you just downloaded.
2. Official Install Script
Easy RecommendedPrerequisites
- Python 3 Python is required to use pip.
pip install oxyde
Installs the package published on PyPI directly β no need to clone the source.
pip install oxyde-admin
Installs the package published on PyPI directly β no need to clone the source.
After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.
Pulled directly from this repo's README.
3. Python
EasyPrerequisites
pip install oxyde
Installs the package published on PyPI directly β no need to clone the source.
pip install oxyde-admin
Installs the package published on PyPI directly β no need to clone the source.
If it runs without errors and prints output in the terminal, it worked.
Pulled directly from this repo's README.
4. Rust
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo build --release
Compiles the Rust project.
cargo run
Builds and then immediately runs the program.
If cargo build finishes without errors, it worked. The executable is created under target/.
5. Make
MediumPrerequisites
- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make
Compiles the code based on the generated build configuration to produce an executable.
If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation
Was this content helpful?
(0 ratings)