pgrecon 0.1.0__tar.gz

pgrecon-0.1.0/.gitattributes

@@ -0,0 +1,3 @@
+# Normalize all text files to LF in the repository and in checkouts,
+# so builds behave identically on Windows and Linux.
+* text=auto eol=lf

pgrecon-0.1.0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,20 @@
+---
+name: Bug report
+about: Something behaves incorrectly
+---
+
+## What happened
+
+## What you expected
+
+## How to reproduce
+
+Include the command, the relevant part of the dump or fixture if
+possible (redact anything sensitive), and the full error output.
+
+## Environment
+
+- pgrecon version:
+- Python version:
+- OS:
+- Source database version (if relevant):

pgrecon-0.1.0/.github/ISSUE_TEMPLATE/rule_request.md

@@ -0,0 +1,23 @@
+---
+name: Rule request
+about: Propose a new assessment rule
+---
+
+## What should be detected
+
+Describe the Oracle construct or feature and why it matters for a
+PostgreSQL migration.
+
+## Suggested severity
+
+info / low / medium / high / blocker, and why.
+
+## PostgreSQL remedy
+
+How is this typically handled on the PostgreSQL side? Public references
+welcome.
+
+## Sample DDL or PL/SQL
+
+A minimal example that should trigger the rule (this becomes the
+fixture test).

pgrecon-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+## What
+
+One or two sentences: the problem and what this change does about it.
+
+## Checklist
+
+- [ ] Commit messages follow the project style (area prefix, imperative
+      subject, body explains why)
+- [ ] Tests added or updated; `uv run pytest` passes
+- [ ] `uv run ruff check .` and `uv run mypy src` pass
+- [ ] Plain ASCII only (fixtures exempt)

pgrecon-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Lint
+        run: |
+          uv run ruff check .
+          uv run ruff format --check .
+
+      - name: Type check
+        run: uv run mypy src
+
+      - name: ASCII policy
+        run: uv run python tools/check_ascii.py
+
+      - name: Import boundaries
+        run: uv run python tools/check_boundaries.py
+
+      - name: Commit message style
+        run: uv run python tools/check_commit.py --head
+
+      - name: Tests
+        run: uv run pytest --cov --cov-fail-under=85

pgrecon-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,39 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+
+      - name: Build distributions
+        run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pgrecon-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.venv/
+
+# Tooling caches
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Local working files
+*.db
+*.log
+dump/

pgrecon-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+default_install_hook_types: [pre-commit, commit-msg]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+        exclude: ^src/pgrecon/plsql/_generated/
+      - id: end-of-file-fixer
+        exclude: ^(tests/fixtures/|examples/dump_|src/pgrecon/plsql/_generated/)
+      - id: trailing-whitespace
+        exclude: ^(tests/fixtures/|examples/dump_|src/pgrecon/plsql/_generated/)
+      - id: check-merge-conflict
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.9
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: https://github.com/gitleaks/gitleaks
+    rev: v8.21.2
+    hooks:
+      - id: gitleaks
+
+  - repo: local
+    hooks:
+      - id: mypy
+        name: mypy
+        entry: uv run mypy src
+        language: system
+        pass_filenames: false
+        types: [python]
+      - id: ascii-check
+        name: ascii-check
+        entry: uv run python tools/check_ascii.py
+        language: system
+        pass_filenames: false
+      - id: import-boundaries
+        name: import-boundaries
+        entry: uv run python tools/check_boundaries.py
+        language: system
+        pass_filenames: false
+      - id: commit-msg-style
+        name: commit-msg-style
+        entry: uv run python tools/check_commit.py
+        language: system
+        stages: [commit-msg]

pgrecon-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

pgrecon-0.1.0/CHANGELOG.md

