Skip to content

Database Section Migration#458

Draft
Ethan-Arrowood wants to merge 4 commits intomajor-version-reorgfrom
migration/database
Draft

Database Section Migration#458
Ethan-Arrowood wants to merge 4 commits intomajor-version-reorgfrom
migration/database

Conversation

@Ethan-Arrowood
Copy link
Member

Database Section Migration

Summary

Migration of the database/ documentation section from versioned_docs/version-4.X/ into the new consolidated v4 reference structure at reference_versioned_docs/version-v4/database/.

Files Created

  • reference_versioned_docs/version-v4/database/overview.md
  • reference_versioned_docs/version-v4/database/schema.md
  • reference_versioned_docs/version-v4/database/data-loader.md
  • reference_versioned_docs/version-v4/database/storage-algorithm.md
  • reference_versioned_docs/version-v4/database/jobs.md
  • reference_versioned_docs/version-v4/database/system-tables.md
  • reference_versioned_docs/version-v4/database/compaction.md
  • reference_versioned_docs/version-v4/database/transaction.md
  • reference_versioned_sidebars/version-v4-sidebars.json (Database category added)
  • migration-context/link-placeholders/database-link-placeholders.md

Source Files Used

overview.md

  • versioned_docs/version-4.7/reference/architecture.md (primary)
  • versioned_docs/version-4.7/reference/dynamic-schema.md (databases/tables concepts)
  • release-notes/v4-tucker/4.2.0.md (database structure changes, single-file-per-database)

schema.md

  • versioned_docs/version-4.7/developers/applications/defining-schemas.md (primary)
  • versioned_docs/version-4.7/reference/data-types.md (data types reference)
  • versioned_docs/version-4.7/reference/dynamic-schema.md (dynamic schema behavior)
  • versioned_docs/version-4.7/reference/blob.md (blob type and usage)
  • release-notes/v4-tucker/4.2.0.md through 4.6.0.md

data-loader.md

  • versioned_docs/version-4.7/developers/applications/data-loader.md (primary)
  • release-notes/v4-tucker/4.6.0.md

storage-algorithm.md

  • versioned_docs/version-4.7/reference/storage-algorithm.md (primary)
  • release-notes/v4-tucker/4.3.0.md

jobs.md

  • versioned_docs/version-4.7/administration/jobs.md (primary)
  • versioned_docs/version-4.7/developers/operations-api/bulk-operations.md
  • versioned_docs/version-4.7/developers/operations-api/jobs.md

system-tables.md

  • versioned_docs/version-4.7/reference/analytics.md (primary)
  • versioned_docs/version-4.7/developers/applications/data-loader.md
  • versioned_docs/version-4.7/developers/replication/index.md

compaction.md

  • versioned_docs/version-4.7/administration/compact.md (primary)
  • release-notes/v4-tucker/4.3.0.md

transaction.md

  • versioned_docs/version-4.7/administration/logging/transaction-logging.md (primary)
  • versioned_docs/version-4.7/administration/logging/audit-logging.md
  • release-notes/v4-tucker/4.3.0.md and 4.5.0.md

Version Annotations Added

High Confidence (Confirmed via release notes)

  • Configurable schemas: Added in v4.2.0
  • Relationships (@relationship): Added in v4.3.0
  • Null indexing: Added in v4.3.0
  • BigInt support: Added in v4.3.0
  • Computed properties (@computed): Added in v4.4.0
  • Auto-incrementing integer primary keys: Added in v4.4.0
  • Blob type: Added in v4.5.0
  • Vector indexing (HNSW): Added in v4.6.0
  • Data Loader component: Added in v4.6.0
  • Compact database: Added in v4.3.0
  • Compression by default (>4KB): Added in v4.3.0
  • Storage reclamation / audit log eviction: Added in v4.5.0
  • Transaction reuse after commit: Added in v4.5.0

Needs Verification

  • hdb_nodes and hdb_certificate system tables: Exact introduction version not confirmed via release notes
  • Dynamic schema __createdtime__/__updatedtime__: Likely v4.1.0 but not confirmed

Link Placeholders Created

See migration-context/link-placeholders/database-link-placeholders.md for the complete list.

Summary: 25 total placeholders across 9 target sections (operations-api, configuration, replication, resources, rest, analytics, cli, logging, components)

Images/Assets Noted

  • storage-algorithm.md: TODO-IMAGE for the LMDB indexing diagram
    • Original: versioned_docs/version-4.7/assets/HarperDB-3.0-Storage-Algorithm.png.webp
    • Human reviewer: Migrate, update, or remove

Conflicts & Questions for Human Review

  • @relationship vs @relation: v4.3.0 release notes show @relation, but v4.7 source docs use @relationship. Confirm which is current and if @relation is still supported.
  • Audit log required for real-time messaging: Verify this is still accurate in v4.7.
  • schema.md size: May benefit from splitting blob/vector into sub-pages if the page feels too long.

Migration Map Status

Updated status to "In Progress" — update to "Complete" after merge.

Checklist for Human Reviewer

  • Verify version annotations marked as "needs verification"
  • Confirm @relationship vs @relation directive naming
  • Confirm audit log requirement for real-time messaging
  • Decide on storage algorithm image (migrate/update/remove)
  • Consider schema.md split vs. keep together
  • Update migration-map.md status to "Complete" after merge

@github-actions
Copy link

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-458

This preview will update automatically when you push new commits.

@github-actions github-actions bot temporarily deployed to pr-458 March 18, 2026 22:59 Inactive
@github-actions github-actions bot temporarily deployed to pr-458 March 19, 2026 19:30 Inactive
@github-actions
Copy link

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-458

This preview will update automatically when you push new commits.

@github-actions
Copy link

🚀 Preview Deployment

Your preview deployment is ready!

🔗 Preview URL: https://preview.harper-documentation.harperfabric.com/pr-458

This preview will update automatically when you push new commits.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant