Metadata-Version: 2.4
Name: rhosocial_activerecord_postgres
Version: 1.0.0.dev2
Summary: postgres backend implementation for rhosocial-activerecord, providing a robust and optimized postgres database support.
Author-email: vistart <i@vistart.me>
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [2025] [vistart <i@vistart.me>]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
        
Project-URL: Homepage, https://github.com/rhosocial/python-activerecord-postgres
Project-URL: Documentation, https://docs.python-activerecord.dev.rho.social
Project-URL: Repository, https://github.com/rhosocial/python-activerecord-postgres.git
Project-URL: Issues, https://github.com/rhosocial/python-activerecord-postgres/issues
Keywords: activerecord,orm,database,postgres,psycopg
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
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 :: Python :: 3 :: Only
Classifier: Framework :: Pydantic
Classifier: Framework :: Pydantic :: 2
Classifier: Intended Audience :: Developers
Classifier: Topic :: Database
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: psycopg[binary]
Requires-Dist: rhosocial-activerecord
Provides-Extra: pooling
Requires-Dist: DBUtils>=3.0.0; extra == "pooling"
Provides-Extra: test
Requires-Dist: pytest>=7.0.0; extra == "test"
Requires-Dist: coverage>=7.0.0; extra == "test"
Provides-Extra: dev
Requires-Dist: black>=23.0.0; extra == "dev"
Requires-Dist: isort>=5.0.0; extra == "dev"
Requires-Dist: mypy>=1.0.0; extra == "dev"
Requires-Dist: ruff>=0.1.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.0.0; extra == "docs"
Requires-Dist: sphinx-rtd-theme>=1.0.0; extra == "docs"
Dynamic: license-file

# rhosocial-activerecord-postgres ($\rho_{\mathbf{AR}\text{-postgres}}$)

