hindsightdb 0.1.0__tar.gz

hindsightdb-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 2026 Hindsight
+
+   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.

hindsightdb-0.1.0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: hindsightdb
+Version: 0.1.0
+Summary: Capture PostgreSQL row changes for per-field history, blame, and time travel.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://hindsightdb.com
+Keywords: postgresql,audit-log,change-data-capture,data-lineage,temporal-data
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Database
+Classifier: Topic :: System :: Logging
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: sqlalchemy
+Requires-Dist: sqlalchemy>=2.0; extra == "sqlalchemy"
+Provides-Extra: yaml
+Requires-Dist: pyyaml>=6.0; extra == "yaml"
+Provides-Extra: outbox
+Requires-Dist: psycopg[binary]>=3.1; extra == "outbox"
+Provides-Extra: wal
+Requires-Dist: psycopg[binary]>=3.1; extra == "wal"
+Provides-Extra: dev
+Requires-Dist: sqlalchemy>=2.0; extra == "dev"
+Requires-Dist: pyyaml>=6.0; extra == "dev"
+Requires-Dist: psycopg[binary]>=3.1; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: black>=24.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Dynamic: license-file
+
+# hindsightdb — the Hindsight capture SDK: ship row changes from your app to Hindsight, for per-field history, blame and time travel.

hindsightdb-0.1.0/README.md

@@ -0,0 +1 @@
+# hindsightdb — the Hindsight capture SDK: ship row changes from your app to Hindsight, for per-field history, blame and time travel.

hindsightdb-0.1.0/hindsight/__init__.py

