ferrum-orm 0.1.2__tar.gz → 0.1.4__tar.gz

{ferrum_orm-0.1.2 → ferrum_orm-0.1.4}/Cargo.lock

@@ -223,7 +223,7 @@ checksum = "9f1f227452a390804cdb637b74a86990f2a7d7ba4b7d5693aac9b4dd6defd8d6"
 
 [[package]]
 name = "ferrum-core"
-version = "0.1.2"
+version = "0.1.4"
 dependencies = [
  "criterion",
  "proptest",
@@ -234,7 +234,7 @@ dependencies = [
 
 [[package]]
 name = "ferrum-migrate"
-version = "0.1.2"
+version = "0.1.4"
 dependencies = [
  "ferrum-core",
  "serde",
@@ -243,23 +243,26 @@ dependencies = [
 
 [[package]]
 name = "ferrum-pyo3"
-version = "0.1.2"
+version = "0.1.4"
 dependencies = [
  "ferrum-core",
  "ferrum-sql",
  "pyo3",
+ "rmp-serde",
  "serde_json",
  "thiserror",
 ]
 
 [[package]]
 name = "ferrum-sql"
-version = "0.1.2"
+version = "0.1.4"
 dependencies = [
  "criterion",
  "ferrum-core",
  "proptest",
+ "rmp-serde",
  "serde",
+ "serde_json",
  "thiserror",
 ]
 
@@ -726,6 +729,25 @@ version = "0.8.11"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d6f6ff9a378485b298a5286656da665ba74413d36db0979633275d2e708145d4"
 
+[[package]]
+name = "rmp"
+version = "0.8.15"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "4ba8be72d372b2c9b35542551678538b562e7cf86c3315773cae48dfbfe7790c"
+dependencies = [
+ "num-traits",
+]
+
+[[package]]
+name = "rmp-serde"
+version = "1.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "72f81bee8c8ef9b577d1681a70ebbc962c232461e397b22c208c43c04b67a155"
+dependencies = [
+ "rmp",
+ "serde",
+]
+
 [[package]]
 name = "rustix"
 version = "1.1.4"

{ferrum_orm-0.1.2 → ferrum_orm-0.1.4}/Cargo.toml

@@ -3,7 +3,7 @@ members = ["crates/ferrum-core", "crates/ferrum-sql", "crates/ferrum-pyo3"]
 resolver = "2"
 
 [workspace.package]
-version = "0.1.2"
+version = "0.1.4"
 edition = "2021"
 authors = ["Ferrum Contributors"]
 license = "Apache-2.0"
@@ -17,6 +17,9 @@ pyo3 = { version = "0.29", features = ["abi3-py311"] }
 # Serialization
 serde = { version = "1", features = ["derive"] }
 serde_json = "1"
+# MessagePack wire format for the PyO3 boundary (always compiled; the Python
+# `[msgpack]` extra gates only the runtime `msgpack` package + selection).
+rmp-serde = "1"
 
 # Error handling
 thiserror = "2"

{ferrum_orm-0.1.2 → ferrum_orm-0.1.4}/PKG-INFO

@@ -1,14 +1,16 @@
 Metadata-Version: 2.4
 Name: ferrum-orm
-Version: 0.1.2
+Version: 0.1.4
 Classifier: Development Status :: 3 - Alpha
 Classifier: Framework :: AsyncIO
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Rust
 Classifier: Topic :: Database
 Classifier: Topic :: Software Development :: Libraries
@@ -17,6 +19,8 @@ Requires-Dist: pydantic>=2.0
 Requires-Dist: ferrum-orm[pg] ; extra == 'all'
 Requires-Dist: ferrum-orm[mysql] ; extra == 'all'
 Requires-Dist: ferrum-orm[sqlite] ; extra == 'all'
+Requires-Dist: ferrum-orm[mssql] ; extra == 'all'
+Requires-Dist: ferrum-orm[msgpack] ; extra == 'all'
 Requires-Dist: ferrum-orm[cli] ; extra == 'all'
 Requires-Dist: ferrum-orm[dotenv] ; extra == 'all'
 Requires-Dist: typer>=0.12 ; extra == 'cli'
@@ -32,8 +36,12 @@ Requires-Dist: ty>=0.0.49 ; extra == 'dev'
 Requires-Dist: import-linter>=2 ; extra == 'dev'
 Requires-Dist: testcontainers[postgres]>=4 ; extra == 'dev'
 Requires-Dist: pip-audit>=2 ; extra == 'dev'
+Requires-Dist: fastapi>=0.110 ; extra == 'dev'
 Requires-Dist: python-dotenv>=1.0 ; extra == 'dotenv'
+Requires-Dist: msgpack>=1.0 ; extra == 'msgpack'
+Requires-Dist: aioodbc>=0.5 ; extra == 'mssql'
 Requires-Dist: asyncmy>=0.2 ; extra == 'mysql'
+Requires-Dist: opentelemetry-api>=1.20 ; extra == 'otel'
 Requires-Dist: asyncpg>=0.29 ; extra == 'pg'
 Requires-Dist: aiosqlite>=0.19 ; extra == 'sqlite'
 Requires-Dist: uuid6>=2024.1 ; extra == 'uuid7'
@@ -42,20 +50,25 @@ Provides-Extra: cli
 Provides-Extra: dev
 Provides-Extra: dotenv
 Provides-Extra: fastapi
+Provides-Extra: msgpack
+Provides-Extra: mssql
 Provides-Extra: mysql
+Provides-Extra: otel
 Provides-Extra: pg
 Provides-Extra: sqlite
 Provides-Extra: uuid7
 License-File: LICENSE
 Summary: Next-generation async ORM for Python with a Rust-powered core
-Keywords: orm,async,postgresql,mysql,sqlite,pydantic,rust
+Keywords: orm,async,postgresql,mysql,sqlite,mssql,pydantic,rust,asyncpg,query-builder
+Author: Ferrum Contributors
 License: Apache-2.0
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
-Project-URL: Bug Tracker, https://github.com/ferrumdb/ferrum/issues
-Project-URL: Documentation, https://ferrumdb.github.io/ferrum
-Project-URL: Homepage, https://github.com/ferrumdb/ferrum
-Project-URL: Repository, https://github.com/ferrumdb/ferrum
+Project-URL: Changelog, https://github.com/ferrum-orm/ferrum/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/ferrum-orm/ferrum/tree/main/docs
+Project-URL: Homepage, https://github.com/ferrum-orm/ferrum
+Project-URL: Issues, https://github.com/ferrum-orm/ferrum/issues
+Project-URL: Repository, https://github.com/ferrum-orm/ferrum
 
 # Ferrum
 
@@ -83,7 +96,7 @@ Ferrum aims to provide all four.
 - Pydantic-first models
 - Django-inspired ORM experience
 - Rust-powered query engine
-- PostgreSQL-first architecture (MySQL and SQLite via optional extras)
+- PostgreSQL-first architecture (MySQL, SQLite, and SQL Server via optional extras)
 - Type-safe query construction
 - Automatic migrations
 - High-performance result hydration
@@ -172,6 +185,50 @@ Performance-critical components are implemented in Rust:
 
 This allows Ferrum to maintain a Pythonic API without sacrificing performance.
 
+### Cross-Driver Full-Text Search
+
+Native full-text search across PostgreSQL, MySQL, SQLite FTS5, and SQL Server — one
+QuerySet API, dialect-specific SQL emit and migration DDL.
+
+**Query modes** (filter lookups and ranking):
+
+| Mode        | Lookup operator   | Typical use                          |
+| ----------- | ----------------- | ------------------------------------ |
+| `plain`     | `__match`         | Natural-language terms               |
+| `phrase`    | `__match_phrase`  | Exact phrase                         |
+| `websearch` | `__match_websearch` | Web-style quotes, `-` negation   |
+| `boolean`   | `__match_boolean` | Boolean operators (`&`, `\|`, `!`) |
+
+**Convenience methods:**
+
+```python
+# Filter + relevance ranking in one call
+hits = await Article.objects.search(
+    "python async orm", field="body", mode="websearch"
+).limit(10).all(conn)
+
+# Rank without an implicit filter
+ranked = await Article.objects.rank_by("body", "rust", mode="plain").all(conn)
+```
+
+**Index declaration** — PostgreSQL uses `TSVector` columns; other drivers index base
+`text` columns via `Meta.full_text_indexes`:
+
+```python
+from ferrum.models import Field, FullTextIndex
+
+class Article(Model):
+    search_vector: Annotated[TSVector, Field(fts_config="english")] | None = None
+    body: str = ""
+
+    class Meta:
+        full_text_indexes = [FullTextIndex(fields=("body",), config="english")]
+```
+
+Query strings are always bound parameters; `fts_config` and index names come from
+model-metadata allowlists only. See [Getting Started → Vector and full-text columns](docs/getting-started.md)
+and [API Reference](docs/api-reference.md) for per-dialect DDL and operator mapping.
+
 ## Architecture
 
 ```text
@@ -199,34 +256,41 @@ This allows Ferrum to maintain a Pythonic API without sacrificing performance.
 
 ## Roadmap
 
-### v0.1
-
-- [ ] PostgreSQL support
-- [ ] Basic CRUD operations
-- [ ] Async query execution
-- [ ] Pydantic models
-- [ ] Query builder
-- [ ] Type-safe filters
-
-### v0.2
-
-- [ ] Relationships
-- [x] Transactions
-- [ ] Query optimization
-- [ ] Bulk operations
-
-### v0.3
-
-- [ ] Migrations
-- [ ] Schema diff engine
-- [ ] CLI tools
+### v0.1 (complete)
+
+- [x] PostgreSQL support
+- [x] Basic CRUD operations
+- [x] Async query execution
+- [x] Pydantic models
+- [x] Query builder
+- [x] Type-safe filters
+- [x] Transactions and savepoints
+- [x] Bulk operations (`bulk_create`, `bulk_update`, `bulk_delete`)
+- [x] Migrations (schema diff, apply, revert, CLI)
+- [x] Relationships (ForeignKey, OneToOne, ManyToMany)
+- [x] pgvector KNN search and HNSW/IVFFLAT index DDL
+- [x] Full-text search (cross-dialect: PostgreSQL, MySQL, SQLite FTS5, SQL Server)
+- [x] Observability hooks (Tier A/B/C)
+- [x] CLI (`makemigrations`, `migrate`, `revert`, `showmigrations`, `inspectdb`, `resetdb`)
+
+### v0.2 (in progress)
+
+- [x] Upsert API (`upsert`, `bulk_upsert` with conflict targets and `RETURNING`)
+- [x] Composite primary keys
+- [x] Array field types (`uuid[]`, `text[]`, scalar arrays)
+- [x] JSONB operators (`__contains`, `__has_key`)
+- [x] RLS / tenant session helpers (`set_config`, `tenant_session`)
+- [x] `call_function` for allowlisted stored-procedure calls
+- [x] Migration ops for extensions, RLS policies, and function DDL
+- [x] pgvector similarity score projection (`vector_search` helper)
+- [ ] Query optimization (deferred fields, prefetch tuning)
+- [ ] Advanced relationship loading
 
 ### v1.0
 
 - [ ] Production-ready stability
-- [ ] Advanced relationships
-- [ ] Performance benchmarking
-- [ ] Full documentation
+- [ ] Performance benchmarking suite
+- [ ] Full documentation site
 
 ## Project Status
 
@@ -249,6 +313,12 @@ pip install 'ferrum-orm[mysql]'
 # SQLite + migrations CLI (testing / local dev)
 pip install 'ferrum-orm[sqlite,cli]'
 
+# SQL Server (also needs a system ODBC driver, e.g. msodbcsql18)
+pip install 'ferrum-orm[mssql]'
+
+# Optional MessagePack wire format for the Python<->Rust boundary
+pip install 'ferrum-orm[msgpack]'
+
 # Everything (all drivers + CLI + dotenv)
 pip install 'ferrum-orm[all]'
 
@@ -257,7 +327,19 @@ pip install ferrum-orm
 ```
 
 Bare `ferrum-orm` installs Pydantic and the Rust core only. Choose a driver extra
-(`pg`, `mysql`, or `sqlite`) before calling `ferrum.connect()`.
+(`pg`, `mysql`, `sqlite`, or `mssql`) before calling `ferrum.connect()`.
+
+MySQL, SQLite, and SQL Server are **thin-parity** backends: they support core CRUD
+and migrations but not transactions, upsert, `bulk_update`, RLS, or pgvector
+(PostgreSQL only). SQL Server connects via `aioodbc`/`pyodbc` and requires a system
+ODBC driver such as `msodbcsql18`; DSNs use the `mssql://` or `sqlserver://` scheme.
+
+### Wire format (advanced)
+
+The Python↔Rust IR/hydration boundary defaults to JSON. Installing the `msgpack`
+extra lets you switch it to MessagePack, selected via the `FERRUM_WIRE_FORMAT`
+environment variable (`json` | `msgpack`) or the `[ferrum] wire_format` key in
+`ferrum.toml` / `pyproject.toml`. JSON remains the default; MessagePack is opt-in.
 
 From source, build the native extension with `maturin develop` (or `mise run dev`).
 
@@ -271,7 +353,8 @@ Runnable samples live under [`examples/`](examples/):
 
 ## Contributing
 
-Contributions are welcome.
+Contributions are welcome. Start with [`CONTRIBUTING.md`](CONTRIBUTING.md) for local setup,
+scoped verification, architecture rules, and pull request expectations.
 
 ## License
 

{ferrum_orm-0.1.2 → ferrum_orm-0.1.4}/README.md

@@ -24,7 +24,7 @@ Ferrum aims to provide all four.
 - Pydantic-first models
 - Django-inspired ORM experience
 - Rust-powered query engine
-- PostgreSQL-first architecture (MySQL and SQLite via optional extras)
+- PostgreSQL-first architecture (MySQL, SQLite, and SQL Server via optional extras)
 - Type-safe query construction
 - Automatic migrations
 - High-performance result hydration
@@ -113,6 +113,50 @@ Performance-critical components are implemented in Rust:
 
 This allows Ferrum to maintain a Pythonic API without sacrificing performance.
 
+### Cross-Driver Full-Text Search
+
+Native full-text search across PostgreSQL, MySQL, SQLite FTS5, and SQL Server — one
+QuerySet API, dialect-specific SQL emit and migration DDL.
+
+**Query modes** (filter lookups and ranking):
+
+| Mode        | Lookup operator   | Typical use                          |
+| ----------- | ----------------- | ------------------------------------ |
+| `plain`     | `__match`         | Natural-language terms               |
+| `phrase`    | `__match_phrase`  | Exact phrase                         |
+| `websearch` | `__match_websearch` | Web-style quotes, `-` negation   |
+| `boolean`   | `__match_boolean` | Boolean operators (`&`, `\|`, `!`) |
+
+**Convenience methods:**
+
+```python
+# Filter + relevance ranking in one call
+hits = await Article.objects.search(
+    "python async orm", field="body", mode="websearch"
+).limit(10).all(conn)
+
+# Rank without an implicit filter
+ranked = await Article.objects.rank_by("body", "rust", mode="plain").all(conn)
+```
+
+**Index declaration** — PostgreSQL uses `TSVector` columns; other drivers index base
+`text` columns via `Meta.full_text_indexes`:
+
+```python
+from ferrum.models import Field, FullTextIndex
+
+class Article(Model):
+    search_vector: Annotated[TSVector, Field(fts_config="english")] | None = None
+    body: str = ""
+
+    class Meta:
+        full_text_indexes = [FullTextIndex(fields=("body",), config="english")]
+```
+
+Query strings are always bound parameters; `fts_config` and index names come from
+model-metadata allowlists only. See [Getting Started → Vector and full-text columns](docs/getting-started.md)
+and [API Reference](docs/api-reference.md) for per-dialect DDL and operator mapping.
+
 ## Architecture
 
 ```text
@@ -140,34 +184,41 @@ This allows Ferrum to maintain a Pythonic API without sacrificing performance.
 
 ## Roadmap
 
-### v0.1
-
-- [ ] PostgreSQL support
-- [ ] Basic CRUD operations
-- [ ] Async query execution
-- [ ] Pydantic models
-- [ ] Query builder
-- [ ] Type-safe filters
-
-### v0.2
-
-- [ ] Relationships
-- [x] Transactions
-- [ ] Query optimization
-- [ ] Bulk operations
-
-### v0.3
-
-- [ ] Migrations
-- [ ] Schema diff engine
-- [ ] CLI tools
+### v0.1 (complete)
+
+- [x] PostgreSQL support
+- [x] Basic CRUD operations
+- [x] Async query execution
+- [x] Pydantic models
+- [x] Query builder
+- [x] Type-safe filters
+- [x] Transactions and savepoints
+- [x] Bulk operations (`bulk_create`, `bulk_update`, `bulk_delete`)
+- [x] Migrations (schema diff, apply, revert, CLI)
+- [x] Relationships (ForeignKey, OneToOne, ManyToMany)
+- [x] pgvector KNN search and HNSW/IVFFLAT index DDL
+- [x] Full-text search (cross-dialect: PostgreSQL, MySQL, SQLite FTS5, SQL Server)
+- [x] Observability hooks (Tier A/B/C)
+- [x] CLI (`makemigrations`, `migrate`, `revert`, `showmigrations`, `inspectdb`, `resetdb`)
+
+### v0.2 (in progress)
+
+- [x] Upsert API (`upsert`, `bulk_upsert` with conflict targets and `RETURNING`)
+- [x] Composite primary keys
+- [x] Array field types (`uuid[]`, `text[]`, scalar arrays)
+- [x] JSONB operators (`__contains`, `__has_key`)
+- [x] RLS / tenant session helpers (`set_config`, `tenant_session`)
+- [x] `call_function` for allowlisted stored-procedure calls
+- [x] Migration ops for extensions, RLS policies, and function DDL
+- [x] pgvector similarity score projection (`vector_search` helper)
+- [ ] Query optimization (deferred fields, prefetch tuning)
+- [ ] Advanced relationship loading
 
 ### v1.0
 
 - [ ] Production-ready stability
-- [ ] Advanced relationships
-- [ ] Performance benchmarking
-- [ ] Full documentation
+- [ ] Performance benchmarking suite
+- [ ] Full documentation site
 
 ## Project Status
 
@@ -190,6 +241,12 @@ pip install 'ferrum-orm[mysql]'
 # SQLite + migrations CLI (testing / local dev)
 pip install 'ferrum-orm[sqlite,cli]'
 
+# SQL Server (also needs a system ODBC driver, e.g. msodbcsql18)
+pip install 'ferrum-orm[mssql]'
+
+# Optional MessagePack wire format for the Python<->Rust boundary
+pip install 'ferrum-orm[msgpack]'
+
 # Everything (all drivers + CLI + dotenv)
 pip install 'ferrum-orm[all]'
 
@@ -198,7 +255,19 @@ pip install ferrum-orm
 ```
 
 Bare `ferrum-orm` installs Pydantic and the Rust core only. Choose a driver extra
-(`pg`, `mysql`, or `sqlite`) before calling `ferrum.connect()`.
+(`pg`, `mysql`, `sqlite`, or `mssql`) before calling `ferrum.connect()`.
+
+MySQL, SQLite, and SQL Server are **thin-parity** backends: they support core CRUD
+and migrations but not transactions, upsert, `bulk_update`, RLS, or pgvector
+(PostgreSQL only). SQL Server connects via `aioodbc`/`pyodbc` and requires a system
+ODBC driver such as `msodbcsql18`; DSNs use the `mssql://` or `sqlserver://` scheme.
+
+### Wire format (advanced)
+
+The Python↔Rust IR/hydration boundary defaults to JSON. Installing the `msgpack`
+extra lets you switch it to MessagePack, selected via the `FERRUM_WIRE_FORMAT`
+environment variable (`json` | `msgpack`) or the `[ferrum] wire_format` key in
+`ferrum.toml` / `pyproject.toml`. JSON remains the default; MessagePack is opt-in.
 
 From source, build the native extension with `maturin develop` (or `mise run dev`).
 
@@ -212,7 +281,8 @@ Runnable samples live under [`examples/`](examples/):
 
 ## Contributing
 
-Contributions are welcome.
+Contributions are welcome. Start with [`CONTRIBUTING.md`](CONTRIBUTING.md) for local setup,
+scoped verification, architecture rules, and pull request expectations.
 
 ## License
 

{ferrum_orm-0.1.2 → ferrum_orm-0.1.4}/crates/ferrum-core/benches/hydrate.rs

@@ -20,6 +20,8 @@ fn bench_metadata() -> ModelMetadata {
                 allowed_operators: vec!["eq".into()],
                 nullable: false,
                 vector_dimensions: None,
+                fts_config: None,
+                fts_source_columns: None,
             },
             FieldMeta {
                 name: "title".into(),
@@ -28,6 +30,8 @@ fn bench_metadata() -> ModelMetadata {
                 allowed_operators: vec!["eq".into(), "icontains".into()],
                 nullable: false,
                 vector_dimensions: None,
+                fts_config: None,
+                fts_source_columns: None,
             },
             FieldMeta {
                 name: "body".into(),
@@ -36,6 +40,8 @@ fn bench_metadata() -> ModelMetadata {
                 allowed_operators: vec!["eq".into()],
                 nullable: true,
                 vector_dimensions: None,
+                fts_config: None,
+                fts_source_columns: None,
             },
             FieldMeta {
                 name: "published".into(),
@@ -44,9 +50,13 @@ fn bench_metadata() -> ModelMetadata {
                 allowed_operators: vec!["eq".into()],
                 nullable: false,
                 vector_dimensions: None,
+                fts_config: None,
+                fts_source_columns: None,
             },
         ],
         pk_index: 0,
+        pk_fields: vec![0],
+        full_text_indexes: vec![],
     }
 }