[![PyPI version](https://badge.fury.io/py/rhosocial-activerecord-postgres.svg)](https://badge.fury.io/py/rhosocial-activerecord-postgres)
[![Python](https://img.shields.io/pypi/pyversions/rhosocial-activerecord-postgres.svg)](https://pypi.org/project/rhosocial-activerecord-postgres/)
[![Tests](https://github.com/rhosocial/python-activerecord-postgres/actions/workflows/test.yml/badge.svg)](https://github.com/rhosocial/python-activerecord-postgres/actions)
[![Coverage Status](https://codecov.io/gh/rhosocial/python-activerecord-postgres/branch/main/graph/badge.svg)](https://app.codecov.io/gh/rhosocial/python-activerecord-postgres/tree/main)
[![License](https://img.shields.io/github/license/rhosocial/python-activerecord-postgres.svg)](https://github.com/rhosocial/python-activerecord-postgres/blob/main/LICENSE)
[![Powered by vistart](https://img.shields.io/badge/Powered_by-vistart-blue.svg)](https://github.com/vistart)

<div align="center">
    <img src="https://raw.githubusercontent.com/rhosocial/python-activerecord/main/docs/images/logo.svg" alt="rhosocial ActiveRecord Logo" width="200"/>
    <p>postgres backend implementation for rhosocial-activerecord, providing a robust and optimized postgres database support.</p>
</div>

# Postgres Backend Implementation Guide

## Overview

This postgres backend implementation provides both **synchronous** and **asynchronous** support using the `psycopg` (psycopg3) driver.

## Key Features

- ✅ **Dual Implementation**: Both sync (`PostgresBackend`) and async (`AsyncPostgresBackend`)
- ✅ **Shared Logic**: Common functionality in `PostgresBackendMixin`
- ✅ **Full Transaction Support**: Including savepoints and DEFERRABLE mode
- ✅ **Rich Type Support**: Arrays, JSONB, UUID, ranges, network types, geometry
- ✅ **Complete Capability Declaration**: CTEs, window functions, JSON operations, etc.
- ✅ **Native Driver**: Uses psycopg3 directly, no ORM dependencies

## Installation

```bash
pip install rhosocial-activerecord-postgres
```

**Dependencies**:
- `rhosocial-activerecord>=1.0.0,<2.0.0`
- `psycopg>=3.2.12`

## Usage Examples

### Synchronous Usage

```python
from rhosocial.activerecord.model import ActiveRecord
from rhosocial.activerecord.backend.impl.postgres import (
    PostgresBackend,
    PostgresConnectionConfig
)

# Configure connection
config = PostgresConnectionConfig(
    host="localhost",
    port=5432,
    database="mydb",
    username="user",
    password="password",
    options={
        "sslmode": "prefer",
        "connect_timeout": 10,
        "application_name": "my_app"
    }
)

# Create backend
backend = PostgresBackend(connection_config=config)

# Configure model
class User(ActiveRecord):
    __table_name__ = "users"
    name: str
    email: str

User.configure(backend)

# Use the model
user = User(name="John", email="john@example.com")
user.save()

# Query with CTEs (postgres 8.4+)
results = User.query().with_cte(
    "active_users",
    User.query().where(is_active=True)
).from_cte("active_users").all()

# Use JSONB operations (postgres 9.4+)
users = User.query().where(
    "metadata->>'role' = ?", ("admin",)
).all()
```

### Asynchronous Usage

```python
import asyncio
from rhosocial.activerecord.async_model import ActiveRecord
from rhosocial.activerecord.backend.impl.postgres import (
    AsyncPostgresBackend,
    PostgresConnectionConfig
)

async def main():
    # Configure connection
    config = PostgresConnectionConfig(
        host="localhost",
        port=5432,
        database="mydb",
        username="user",
        password="password",
    )

    # Create async backend
    backend = ActiveRecord(connection_config=config)
    
    # Connect explicitly for async
    await backend.connect()

    # Configure model
    class User(ActiveRecord):
        __table_name__ = "users"
        name: str
        email: str

    User.configure(backend)

    # Use the model asynchronously
    user = User(name="Jane", email="jane@example.com")
    await user.save()

    # Async queries
    users = await User.query().where(is_active=True).all()

    # Cleanup
    await backend.disconnect()

# Run async code
asyncio.run(main())
```

### Transaction Usage

**Synchronous Transactions**:

```python
# Get transaction manager
tm = backend.transaction_manager

# Basic transaction
with tm:
    user1 = User(name="Alice")
    user1.save()
    user2 = User(name="Bob")
    user2.save()
# Auto-commit on context exit

# Explicit control
tm.begin()
try:
    user = User(name="Charlie")
    user.save()
    tm.commit()
except Exception:
    tm.rollback()
    raise

# With savepoints
tm.begin()
user1 = User(name="Dave")
user1.save()

savepoint = tm.savepoint()
try:
    user2 = User(name="Eve")
    user2.save()
    tm.release_savepoint(savepoint)
except Exception:
    tm.rollback_savepoint(savepoint)

tm.commit()

# With isolation level and deferrable mode
tm.set_isolation_level(IsolationLevel.SERIALIZABLE)
tm.set_deferrable(True)
with tm:
    # Deferrable serializable transaction
    pass
```

**Asynchronous Transactions**:

```python
async def async_transaction_example():
    # Get async transaction manager
    tm = backend.transaction_manager

    # Basic async transaction
    async with tm:
        user1 = User(name="Alice")
        await user1.save()
        user2 = User(name="Bob")
        await user2.save()
    # Auto-commit on context exit

    # Explicit control
    await tm.begin()
    try:
        user = User(name="Charlie")
        await user.save()
        await tm.commit()
    except Exception:
        await tm.rollback()
        raise

    # With savepoints
    await tm.begin()
    user1 = User(name="Dave")
    await user1.save()

    savepoint = await tm.savepoint()
    try:
        user2 = User(name="Eve")
        await user2.save()
        await tm.release_savepoint(savepoint)
    except Exception:
        await tm.rollback_savepoint(savepoint)

    await tm.commit()
```

### Postgres-Specific Features

**Array Types**:

```python
from rhosocial.activerecord.model import ActiveRecord

class Article(ActiveRecord):
    __table_name__ = "articles"
    title: str
    tags: list  # Will use postgres array type

article = Article(
    title="postgres Arrays",
    tags=["database", "postgres", "arrays"]
)
article.save()

# Query arrays
articles = Article.query().where(
    "? = ANY(tags)", ("postgres",)
).all()
```

**JSONB Operations**:

```python
from rhosocial.activerecord.model import ActiveRecord

class Product(ActiveRecord):
    __table_name__ = "products"
    name: str
    attributes: dict  # Will use JSONB type

product = Product(
    name="Laptop",
    attributes={
        "brand": "Dell",
        "specs": {
            "cpu": "Intel i7",
            "ram": "16GB"
        }
    }
)
product.save()

# Query JSONB
products = Product.query().where(
    "attributes->>'brand' = ?", ("Dell",)
).all()

# JSONB contains
products = Product.query().where(
    "attributes @> ?", ('{"brand": "Dell"}',)
).all()
```

**Range Types**:

```python
from datetime import date
from rhosocial.activerecord.model import ActiveRecord

class Booking(ActiveRecord):
    __table_name__ = "bookings"
    room_id: int
    date_range: tuple  # Will use DATERANGE type

booking = Booking(
    room_id=101,
    date_range=(date(2024, 1, 1), date(2024, 1, 7))
)
booking.save()

# Query ranges
bookings = Booking.query().where(
    "date_range @> ?", (date(2024, 1, 3),)
).all()
```

## Configuration Options

### Connection Options

```python
config = PostgresConnectionConfig(
    host="localhost",
    port=5432,
    database="mydb",
    username="user",
    password="password",
    options={
        # SSL/TLS
        "sslmode": "prefer",  # disable, allow, prefer, require, verify-ca, verify-full
        
        # Connection timeout
        "connect_timeout": 10,
        
        # Application identification
        "application_name": "my_app",
        
        # Client encoding
        "client_encoding": "UTF8",
        
        # Connection pooling (if supported)
        "pool_min_size": 1,
        "pool_max_size": 10,
        "pool_timeout": 30.0,
    }
)
```

## Postgres Version Compatibility

| Feature | Minimum Version | Notes |
|---------|----------------|-------|
| Basic operations | 8.0+ | Core functionality |
| CTEs | 8.4+ | WITH clauses |
| Window functions | 8.4+ | ROW_NUMBER, RANK, etc. |
| RETURNING clause | 8.2+ | INSERT/UPDATE/DELETE RETURNING |
| JSON type | 9.2+ | Basic JSON support |
| JSONB type | 9.4+ | Binary JSON, better performance |
| UPSERT (ON CONFLICT) | 9.5+ | INSERT ... ON CONFLICT |

**Recommended**: Postgres 12+ for optimal feature support and performance.

## Architecture Notes

### Backend Structure

```
PostgresBackendMixin (Shared Logic)
    ├── Configuration validation
    ├── Version parsing
    ├── Capability initialization
    ├── Type converter registration
    └── Error mapping

PostgresBackend (Sync)           AsyncPostgresBackend (Async)
    ├── Inherits Mixin                 ├── Inherits Mixin
    ├── Inherits StorageBackend        ├── Inherits AsyncStorageBackend
    ├── Sync connection management     ├── Async connection management
    ├── Sync query execution           ├── Async query execution
    └── Sync transaction manager       └── Async transaction manager
```

### Transaction Structure

```
PostgresTransactionMixin (Shared Logic)
    ├── Isolation level mapping
    ├── Savepoint name generation
    ├── SQL statement building
    └── Deferrable mode support

PostgresTransactionManager       AsyncPostgresTransactionManager
    ├── Inherits Mixin                 ├── Inherits Mixin
    ├── Inherits TransactionManager    ├── Inherits AsyncTransactionManager
    ├── Sync transaction operations    ├── Async transaction operations
    └── Sync constraint management     └── Async constraint management
```

## Testing

The backend includes comprehensive test coverage for both sync and async implementations:

- Connection lifecycle tests
- CRUD operation tests
- Transaction tests (with savepoints)
- Type conversion tests
- Capability declaration verification
- Error handling tests
- Concurrent operation tests

**Run sync tests**:
```bash
pytest tests/rhosocial/activerecord_test/feature/backend/postgres/test_backend_sync.py
```

**Run async tests**:
```bash
pytest tests/rhosocial/activerecord_test/feature/backend/postgres/test_backend_async.py
```

## Migration from Old Implementation

If you have an existing postgres backend implementation, here's how to migrate:

**Old code**:
```python
from rhosocial.activerecord.backend.impl.postgres import PostgresBackend

backend = PostgresBackend(...)
```

**New code** (no changes needed for sync):
```python
from rhosocial.activerecord.backend.impl.postgres import PostgresBackend

backend = PostgresBackend(...)  # Same API
```

**New async support**:
```python
from rhosocial.activerecord.backend.impl.postgres import AsyncPostgresBackend

backend = AsyncPostgresBackend(...)
await backend.connect()
```

## Known Limitations

1. **Connection Pooling**: Basic implementation, consider using external pooling (pgbouncer) for production
2. **Async Context**: Async backend requires explicit `await backend.connect()` call
3. **Type Converters**: Some postgres-specific types may need custom converters

## Contributing

Contributions are welcome! Please ensure:

- Tests pass for both sync and async implementations
- Code follows project style guidelines
- Documentation is updated
- Changelog fragments are created

## License

[![license](https://img.shields.io/github/license/rhosocial/python-activerecord-postgres.svg)](https://github.com/rhosocial/python-activerecord-postgres/blob/main/LICENSE)

Copyright © 2025 [vistart](https://github.com/vistart)