@@ -0,0 +1,251 @@
+"""Public API for Hindsight capture."""
+
+from __future__ import annotations
+
+import atexit
+import logging
+import os
+from collections.abc import Callable
+from typing import Any
+
+from hindsight.config import CaptureConfig
+from hindsight.contract import SDK_VERSION
+from hindsight.keys import parse_key, resolve_key, resolve_url
+from hindsight.queue import RowQueue
+from hindsight.shipper import Shipper
+from hindsight.transport import Transport, UrllibTransport
+
+__all__ = ["init", "shutdown", "flush", "stats", "Client", "CaptureConfig", "SDK_VERSION"]
+
+log = logging.getLogger("hindsight")
+_client: Client | None = None
+
+
+class Client:
+    def __init__(
+        self,
+        *,
+        slug: str,
+        transport: Transport,
+        cfg: CaptureConfig,
+        queue_size: int = 10_000,
+        batch_rows: int = 500,
+        batch_interval: float = 2.0,
+        spool_dir: str | None = None,
+        producer: str = "orm",
+    ):
+        self.slug = slug
+        self.cfg = cfg
+        self.queue = RowQueue(queue_size)
+        self.shipper = Shipper(
+            transport,
+            slug,
+            self.queue,
+            producer=producer,
+            batch_rows=batch_rows,
+            batch_interval=batch_interval,
+            spool_dir=spool_dir,
+        )
+        self.adapter: Any = None
+        self.outbox: Any = None
+        self.manifest: dict[str, Any] | None = None
+
+    def set_metadata(self, metadata: Any) -> None:
+        from hindsight.sqlalchemy.manifest import build_manifest
+
+        self.manifest = build_manifest(metadata, self.cfg)
+        self.shipper.set_manifest(self.manifest)
+
+    def attach_sqlalchemy(
+        self, engine: Any, context_provider: Callable[[], dict[str, Any] | None] | None
+    ) -> None:
+        from hindsight.sqlalchemy.adapter import SQLAlchemyAdapter
+
+        self.adapter = SQLAlchemyAdapter(
+            self.queue,
+            self.cfg,
+            engine=engine,
+            context_provider=context_provider,
+            on_manifest=self.set_metadata,
+        )
+        self.adapter.install()
+
+    def attach_outbox(
+        self,
+        dsn: str,
+        *,
+        engine: Any = None,
+        context_provider: Callable[[], dict[str, Any] | None] | None = None,
+        metadata: Any = None,
+        auto_install: bool = False,
+        batch_rows: int = 500,
+        batch_interval: float = 2.0,
+    ) -> None:
+        from hindsight.outbox.adapter import OutboxAdapter
+        from hindsight.outbox.catalog import installed_triggers, introspect, manifest_from_catalog
+        from hindsight.outbox.db import Database, connector
+        from hindsight.outbox.shipper import OutboxShipper
+        from hindsight.outbox.spec import specs_from_manifest
+        from hindsight.outbox.sql import install_sql
+
+        db = Database(connector(dsn))
+        if metadata is not None:
+            from hindsight.sqlalchemy.manifest import build_manifest
+
+            self.manifest = build_manifest(metadata, self.cfg, mode="outbox")
+        else:
+            self.manifest = manifest_from_catalog(introspect(db), self.cfg)
+        self.shipper.set_manifest(self.manifest)
+        specs = specs_from_manifest(self.manifest, self.cfg)
+        if auto_install:
+            db.run(install_sql(specs))
+        have = installed_triggers(db)
+        missing = [s.name for s in specs if s.name not in have]
+        if missing:
+            log.warning(
+                "hindsight: %d captured tables have no trigger (run `hindsight apply`): %s",
+                len(missing),
+                ", ".join(missing[:10]),
+            )
+        begin_ok = db.fetchrow("SELECT to_regprocedure('capture_begin(jsonb)') IS NOT NULL")
+        if begin_ok and begin_ok[0]:
+            self.adapter = OutboxAdapter(engine=engine, context_provider=context_provider)
+            self.adapter.install()
+        else:
+            log.warning("hindsight: capture_begin() is missing — actor attribution is off")
+        self.outbox = OutboxShipper(
+            db,
+            self.shipper,
+            [s.name for s in specs],
+            batch_rows=batch_rows,
+            interval=batch_interval,
+            max_rows=self.cfg.outbox_max_rows,
+            max_bytes=self.cfg.outbox_max_bytes,
+        )
+
+    def start(self) -> None:
+        if self.outbox is not None:
+            self.outbox.start()
+        else:
+            self.shipper.start()
+
+    def flush(self, timeout: float = 10.0) -> int:
+        import time
+
+        deadline = time.monotonic() + timeout
+        if self.outbox is not None:
+            return int(self.outbox.drain(deadline=deadline))
+        return self.shipper.flush(deadline=deadline)
+
+    def close(self, timeout: float = 5.0) -> None:
+        if self.adapter is not None:
+            self.adapter.uninstall()
+        if self.outbox is not None:
+            self.outbox.stop(timeout)
+        self.shipper.stop(timeout)
+
+    def stats(self) -> dict[str, Any]:
+        return {
+            "slug": self.slug,
+            "boot_id": self.shipper.boot_id,
+            "queue": self.queue.stats(),
+            "shipper": dict(self.shipper.stats),
+            "adapter": dict(self.adapter.stats) if self.adapter else {},
+            "outbox": dict(self.outbox.stats) if self.outbox else {},
+        }
+
+
+def init(
+    engine: Any = None,
+    *,
+    key: str | None = None,
+    url: str | None = None,
+    config: str | CaptureConfig | None = None,
+    context_provider: Callable[[], dict[str, Any] | None] | None = None,
+    metadata: Any = None,
+    mode: str | None = None,
+    dsn: str | None = None,
+    auto_install: bool = False,
+    spool_dir: str | None = None,
+    queue_size: int = 10_000,
+    batch_rows: int = 500,
+    batch_interval: float = 2.0,
+    transport: Transport | None = None,
+    start: bool = True,
+) -> Client | None:
+    """Start capture, returning ``None`` when capture is unavailable."""
+    global _client
+    try:
+        raw_key = resolve_key(key)
+        if not raw_key:
+            log.warning("hindsight: no HINDSIGHT_KEY — capture is off")
+            return None
+        slug, raw_key = parse_key(raw_key)
+        cfg = config if isinstance(config, CaptureConfig) else CaptureConfig.load(config)
+        if mode:
+            cfg.mode = mode
+        if cfg.mode not in ("orm", "outbox"):
+            log.warning("hindsight: unknown mode %r; using orm", cfg.mode)
+            cfg.mode = "orm"
+        if _client is not None:
+            _client.close(0.0)
+        client = Client(
+            slug=slug,
+            transport=transport or UrllibTransport(resolve_url(url), raw_key),
+            cfg=cfg,
+            queue_size=queue_size,
+            batch_rows=batch_rows,
+            batch_interval=batch_interval,
+            spool_dir=spool_dir,
+            producer=cfg.mode,
+        )
+        if cfg.mode == "outbox":
+            from hindsight.outbox.db import dsn_of_engine
+
+            dsn = dsn or os.environ.get("HINDSIGHT_DSN") or dsn_of_engine(engine)
+            if not dsn:
+                raise RuntimeError("outbox mode needs dsn= (or HINDSIGHT_DSN, or an engine)")
+            client.attach_outbox(
+                dsn,
+                engine=engine,
+                context_provider=context_provider,
+                metadata=metadata,
+                auto_install=auto_install,
+                batch_rows=batch_rows,
+                batch_interval=batch_interval,
+            )
+        else:
+            if metadata is not None:
+                client.set_metadata(metadata)
+            if engine is not None or metadata is not None:
+                client.attach_sqlalchemy(engine, context_provider)
+        if start:
+            client.start()
+        _client = client
+        atexit.register(_atexit)
+        log.info("hindsight: capturing for source %r (boot %s)", slug, client.shipper.boot_id)
+        return client
+    except Exception:
+        log.exception("hindsight: init failed — capture is off, the app is unaffected")
+        return None
+
+
+def _atexit() -> None:
+    shutdown(timeout=3.0)
+
+
+def shutdown(timeout: float = 5.0) -> None:
+    global _client
+    if _client is not None:
+        try:
+            _client.close(timeout)
+        finally:
+            _client = None
+
+
+def flush(timeout: float = 10.0) -> int:
+    return _client.flush(timeout) if _client else 0
+
+
+def stats() -> dict[str, Any]:
+    return _client.stats() if _client else {}

