{"id":49646212,"url":"https://github.com/blackcatacademy/blackcat-database","last_synced_at":"2026-05-06T00:11:57.264Z","repository":{"id":319927358,"uuid":"1080124959","full_name":"blackcatacademy/blackcat-database","owner":"blackcatacademy","description":"Primary SQL layer, repositories, migrations and CRUD events. Used by blackcat-database-sync, blackcat-auth, blackcat-identity and blackcat-messaging; ships sync-check.php CLI.","archived":false,"fork":false,"pushed_at":"2025-12-19T02:12:04.000Z","size":4698,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-12-20T11:07:13.560Z","etag":null,"topics":["blackcat","database","devops","encryption","events","kms","migrations","mysql","php","schema","security","sql","submodules"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blackcatacademy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":"docs/ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":"NOTICE","maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-20T22:53:53.000Z","updated_at":"2025-12-19T02:12:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"93c313bc-00ac-4e76-bc3d-623b37cdc986","html_url":"https://github.com/blackcatacademy/blackcat-database","commit_stats":null,"previous_names":["blackcatacademy/blackcat-database"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/blackcatacademy/blackcat-database","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackcatacademy%2Fblackcat-database","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackcatacademy%2Fblackcat-database/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackcatacademy%2Fblackcat-database/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackcatacademy%2Fblackcat-database/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blackcatacademy","download_url":"https://codeload.github.com/blackcatacademy/blackcat-database/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blackcatacademy%2Fblackcat-database/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32672739,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-05T11:29:49.557Z","status":"ssl_error","status_checked_at":"2026-05-05T11:29:48.587Z","response_time":54,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blackcat","database","devops","encryption","events","kms","migrations","mysql","php","schema","security","sql","submodules"],"created_at":"2026-05-06T00:11:56.415Z","updated_at":"2026-05-06T00:11:57.256Z","avatar_url":"https://github.com/blackcatacademy.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"![BlackCat Database](./.github/blackcat-database-banner.png)\n\n# BlackCat Database · Release Channel\n\n[![DB Docs](https://github.com/blackcatacademy/blackcat-database/actions/workflows/db-docs.yml/badge.svg?branch=dev)](https://github.com/blackcatacademy/blackcat-database/actions/workflows/db-docs.yml?query=branch%3Adev)\n[![DB CI](https://github.com/blackcatacademy/blackcat-database/actions/workflows/db-ci.yml/badge.svg?branch=dev)](https://github.com/blackcatacademy/blackcat-database/actions/workflows/db-ci.yml?query=branch%3Adev)\n[![Core CI](https://github.com/blackcatacademy/blackcat-database/actions/workflows/ci.yml/badge.svg?branch=dev)](https://github.com/blackcatacademy/blackcat-database/actions/workflows/ci.yml?query=branch%3Adev)\n[![Lint PHP](https://github.com/blackcatacademy/blackcat-database/actions/workflows/lint.yml/badge.svg?branch=dev)](https://github.com/blackcatacademy/blackcat-database/actions/workflows/lint.yml?query=branch%3Adev)\n\n![MySQL](https://img.shields.io/badge/SQL-MySQL%208.0%2B-4479A1?logo=mysql\u0026logoColor=white)\n![MariaDB](https://img.shields.io/badge/SQL-MariaDB%2010.4.x-003545?logo=mariadb\u0026logoColor=white)\n![PostgreSQL](https://img.shields.io/badge/SQL-PostgreSQL%2016-336791?logo=postgresql\u0026logoColor=white)\n![Status](https://img.shields.io/badge/status-stable-informational)\n![License](https://img.shields.io/badge/license-BlackCat%20Proprietary-red)\n\nPolished, ship-ready bundle of BlackCat table packages. Submodules are pinned to\ntheir `main` branches, docs are pre-generated, and dev-only tooling is stripped\nout. Need generators, infra, or CI harnesses? Jump to `dev`.\n\n👉 See [SALES.md](./SALES.md) for a concise value deck and differentiators.\n\n**Release highlights**\n- Ready-to-run packages with generated docs (no local codegen required).\n- Alignment across MySQL 8.0, MariaDB 10.4.x, PostgreSQL 16.\n- Deterministic submodule SHAs; no CI workflows or infra clutter in this branch.\n- Security, support, and licensing files stay first-class.\n\n## Contents\n\n- [What's inside](#whats-inside)\n- [Repository map](#repository-map)\n- [Quick start](#quick-start)\n- [Working with packages](#working-with-packages)\n- [Compatibility \u0026 runtime notes](#compatibility--runtime-notes)\n- [Consumption patterns](#consumption-patterns)\n- [Branch model](#branch-model)\n- [Docs, support, license](#docs-support-license)\n\n---\n\n## What's inside\n\n- Package submodules under `packages/`, pinned to their `main` branches.\n- Generated docs (including `PACKAGES.md`) and runtime helpers in `src/`.\n- Composer metadata for consumers; dev-only generators and infra stacks are not shipped here.\n- Compliance files: LICENSE, NOTICE, SECURITY, SUPPORT, CODEOWNERS.\n- Excluded: CI workflows, Terraform/K8s assets, scaffolding helpers, and PowerShell/PHP generators (all live in `dev`).\n\n## Repository map\n\n| Path | Description |\n| --- | --- |\n| `packages/` | Table packages (Git submodules), pinned for release. |\n| `docs/` | Generated documentation and package catalog (`PACKAGES.md`). |\n| `src/` | Runtime helpers and installers used by consumers. |\n| `composer.json` | Runtime dependencies; no dev generators here. |\n| `PACKAGES.md` | Catalog of modules included in this release. |\n\n## Quick start\n\n```bash\ngit clone --recursive https://github.com/blackcatacademy/blackcat-database.git -b release/main blackcat-database-release\ncd blackcat-database-release\ngit submodule update --init --recursive\ncomposer install --no-dev\n```\n\n- Package READMEs live in `packages/*/README.md`.\n- Regeneration of docs/schemas is not available here; switch to `dev` for generators and CI workflows.\n\n## Working with packages\n\n- Start from [`PACKAGES.md`](./PACKAGES.md) to see the included modules and jump into `packages/\u003cname\u003e/README.md`.\n- Runtime entry points are under `src/` (installers, helpers). Examples remain in `packages/*/docs`.\n- To update a package pin: `git submodule update --remote packages/\u003cname\u003e` (ensure you’re on `release/main` and bump to the desired `main` SHA), then commit.\n- Need schema changes or regenerated docs? Do the work on `dev`, run the generators there, and promote the result back into `release/main`.\n\n## Compatibility \u0026 runtime notes\n\n- Engines: MySQL 8.0+, MariaDB 10.4.x, PostgreSQL 16. See per-package READMEs for engine-specific notes.\n- PHP: 8.3+ with PDO drivers for MySQL and PostgreSQL.\n- Line endings and SQL formatting are already normalized (LF); no additional lint steps needed in this branch.\n- Upgrade path: pull latest `release/main`, update submodules, and run your service migrations using the package scripts in `packages/*/schema`.\n\n### Support matrix\n\n| Area | Supported | Notes |\n| --- | --- | --- |\n| SQL engines | MySQL 8.0+, MariaDB 10.4.x, PostgreSQL 16 | Keep engine order in DDLs from package READMEs. |\n| PHP runtime | 8.3+ | Composer install uses `--no-dev`; PDO MySQL/Postgres required. |\n| Docs | Prebuilt in `docs/` + `PACKAGES.md` | Regenerate only on `dev`. |\n| Line endings | LF | Already normalized across repo. |\n\n## Consumption patterns\n\n- **App integration:** require this umbrella (or individual packages) in your composer project, run `composer install --no-dev`, and wire the repositories/services from `src/`.\n- **Migrations:** apply the DDL from `packages/\u003cname\u003e/schema/*.sql` in engine order; per-package README tables show the right files.\n- **Docs \u0026 definitions:** `docs/` and `PACKAGES.md` are already built; treat them as the reference. If you need refreshed docs, switch to `dev`, regenerate, and cherry-pick into `release/main`.\n- **Hotfix flow:** patch on `dev`, backport the minimal change set to `release/main`, and bump the affected submodule pins. Avoid committing regenerated assets in `release/main` unless they belong to the hotfix.\n\n## Branch model\n\n- `release/main`: production bundle with dev tooling removed; submodules pinned to their `main`.\n- `dev`: full development branch with generators, CI workflows, and infrastructure assets. Make changes there and promote into `release/main`.\n\n## Release operations (maintainers)\n\n1) Work on `dev`: run generators, refresh docs, and bump package SHAs.  \n2) Fast-forward `release/main` to the desired SHAs (submodules + root), commit pins.  \n3) Smoke-test: install with `--no-dev`, run minimal schema apply against MySQL/Postgres.  \n4) Push `release/main` and open a PR into `main` if your workflow requires review gates.  \n5) Tag releases from `release/main` only after submodule pins and docs are stable.\n\n## Docs, support, license\n\n- Core docs remain available in `docs/` (overview, usage, package catalog). CI command references and generator guides live in `dev`.\n- Issues and PRs should target `dev`; release updates are generated from there.\n- Security: see [SECURITY.md](./SECURITY.md). License: [LICENSE](./LICENSE).\n  For help, check [SUPPORT.md](./SUPPORT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackcatacademy%2Fblackcat-database","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblackcatacademy%2Fblackcat-database","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblackcatacademy%2Fblackcat-database/lists"}