dbx-tools-postgres 0.6.211__tar.gz → 0.6.213__tar.gz

dbx_tools_postgres-0.6.213/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

{dbx_tools_postgres-0.6.211 → dbx_tools_postgres-0.6.213}/PKG-INFO

@@ -1,14 +1,16 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: dbx-tools-postgres
-Version: 0.6.211
+Version: 0.6.213
 Summary: WorkspaceClient-backed Lakebase Postgres resolution, SQLAlchemy engines, advisory locks, and LISTEN/NOTIFY topic bus
+License-Expression: Apache-2.0
+License-File: LICENSE
 Requires-Dist: asyncpg>=0.30
 Requires-Dist: databricks-sdk>=0.63.0
 Requires-Dist: greenlet>=3.2
 Requires-Dist: psycopg[binary]>=3.2.9
 Requires-Dist: sqlalchemy>=2.0.41
-Requires-Dist: dbx-tools-core==0.6.211
-Requires-Dist: dbx-tools-core-rs==0.6.211
+Requires-Dist: dbx-tools-core==0.6.213
+Requires-Dist: dbx-tools-core-rs==0.6.213
 Requires-Python: >=3.11, <4
 Project-URL: Source, https://github.com/reggie-db/dbx-tools/tree/main/packages/py/postgres
 Description-Content-Type: text/markdown

{dbx_tools_postgres-0.6.211 → dbx_tools_postgres-0.6.213}/pyproject.toml

@@ -1,17 +1,19 @@
 [project]
 name = "dbx-tools-postgres"
-version = "0.6.211"
+version = "0.6.213"
 description = "WorkspaceClient-backed Lakebase Postgres resolution, SQLAlchemy engines, advisory locks, and LISTEN/NOTIFY topic bus"
 readme = "README.md"
 requires-python = ">=3.11,<4"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
 dependencies = [
     "asyncpg>=0.30",
     "databricks-sdk>=0.63.0",
     "greenlet>=3.2",
     "psycopg[binary]>=3.2.9",
     "sqlalchemy>=2.0.41",
-    "dbx-tools-core==0.6.211",
-    "dbx-tools-core-rs==0.6.211",
+    "dbx-tools-core==0.6.213",
+    "dbx-tools-core-rs==0.6.213",
 ]
 
 [project.urls]

{dbx_tools_postgres-0.6.211 → dbx_tools_postgres-0.6.213}/pyproject.toml.orig

@@ -2,11 +2,13 @@
 
 [project]
 name = "dbx-tools-postgres"
-version = "0.6.211"
+version = "0.6.213"
 description = "WorkspaceClient-backed Lakebase Postgres resolution, SQLAlchemy engines, advisory locks, and LISTEN/NOTIFY topic bus"
 readme = "README.md"
 requires-python = ">=3.11,<4"
-dependencies = ["asyncpg>=0.30", "databricks-sdk>=0.63.0", "greenlet>=3.2", "psycopg[binary]>=3.2.9", "sqlalchemy>=2.0.41", "dbx-tools-core==0.6.211", "dbx-tools-core-rs==0.6.211"]
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+dependencies = ["asyncpg>=0.30", "databricks-sdk>=0.63.0", "greenlet>=3.2", "psycopg[binary]>=3.2.9", "sqlalchemy>=2.0.41", "dbx-tools-core==0.6.213", "dbx-tools-core-rs==0.6.213"]
 
 [project.urls]
 Source = "https://github.com/reggie-db/dbx-tools/tree/main/packages/py/postgres"

{dbx_tools_postgres-0.6.211 → dbx_tools_postgres-0.6.213}/src/dbx_tools/postgres/__init__.py