hindsightdb-0.1.0/hindsight/canonical.py

@@ -0,0 +1,145 @@
+"""Type-aware normalization and hashing for captured rows."""
+
+from __future__ import annotations
+
+import datetime as dt
+import decimal
+import hashlib
+import json
+import uuid
+from typing import Any
+
+_NUMERIC = ("int", "numeric", "decimal", "real", "double", "money", "serial", "float")
+_TZ = ("timestamptz", "with time zone")
+_JSON = ("json",)
+
+
+def kind_of(pg_type: str) -> str:
+    """Map a PostgreSQL type to its normalization family."""
+    t = (pg_type or "").lower().strip()
+    if t.endswith("[]") or t.startswith("_") or t.startswith("array"):
+        return "array"
+    if any(k in t for k in _JSON):
+        return "json"
+    if t.startswith("bool"):
+        return "bool"
+    if any(k in t for k in _TZ):
+        return "timestamptz"
+    if t.startswith("timestamp") or t.startswith("date") or t.startswith("time"):
+        return "datetime"
+    if t == "uuid":
+        return "uuid"
+    if any(k in t for k in _NUMERIC):
+        return "numeric"
+    return "text"
+
+
+def element_type(pg_type: str) -> str:
+    t = (pg_type or "").lower().strip()
+    if t.endswith("[]"):
+        return t[:-2]
+    if t.startswith("_"):
+        return t[1:]
+    return "text"
+
+
+def _decimal(value: Any) -> str:
+    try:
+        d = decimal.Decimal(str(value))
+    except (decimal.InvalidOperation, ValueError):
+        return str(value)
+    if not d.is_finite():
+        return str(d)
+    d = d.normalize()
+    if d == 0:
+        return "0"
+    return format(d, "f")
+
+
+def _parse_dt(value: Any) -> Any:
+    if isinstance(value, dt.datetime):
+        return value
+    if isinstance(value, str):
+        s = value.strip().replace(" ", "T", 1) if " " in value.strip() else value.strip()
+        if s.endswith("Z"):
+            s = s[:-1] + "+00:00"
+        try:
+            return dt.datetime.fromisoformat(s)
+        except ValueError:
+            return None
+    return None
+
+
+def canonical_value(value: Any, pg_type: str) -> Any:
+    """Normalize a value using its PostgreSQL type."""
+    if value is None:
+        return None
+    kind = kind_of(pg_type)
+    if kind == "numeric":
+        if isinstance(value, bool):
+            return "1" if value else "0"
+        return _decimal(value)
+    if kind == "bool":
+        if isinstance(value, str):
+            return value.strip().lower() in ("t", "true", "1", "yes", "on")
+        return bool(value)
+    if kind == "timestamptz":
+        parsed = _parse_dt(value)
+        if parsed is None:
+            return str(value)
+        if parsed.tzinfo is None:
+            parsed = parsed.replace(tzinfo=dt.UTC)
+        return parsed.astimezone(dt.UTC).isoformat()
+    if kind == "datetime":
+        if isinstance(value, (dt.datetime, dt.date, dt.time)):
+            return value.isoformat()
+        return str(value).strip().replace(" ", "T", 1)
+    if kind == "uuid":
+        if isinstance(value, uuid.UUID):
+            return str(value)
+        return str(value).strip().lower()
+    if kind == "json":
+        if isinstance(value, str):
+            try:
+                return json.loads(value)
+            except ValueError:
+                return value
+        return value
+    if kind == "array":
+        if isinstance(value, str):
+            try:
+                value = json.loads(value)
+            except ValueError:
+                return value
+        if isinstance(value, (list, tuple)):
+            et = element_type(pg_type)
+            return [canonical_value(v, et) for v in value]
+        return value
+    if isinstance(value, (dict, list)):
+        return json.dumps(value, sort_keys=True, separators=(",", ":"), default=str)
+    if isinstance(value, bool):
+        return "true" if value else "false"
+    if isinstance(value, (bytes, bytearray, memoryview)):
+        return bytes(value).hex()
+    return str(value)
+
+
+def captured_columns(table: dict[str, Any]) -> dict[str, str]:
+    """Return captured column names and types."""
+    cols = table.get("columns") or {}
+    return {
+        name: str((spec or {}).get("pg_type") or "text")
+        for name, spec in sorted(cols.items())
+        if (spec or {}).get("captured", True) and not name.startswith("_")
+    }
+
+
+def canonical_row(values: dict[str, Any], columns: dict[str, str]) -> dict[str, Any]:
+    return {name: canonical_value(values.get(name), pg_type) for name, pg_type in columns.items()}
+
+
+def row_hash(values: dict[str, Any], columns: dict[str, str]) -> str:
+    canonical = json.dumps(
+        canonical_row(values, columns), sort_keys=True, separators=(",", ":"), default=str
+    )
+    return hashlib.sha256(canonical.encode()).hexdigest()[:32]