@@ -0,0 +1,112 @@
+# Changelog
+
+Release notes are written by hand, grouped by area. Dates use YYYY-MM-DD.
+
+## 0.1.0 - 2026-08-14
+
+First public release: offline extraction, a queryable inventory, and a
+61-rule assessment engine, verified end to end against real Oracle XE
+11g and 21c instances.
+
+Extraction
+
+- Offline SQL*Plus script over dictionary views only; SELECT
+  statements a DBA can review line by line. DDL via DBMS_METADATA,
+  structured facts (constraints, indexes, partitioning, synonyms,
+  triggers, database links) via dedicated spools. LONG-typed dictionary
+  columns (check conditions, index expressions) read through PL/SQL
+  chunkers.
+- Legacy script variant for Oracle 9.2 through 11.1: hand-built CSV
+  for old SQL*Plus clients, DDL reconstructed from the catalog instead
+  of DBMS_METADATA, byte-safe line chunking for pre-10.2 DBMS_OUTPUT
+  limits.
+- Runtime guards stop a too-old client or server with a message
+  pointing at the right variant instead of spooling a broken dump.
+  pgrecon script --source-version picks the variant automatically.
+- Performance posture is extracted: partitioned-index locality,
+  per-object parallel degree, query-rewrite and refresh settings of
+  materialized views, and SQL plan baselines and stored outlines
+  (outlines only on the legacy tier).
+- Scripts instruct the DBA to export NLS_LANG=.AL32UTF8 so dumps spool
+  as UTF-8 regardless of the database character set.
+
+Inventory
+
+- SQLite database with seventeen fact tables covering objects, tables,
+  columns, source, dependencies, features, DDL, constraints and their
+  columns, check conditions, indexes with columns and expressions,
+  partitioning, synonyms, triggers, and database links.
+- Extracted DDL is parsed with sqlglot's Oracle dialect. The stored
+  text stays verbatim; parsing runs on a normalized copy that strips
+  DBMS_METADATA artifacts (constraint-state keywords, identity column
+  options, the VIRTUAL marker). Parse failures and opaque fallback
+  parses are recorded as data.
+- Loads tolerate partial dumps and real SQL*Plus quirks such as the
+  blank line that opens every spool.
+- Dumps in any encoding load without crashing: undecodable bytes
+  degrade to replacement characters and leave a warning row in the
+  inventory, and pgrecon load --encoding recovers full fidelity when
+  the code page is known. Verified with Korean, Chinese, Japanese,
+  Hebrew, Arabic, Cyrillic, and German object names.
+
+PL/SQL analysis
+
+- Stored units are parsed at load time with a full PL/SQL grammar
+  (grammars-v4 via ANTLR, vendored as generated code so installation
+  never needs Java). Parsing tries fast SLL prediction first, retries
+  in full LL only when that bails, and records the outcome per unit.
+- A tree walk plus a token-channel scan store migration-relevant
+  facts in the inventory: transaction control, dynamic SQL, GOTO,
+  FORALL, collection types, autonomous transactions, swallowed
+  exceptions, SYSDATE, DECODE, ROWNUM, pipelined functions, implicit
+  cursor attributes, CONNECT BY, and (+) joins.
+- Code rules read those facts first, so constructs sitting in
+  comments or string literals stop producing findings. Units that
+  fail to parse keep token-level coverage, and inventories loaded by
+  older versions still report through the same fallback.
+- Call sites land in a plsql_calls table (caller, callee, line): the
+  supplied-package rules read it instead of matching text, and it is
+  the raw material for dependency clustering in the report stage.
+
+Rules
+
+- 61 deterministic rules across data types, storage, PL/SQL code, SQL
+  constructs, package structure, system package usage, schema
+  objects, and performance. Every rule ships with fixture tests.
+- ROWID, UROWID, and BFILE columns get type rules, and ROWID usage in
+  code is read from the token stream: ctid is not a stable row
+  address, and BFILE has no counterpart at all.
+- The empty-string trap gets its own rule: Oracle treats '' as NULL
+  and PostgreSQL does not, so every empty-string literal is a site
+  where behavior changes silently. The lexer tells a real '' from the
+  escaped quote in 'don''t', which text matching cannot.
+- The performance category starts with optimizer hints: statements
+  tuned by hand for Oracle's planner are marked for a fresh plan on
+  PostgreSQL instead of a blind rewrite.
+- Findings carry a stable rule id, severity, the object, and the
+  evidence seen, including source line numbers for code findings.
+- Parse failures surface as findings (R-DDL-01, R-DDL-02) so nothing
+  drops out of the assessment silently.
+
+CLI
+
+- pgrecon script, load, report, and info. Reports print text or JSON;
+  the JSON payload includes a severity summary and a provisional
+  effort-point total.
+- pgrecon -v logs progress and per-unit parse warnings to stderr;
+  stdout stays clean for report output, and logs never carry PL/SQL
+  body text.
+- Remedies are part of the output: report --remedies appends each
+  fired rule's guidance with its helping extension, pgrecon explain
+  shows one rule's writeup or lists the catalog, and the JSON payload
+  carries a rules map with title, severity, effort, remedy, and
+  extension for every rule that fired.
+- pgrecon estimate prices the migration in person-days from named
+  components: baseline, schema conversion, finding remediation with
+  severity-dependent repetition discounts, code volume, and data
+  movement, with a testing-and-stabilization factor range on top.
+  Every run prints its assumptions, and the JSON output carries the
+  same breakdown.
+- A bundled example dump (examples/dump_oracle21c, extracted from a
+  real Oracle XE 21c instance) makes the whole pipeline runnable
+  without an Oracle installation.

