{"id":48598012,"url":"https://github.com/mikedan37/blazedb","last_synced_at":"2026-04-24T05:02:11.016Z","repository":{"id":308042173,"uuid":"1031436516","full_name":"Mikedan37/BlazeDB","owner":"Mikedan37","description":"Swift-native embedded database for local app storage with encrypted page persistence, WAL-backed crash recovery, and reactive SwiftUI integration.","archived":false,"fork":false,"pushed_at":"2026-04-17T06:33:19.000Z","size":6638,"stargazers_count":7,"open_issues_count":13,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-17T07:33:46.414Z","etag":null,"topics":["blazedb","database","developer-tools","embedded-database","local-first","storage-engine","swift","swiftui"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mikedan37.png","metadata":{"files":{"readme":"Docs/README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"Docs/Security/AUTH_TOKEN_MANAGEMENT.md","support":"Docs/SUPPORT_POLICY.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-03T18:27:00.000Z","updated_at":"2026-04-17T05:50:38.000Z","dependencies_parsed_at":"2025-08-03T20:38:35.615Z","dependency_job_id":"7b07b38f-bfbf-473c-b9ed-894a4f6019ad","html_url":"https://github.com/Mikedan37/BlazeDB","commit_stats":null,"previous_names":["mikedan37/blazedb"],"tags_count":16,"template":false,"template_full_name":null,"purl":"pkg:github/Mikedan37/BlazeDB","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mikedan37%2FBlazeDB","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mikedan37%2FBlazeDB/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mikedan37%2FBlazeDB/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mikedan37%2FBlazeDB/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mikedan37","download_url":"https://codeload.github.com/Mikedan37/BlazeDB/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mikedan37%2FBlazeDB/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32209896,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-24T03:15:14.334Z","status":"ssl_error","status_checked_at":"2026-04-24T03:15:11.608Z","response_time":64,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6: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":["blazedb","database","developer-tools","embedded-database","local-first","storage-engine","swift","swiftui"],"created_at":"2026-04-08T21:02:45.930Z","updated_at":"2026-04-24T05:02:11.011Z","avatar_url":"https://github.com/Mikedan37.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BlazeDB Documentation\n\nThis index separates the main public documentation path from maintainer-only or historical material. *Skim the headings to see where you are; you don’t have to read this file top to bottom.*\n\n## Support-State Framing\n\n*Quick mental model so you don’t assume sync/telemetry are in the default box.* Use this quick framing before diving into detailed docs:\n\n- **Default shipped core:** embedded encrypted engine, typed/raw APIs, durability, import/export, health/stats, CLI tooling.\n- **Advanced but supported:** migrations, schema validation, indexing/search tuning, manual mapping.\n- **Conditional/deferred:** distributed sync/server/discovery and full telemetry path outside default OSS runtime packaging.\n- **Historical/internal:** archive and project-management docs are non-authoritative for first-time adopters.\n\n## Audience Segmentation\n\n*Each pile targets a different reader so you can ignore the wrong shelf.*\n\n- **Public product docs:** what BlazeDB is, how to use it, what is supported now.\n- **Public maintainer docs:** release/testing/CI operations for contributors.\n- **Internal analysis docs:** branch/capability/positioning analysis artifacts for maintainers.\n\nInternal analysis material lives under [`Docs/Internal/`](Internal/README.md) and should not be treated as onboarding guidance.\n\n## Documentation guide\n\n*Map of the folders: what to trust for “how does it work today.”* BlazeDB documentation is organized into:\n\n- **Canonical docs (current, maintained):** Use these first for behavior and APIs:\n  - [Repository README](../README.md) (Start Here, try from repo / add to app, product summary)\n  - [Getting Started](GettingStarted/) (first run, HOW_TO_USE, Linux notes)\n  - [Testing / CI](Testing/) (tiers, test layout, execution model)\n  - [Release](Release/) (release-facing checklists and notes)\n  - [Architecture](Architecture/): **core embedded runtime** (storage, queries, durability); prefer these over informal design notes for “what ships” in OSS.\n\n- **Design / forward-looking docs:** Distributed transport, sync topology, and related material may describe **non-default** or **deferred** surfaces. Always cross-check [Distributed transport deferred](Status/DISTRIBUTED_TRANSPORT_DEFERRED.md) and the root `README.md` for what the default SwiftPM product includes.\n\n- **Archived / historical docs:** [`Archive/`](Archive/) holds snapshots, old milestones, and superseded write-ups. **Not authoritative** for current OSS behavior unless explicitly cross-linked from a maintained doc.\n\n## Start Here\n\n*If you’re new, hit these in roughly this order. You’ll stay on the happy path.*\n\n- [Getting Started](GettingStarted/README.md): install the package, run `HelloBlazeDB`, paste the tiny starter snippet; the “I just want it working” path.\n- [Default storage paths](GettingStarted/DEFAULT_STORAGE_PATHS.md): macOS / iOS / Linux default DB and telemetry locations (canonical reference when paths matter).\n- [Developer Guide](DEVELOPER_GUIDE.md): longer walkthrough of the public API in prose (CRUD, queries, patterns); read after you’ve run something once.\n- [API Reference](API/API_REFERENCE.md): lookup tables and signatures when you already know what you’re trying to call.\n- [Examples](../Examples/): copy-paste runnable projects and patterns when docs need a concrete file to stare at.\n\n## Core Product Docs\n\n*Stuff you’ll want when something “should work on my OS” or “what happens on crash / upgrade.”*\n\n- [Compatibility](COMPATIBILITY.md) for supported platforms and release expectations.\n- [Security](../SECURITY.md) for vulnerability reporting and disclosure expectations.\n- [Durability Mode Support](Status/DURABILITY_MODE_SUPPORT.md) for WAL and recovery guarantees.\n- [Key Management and Compatibility](Status/KEY_MANAGEMENT_AND_COMPATIBILITY.md) for password and key-handling behavior.\n- [Legacy Layout Migration Guidance](Status/LEGACY_LAYOUT_MIGRATION_GUIDANCE.md) for migration-sensitive upgrades.\n- [Architecture](Architecture/README.md) for system design and internals.\n- [Performance](Performance/README.md) for benchmark and performance guidance.\n\n## Advanced Features (Supported)\n\n*Still supported, just not the first day’s reading.*\n\n- [Developer Guide](DEVELOPER_GUIDE.md) (advanced API sections)\n- [API Reference](API/API_REFERENCE.md) (full reference; includes advanced and conditional surfaces)\n- [Performance](Performance/README.md) (benchmark and tuning guidance)\n\n## Conditional / Deferred Features\n\n*May exist in the repo or docs but isn’t the default OSS story. Read so you don’t cargo-cult sync/transport.*\n\n- [Distributed Transport Deferred Status](Status/DISTRIBUTED_TRANSPORT_DEFERRED.md)\n- [Sync Docs](Sync/README.md) - design and deferred transport context; not default OSS onboarding\n- Telemetry and staging-related surfaces in source are conditional and should be treated as non-default runtime behavior\n\n## Contributing And Project Policies\n\n*Legal/social/process: how to contribute, behave, report issues, and what stability means.*\n\n- [Contributing Guide](../CONTRIBUTING.md)\n- [Code of Conduct](../CODE_OF_CONDUCT.md)\n- [Security Policy](../SECURITY.md)\n- [Support Policy](SUPPORT_POLICY.md)\n- [API Stability](API_STABILITY.md)\n- [Third-Party Notices](../THIRD_PARTY_NOTICES.md)\n\n## Maintainer Docs\n\n*CI lanes, releases, checklists for people merging PRs or cutting releases.*\n\n- [CI and Test Tiers](Testing/CI_AND_TEST_TIERS.md)\n- [Testing Guide](TESTING_GUIDE.md)\n- [Release Rollback Procedure](Status/RELEASE_ROLLBACK.md)\n- [Open-Source Readiness Checklist](Status/OPEN_SOURCE_READINESS_CHECKLIST.md) (hosted CI expectations and local validation paths)\n- [External Security Review Plan](Status/EXTERNAL_SECURITY_REVIEW_PLAN.md)\n- [Master Documentation Index](MASTER_DOCUMENTATION_INDEX.md)\n- [Agents Guide](AGENTS_GUIDE.md)\n\n## Internal Analysis Docs\n\n*Deep dives and positioning notes; interesting for maintainers, not required reading for app devs.*\n\n- [Internal Docs Index](Internal/README.md)\n- Analysis-style status artifacts are maintainer-facing and intentionally separated from user onboarding flow.\n\n## Historical And Internal Material\n\n*Old milestones, superseded designs, audits: useful for archaeology, not “current truth” unless linked from a maintained doc.*\n\n- [Archive](Archive/) for historical release and design records (see [Archive README](Archive/README.md)).\n- [Meta](Meta/README.md) for internal project-management documentation.\n- [Audit](Audit/README.md) for audit snapshots and internal review artifacts.\n- [Project](Project/README.md) for project status and assessment notes.\n- [Tools](Tools/README.md) for tool-specific documentation.\n\nUse the sections above as the default path. Archive and internal folders are useful for maintainers, but they are not the recommended starting point for new adopters.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikedan37%2Fblazedb","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikedan37%2Fblazedb","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikedan37%2Fblazedb/lists"}