@@ -1,3 +1,5 @@
+"""Lakebase/Postgres resolution, engines, advisory locks, and live topic fan-out."""
+
 from .address import (
     SSL_MODES,
     LakebaseConnectionInputs,

{dbx_tools_postgres-0.6.211 → dbx_tools_postgres-0.6.213}/src/dbx_tools/postgres/address.py

@@ -1,3 +1,5 @@
+"""Lakebase address types and parsers backed by the Databricks Rust bindings."""
+
 from typing import Literal, TypeAlias
 
 from dbx_tools.core_rs.bindings import (
@@ -9,11 +11,14 @@ from dbx_tools.core_rs.bindings import (
     SslMode as NativeSslMode,
 )
 
-"""Lakebase address types and parsers backed by the Databricks Rust bindings."""
-
 SslMode = Literal["require", "disable", "prefer"]
+"""Accepted PostgreSQL SSL modes."""
+
 SSL_MODES: tuple[SslMode, ...] = ("require", "disable", "prefer")
+"""All accepted values for :class:`SslMode`."""
+
 LakebaseConnectionInputs: TypeAlias = ParsedAddress
+"""Resolved address inputs returned by the native parser."""
 
 parseAddress = parse_address
 parseResourcePath = parse_resource_path

{dbx_tools_postgres-0.6.211 → dbx_tools_postgres-0.6.213}/src/dbx_tools/postgres/advisory_lock.py

@@ -1,3 +1,5 @@
+"""Stable Postgres advisory-lock ids and connection-owning context managers."""
+
 from __future__ import annotations
 
 import hashlib
@@ -14,6 +16,8 @@ from sqlalchemy.ext.asyncio import AsyncConnection, AsyncEngine
 
 @dataclass(frozen=True, slots=True)
 class ExplicitAdvisoryLockId:
+    """A caller-supplied 64-bit lock id that bypasses stable-key hashing."""
+
     value: int
 
 
@@ -28,6 +32,14 @@ class AsyncQueryable(Protocol):
 
 
 def advisory_lock_id(key: object) -> int:
+    """Return the deterministic signed 64-bit Postgres lock id for ``key``.
+
+    Lists and tuples are treated as ordered composite keys. Other values are
+    canonicalized with :func:`dbx_tools.core.to_stable_key`, joined with a null
+    separator, and hashed with SHA-256. ``ExplicitAdvisoryLockId`` values are
+    normalized directly into Postgres's signed 64-bit range.
+    """
+
     if isinstance(key, ExplicitAdvisoryLockId):
         return _signed_64(key.value)
     parts = key if isinstance(key, (list, tuple)) else [key]
@@ -36,6 +48,8 @@ def advisory_lock_id(key: object) -> int:
 
 
 def explicit_advisory_lock_id(value: int) -> ExplicitAdvisoryLockId:
+    """Mark ``value`` as an explicit Postgres lock id instead of a value to hash."""
+
     return ExplicitAdvisoryLockId(value)
 
 
@@ -46,6 +60,14 @@ def acquire_advisory_lock(
     transaction: bool = False,
     wait: bool = True,
 ) -> bool:
+    """Acquire a session or transaction advisory lock on ``connection``.
+
+    The supplied connection owns the lock. With ``wait=True`` this blocks and
+    returns ``True`` after acquisition. With ``wait=False`` it returns whether
+    the lock was acquired. Transaction locks are released by transaction end;
+    session locks must be released on the same connection.
+    """
+
     function = _function_name(transaction=transaction, wait=wait)
     result = connection.execute(
         text(f"SELECT {function}(:lock_id)"), {"lock_id": advisory_lock_id(key)}
@@ -60,6 +82,11 @@ async def acquire_advisory_lock_async(
     transaction: bool = False,
     wait: bool = True,
 ) -> bool:
+    """Asynchronously acquire a session or transaction lock on ``connection``.
+
+    Ownership and ``wait`` behavior match :func:`acquire_advisory_lock`.
+    """
+
     function = _function_name(transaction=transaction, wait=wait)
     result = await connection.execute(
         text(f"SELECT {function}(:lock_id)"), {"lock_id": advisory_lock_id(key)}
@@ -68,6 +95,12 @@ async def acquire_advisory_lock_async(
 
 
 def release_advisory_lock(connection: SyncQueryable, key: object) -> None:
+    """Release a session lock on its owning connection.
+
+    Raises ``RuntimeError`` when the connection does not hold the derived lock.
+    Transaction-scoped locks release automatically and should not use this API.
+    """
+
     lock_id = advisory_lock_id(key)
     result = connection.execute(text("SELECT pg_advisory_unlock(:lock_id)"), {"lock_id": lock_id})
     if result.scalar_one() is not True:
@@ -75,6 +108,8 @@ def release_advisory_lock(connection: SyncQueryable, key: object) -> None:
 
 
 async def release_advisory_lock_async(connection: AsyncQueryable, key: object) -> None:
+    """Asynchronously release a session lock on its owning connection."""
+
     lock_id = advisory_lock_id(key)
     result = await connection.execute(
         text("SELECT pg_advisory_unlock(:lock_id)"), {"lock_id": lock_id}
@@ -85,6 +120,13 @@ async def release_advisory_lock_async(connection: AsyncQueryable, key: object) -
 
 @contextmanager
 def advisory_lock(engine: Engine, key: object) -> Iterator[Connection]:
+    """Hold a blocking session lock on one owned connection for the context.
+
+    The checked-out connection is yielded to the caller and retained until the
+    lock is released. If body and unlock both fail, the unlock failure is added
+    as a note to the original exception.
+    """
+
     with engine.connect() as connection:
         acquire_advisory_lock(connection, key)
         failure: Exception | None = None
@@ -103,6 +145,8 @@ def advisory_lock(engine: Engine, key: object) -> Iterator[Connection]:
 
 @contextmanager
 def try_advisory_lock(engine: Engine, key: object) -> Iterator[Connection | None]:
+    """Try to hold a session lock, yielding ``None`` without waiting on contention."""
+
     with engine.connect() as connection:
         if not acquire_advisory_lock(connection, key, wait=False):
             yield None
@@ -123,6 +167,11 @@ def try_advisory_lock(engine: Engine, key: object) -> Iterator[Connection | None
 
 @contextmanager
 def advisory_transaction_lock(engine: Engine, key: object) -> Iterator[Connection]:
+    """Hold a blocking transaction lock for an owned transaction context.
+
+    The lock is released automatically when the context commits or rolls back.
+    """
+
     with engine.begin() as connection:
         acquire_advisory_lock(connection, key, transaction=True)
         yield connection
@@ -130,6 +179,8 @@ def advisory_transaction_lock(engine: Engine, key: object) -> Iterator[Connectio
 
 @contextmanager
 def try_advisory_transaction_lock(engine: Engine, key: object) -> Iterator[Connection | None]:
+    """Try to hold a transaction lock, yielding ``None`` without waiting."""
+
     with engine.begin() as connection:
         if not acquire_advisory_lock(connection, key, transaction=True, wait=False):
             yield None
@@ -139,6 +190,8 @@ def try_advisory_transaction_lock(engine: Engine, key: object) -> Iterator[Conne
 
 @asynccontextmanager
 async def advisory_lock_async(engine: AsyncEngine, key: object) -> AsyncIterator[AsyncConnection]:
+    """Asynchronously hold a session lock on one owned connection for the context."""
+
     async with engine.connect() as connection:
         await acquire_advisory_lock_async(connection, key)
         failure: Exception | None = None
@@ -159,6 +212,8 @@ async def advisory_lock_async(engine: AsyncEngine, key: object) -> AsyncIterator
 async def try_advisory_lock_async(
     engine: AsyncEngine, key: object
 ) -> AsyncIterator[AsyncConnection | None]:
+    """Asynchronously try a session lock, yielding ``None`` without waiting."""
+
     async with engine.connect() as connection:
         if not await acquire_advisory_lock_async(connection, key, wait=False):
             yield None
@@ -181,6 +236,8 @@ async def try_advisory_lock_async(
 async def advisory_transaction_lock_async(
     engine: AsyncEngine, key: object
 ) -> AsyncIterator[AsyncConnection]:
+    """Asynchronously hold a transaction lock until commit or rollback."""
+
     async with engine.begin() as connection:
         await acquire_advisory_lock_async(connection, key, transaction=True)
         yield connection
@@ -190,6 +247,8 @@ async def advisory_transaction_lock_async(
 async def try_advisory_transaction_lock_async(
     engine: AsyncEngine, key: object
 ) -> AsyncIterator[AsyncConnection | None]:
+    """Asynchronously try a transaction lock, yielding ``None`` without waiting."""
+
     async with engine.begin() as connection:
         if not await acquire_advisory_lock_async(connection, key, transaction=True, wait=False):
             yield None

{dbx_tools_postgres-0.6.211 → dbx_tools_postgres-0.6.213}/src/dbx_tools/postgres/engine.py

@@ -1,3 +1,5 @@
+"""Lakebase connection resolution and connect-time credential injection."""
+
 from __future__ import annotations
 
 import datetime as dt
@@ -22,10 +24,11 @@ from .address import (
     parse_resource_path,
 )
 
-"""Lakebase connection resolution and connect-time credential injection."""
-
 CredentialProvider = Callable[[], str]
+"""Return a current database credential for a new physical connection."""
+
 CredentialLoader = Callable[[], tuple[str, dt.datetime | None]]
+"""Load a database credential and its optional absolute expiration time."""
 
 _API_BASE = "/api/2.0/postgres"
 _CREDENTIAL_REFRESH_LEAD = dt.timedelta(minutes=5)
@@ -42,6 +45,8 @@ class WorkspaceApiClient(Protocol):
 
 
 class WorkspaceClientLike(Protocol):
+    """WorkspaceClient surface required for Lakebase discovery and credentials."""
+
     api_client: WorkspaceApiClient
     config: Any
     current_user: Any
@@ -50,6 +55,14 @@ class WorkspaceClientLike(Protocol):
 
 @dataclass(frozen=True, slots=True)
 class PostgresEngineConfig:
+    """Explicit Lakebase/Postgres connection inputs.
+
+    Explicit fields take precedence over parsed address values and environment
+    variables. Missing autoscaling project, branch, endpoint, host, database,
+    and user values may be discovered through the supplied ``WorkspaceClient``.
+    ``instance_name`` selects provisioned Lakebase discovery and credentials.
+    """
+
     address: str | None = None
     instance_name: str | None = None
     project: str | None = None
@@ -64,6 +77,12 @@ class PostgresEngineConfig:
 
 @dataclass(frozen=True, slots=True)
 class ResolvedPostgresConnection:
+    """Concrete connection coordinates with no embedded password.
+
+    ``project``, ``branch``, ``endpoint``, and ``instance_name`` retain the
+    resolved Lakebase resource identity used to choose a credential provider.
+    """
+
     host: str
     database: str
     user: str
@@ -75,6 +94,8 @@ class ResolvedPostgresConnection:
     instance_name: str | None = None
 
     def url(self, drivername: str) -> URL:
+        """Build a SQLAlchemy URL using the driver's expected SSL query key."""
+
         ssl_parameter = "ssl" if drivername.endswith("+asyncpg") else "sslmode"
         return URL.create(
             drivername,
@@ -113,6 +134,13 @@ def workspace_credential_provider(
     workspace_client: WorkspaceClientLike,
     instance_name: str,
 ) -> CredentialProvider:
+    """Create a cached provisioned-Lakebase credential provider.
+
+    The provider mints through ``WorkspaceClient.database`` and caches the token
+    until five minutes before its reported expiry. Refresh uses process-local
+    check-lock-check serialization so concurrent pool connects share one mint.
+    """
+
     if not instance_name.strip():
         raise ValueError("instance_name must not be empty")
 
@@ -133,6 +161,12 @@ def autoscaling_credential_provider(
     workspace_client: WorkspaceClientLike,
     endpoint: str,
 ) -> CredentialProvider:
+    """Create a cached Autoscaling-Lakebase endpoint credential provider.
+
+    Tokens come from ``POST /api/2.0/postgres/credentials`` and use the same
+    process-local early-refresh and refresh-lock policy as provisioned tokens.
+    """
+
     if not endpoint.strip():
         raise ValueError("endpoint must not be empty")
 
@@ -152,6 +186,13 @@ def autoscaling_credential_provider(
 
 
 def install_credential_injection(engine: Engine, provider: CredentialProvider) -> None:
+    """Install ``provider`` on SQLAlchemy's physical ``do_connect`` boundary.
+
+    The password is requested for every new DBAPI connection and never stored in
+    the engine URL. The caller owns caching and refresh when supplying a custom
+    provider.
+    """
+
     @event.listens_for(engine, "do_connect")
     def provide_token(
         dialect: Any,
@@ -171,6 +212,14 @@ def create_engine(
     drivername: str = "postgresql+psycopg",
     **engine_options: Any,
 ) -> Engine:
+    """Create a synchronous SQLAlchemy engine with connect-time credentials.
+
+    Connection coordinates are resolved once. The built-in provider is selected
+    from the resolved provisioned instance or Autoscaling endpoint and caches
+    credentials; a caller-supplied provider owns its complete lifecycle.
+    Additional keyword arguments pass directly to SQLAlchemy.
+    """
+
     resolved = resolve_postgres_connection(workspace_client, config)
     engine = sqlalchemy_create_engine(resolved.url(drivername), **engine_options)
     provider = credential_provider or _default_provider(workspace_client, resolved)
@@ -186,6 +235,13 @@ def create_async_engine(
     drivername: str = "postgresql+asyncpg",
     **engine_options: Any,
 ) -> AsyncEngine:
+    """Create an async SQLAlchemy engine with connect-time credentials.
+
+    Credential injection is installed on the async engine's underlying sync
+    engine. Resolution, provider ownership, and keyword forwarding match
+    :func:`create_engine`.
+    """
+
     resolved = resolve_postgres_connection(workspace_client, config)
     engine = sqlalchemy_create_async_engine(resolved.url(drivername), **engine_options)
     provider = credential_provider or _default_provider(workspace_client, resolved)
@@ -199,6 +255,14 @@ def resolve_postgres_connection(
     *,
     environ: Mapping[str, str] | None = None,
 ) -> ResolvedPostgresConnection:
+    """Resolve complete Postgres coordinates without minting credentials.
+
+    Values are layered from explicit config, parsed address/resource inputs,
+    ``LAKEBASE_*`` and ``PG*`` environment variables, then Workspace APIs for
+    missing Lakebase resources. Ambiguous discovery and unresolved host or user
+    values raise ``ValueError``.
+    """
+
     config = config or PostgresEngineConfig()
     env = os.environ if environ is None else environ
     raw_address = _first(config.address, config.endpoint, env.get("LAKEBASE_ENDPOINT"))

{dbx_tools_postgres-0.6.211 → dbx_tools_postgres-0.6.213}/src/dbx_tools/postgres/topic_bus.py

@@ -1,3 +1,5 @@
+"""Live Postgres LISTEN/NOTIFY topic fan-out with Node-compatible envelopes."""
+
 from __future__ import annotations
 
 import asyncio
@@ -21,9 +23,16 @@ from sqlalchemy.ext.asyncio import AsyncEngine
 SerializableValue: TypeAlias = (
     str | int | float | bool | None | list["SerializableValue"] | dict[str, "SerializableValue"]
 )
+"""A JSON value accepted without coercion by the topic-bus wire format."""
+
 TopicMetadata: TypeAlias = dict[str, SerializableValue]
+"""JSON metadata merged into a published topic message."""
+
 TopicListener: TypeAlias = Callable[["TopicMessage"], Awaitable[None] | None]
+"""Synchronous or asynchronous callback for one topic message."""
+
 TopicMetadataProvider: TypeAlias = Callable[[], Awaitable[TopicMetadata] | TopicMetadata]
+"""Synchronous or asynchronous provider evaluated for each broadcast."""
 
 _DEFAULT_CHANNEL = "dbx_tools_topic_bus"
 _MAX_CHANNEL_LENGTH = 63
@@ -42,6 +51,12 @@ class AsyncEngineLike(Protocol):
 
 @dataclass(frozen=True, slots=True)
 class TopicPublishInput:
+    """Caller-supplied message type, body, and per-message metadata.
+
+    Per-message metadata overrides configured and machine metadata with the same
+    key. The complete payload must remain JSON serializable without coercion.
+    """
+
     type: str
     body: SerializableValue
     metadata: TopicMetadata = field(default_factory=dict)
@@ -49,6 +64,8 @@ class TopicPublishInput:
 
 @dataclass(frozen=True, slots=True)
 class TopicMessage:
+    """Immutable Node-compatible topic message returned and delivered by the bus."""
+
     id: str
     topic: str
     type: str
@@ -58,9 +75,13 @@ class TopicMessage:
 
     @property
     def publishedAt(self) -> str:
+        """Return the wire-compatible camelCase publication timestamp."""
+
         return self.published_at
 
     def as_dict(self) -> dict[str, SerializableValue]:
+        """Return the JSON wire envelope with a ``publishedAt`` field."""
+
         return {
             "id": self.id,
             "topic": self.topic,
@@ -73,12 +94,28 @@ class TopicMessage:
 
 @dataclass(frozen=True, slots=True)
 class PostgresTopicBusOptions:
+    """Channel identity, automatic metadata, and asynchronous error handling.
+
+    ``metadata`` may be a static mapping or a provider evaluated for each
+    broadcast. ``on_error`` receives listener, reconnect, and cleanup failures
+    that cannot be raised back through the originating callback.
+    """
+
     channel: object = _DEFAULT_CHANNEL
     metadata: TopicMetadata | TopicMetadataProvider | None = None
     on_error: Callable[[BaseException], None] | None = None
 
 
 class PostgresTopicBus:
+    """Publish and receive live topic messages over Postgres LISTEN/NOTIFY.
+
+    The caller owns the SQLAlchemy engine. Listening lazily checks out one
+    dedicated raw connection that remains bound to the event loop until
+    :meth:`close`; broadcasts use independent transaction-scoped engine
+    connections. A terminated listener connection reconnects with bounded
+    exponential delay while listeners remain. Delivery is live and unstored.
+    """
+
     def __init__(
         self,
         engine: AsyncEngine | AsyncEngineLike,
@@ -103,9 +140,17 @@ class PostgresTopicBus:
 
     @property
     def channelName(self) -> str:
+        """Return the Node-compatible camelCase channel name property."""
+
         return self.channel_name
 
     async def start(self) -> None:
+        """Start the dedicated LISTEN connection once.
+
+        Calls are idempotent while active and serialized across concurrent
+        callers. A bus cannot be restarted after :meth:`close`.
+        """
+
         if self._driver_connection is not None:
             return
         if self._closed:
@@ -140,6 +185,13 @@ class PostgresTopicBus:
         topic: str,
         message_input: TopicPublishInput | Mapping[str, Any],
     ) -> TopicMessage:
+        """Publish one validated message and return its complete wire envelope.
+
+        Broadcasting does not require or create the dedicated LISTEN connection.
+        The encoded notification must fit within the package's conservative
+        7,900-byte Postgres payload limit.
+        """
+
         if not topic.strip():
             raise TypeError("Topic must not be empty")
         if self._closed:
@@ -169,6 +221,13 @@ class PostgresTopicBus:
         return message
 
     async def listen(self, topic: str, listener: TopicListener) -> Callable[[], Awaitable[None]]:
+        """Register ``listener`` and return an asynchronous unsubscribe callback.
+
+        The first listener starts the dedicated connection. Unsubscribing removes
+        only this callback; call :meth:`close` to release the LISTEN connection.
+        Listener failures are reported through ``on_error``.
+        """
+
         if not topic.strip():
             raise TypeError("Topic must not be empty")
         await self.start()
@@ -183,6 +242,11 @@ class PostgresTopicBus:
         return unsubscribe
 
     async def close(self) -> None:
+        """Permanently stop reconnecting, clear listeners, and close LISTEN state.
+
+        The operation is idempotent and does not dispose the caller-owned engine.
+        """
+
         if self._closed:
             return
         self._closed = True
@@ -280,6 +344,13 @@ class PostgresTopicBus:
 
 
 def channel_name(channel: object = _DEFAULT_CHANNEL) -> str:
+    """Derive a stable PostgreSQL channel identifier from one or more values.
+
+    The readable prefix is normalized and truncated, then suffixed with the same
+    stable-key FNV hash used by the Node package. The result fits PostgreSQL's
+    63-byte identifier limit and remains deterministic across runtimes.
+    """
+
     parts = list(channel) if isinstance(channel, (list, tuple)) else [channel]
     stable = "\0".join(to_stable_key(part) for part in parts)
     suffix = fnv_hash(stable, length=_CHANNEL_HASH_LENGTH)