pgrecon-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,11 @@
+# Code of conduct
+
+Participation in this project is expected to be professional: technical
+arguments about code and design are welcome, personal attacks and
+harassment are not. Assume good faith, review the work rather than the
+person, and keep discussions on the record in issues and pull requests.
+
+Unacceptable behavior can be reported privately to
+muzzammil@umaish.com. Reports are handled confidentially. Maintainers
+may remove comments, reject contributions, or ban contributors whose
+behavior violates this standard.

pgrecon-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,68 @@
+# Contributing
+
+## Build and test
+
+Requires Python 3.11 or newer, and uv.
+
+    uv sync
+    uv run pytest
+    uv run ruff check .
+    uv run ruff format --check .
+    uv run mypy src
+    uv run pre-commit install    # once, to enable the local hooks
+
+## Commit conventions
+
+Commit style follows the PostgreSQL and Linux kernel projects, not
+"conventional commits".
+
+    area: short imperative summary, no trailing period
+
+    Body wrapped at 72 columns. State the problem, then the fix and the
+    reasoning. Complete sentences. The message must make sense without
+    the diff.
+
+- Area prefixes: extract, inventory, rules, report, cli, docs, build,
+  tests.
+- One logical change per commit. No "WIP", no "misc", no "update file".
+- Plain ASCII everywhere: source, comments, docs, commit messages.
+  No emoji, no unicode symbols. Two narrow exemptions exist for
+  encoding tests: files under tests/fixtures and examples/, and string
+  literals inside test modules, where the test data itself is the
+  point. Comments, identifiers, and docstrings stay ASCII even in
+  tests; src/ is strict with no exception. tools/check_ascii.py
+  enforces exactly this.
+- History is linear: rebase onto main and fast-forward. No merge
+  commits.
+
+## Code conventions
+
+- Comments explain why, not what. Dense where logic is subtle, absent
+  where the code is obvious.
+- Catch the exception you expect; never a bare except; never swallow an
+  error silently. A parse failure is recorded data, not a crash.
+- No dead code, no commented-out blocks, no speculative abstractions.
+- SQL uses bound parameters. Identifier quoting goes through a shared
+  helper.
+
+## How changes land
+
+Pull requests are the transport; history stays linear. Merge commits
+are disabled on the repository.
+
+- A series whose commits each follow the style above lands by rebase
+  and merge, keeping every commit and its author intact.
+- A messy series lands by squash and merge, with the final message
+  written to the same standard.
+- CI validates the head commit message of every pull request with
+  tools/check_commit.py, along with lint, types, tests, and the ASCII
+  and import-boundary checks.
+
+Contributor authorship is always preserved: your commits land under
+your name.
+
+## Adding a rule
+
+Every rule ships with fixture tests: sample input in tests/fixtures and
+an assertion of the expected findings. A rule without tests will not be
+merged.

pgrecon-0.1.0/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.