Skip to content

docs: Add JSONB column support and GIN index documentation#470

Merged
marcelomendoncasoares merged 4 commits intoserverpod:mainfrom
developerjamiu:docs/jsonb-support
Apr 24, 2026
Merged

docs: Add JSONB column support and GIN index documentation#470
marcelomendoncasoares merged 4 commits intoserverpod:mainfrom
developerjamiu:docs/jsonb-support

Conversation

@developerjamiu
Copy link
Copy Markdown
Contributor

@developerjamiu developerjamiu commented Apr 20, 2026

Adds documentation for the JSONB column support feature introduced in serverpod/serverpod#4960.

Changes:

  • Database Models (02-models.md): New "Storing fields as JSONB" section documenting serializationDataType at field, class, and project levels with precedence chain (field > class > project)
  • Indexing (04-indexing.md): New "GIN indexes" section documenting auto-defaulting, explicit type, and operator classes (jsonbOps, jsonbPathOps, arrayOps, tsvectorOps)
  • Configuration (07-configuration.md): Added serialize_as_jsonb_by_default to the generator config options table
  • Heading hierarchy fix: Promoted H3 top-level sections to H2 in both 02-models.md and 04-indexing.md for consistent H1 → H2 → H3 → H4 structure

Refs serverpod/serverpod#3919, serverpod/serverpod#4960

To merge only when serverpod/serverpod#4960 is merged

Copy link
Copy Markdown
Collaborator

@marcelomendoncasoares marcelomendoncasoares left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work with the docs! A few suggestions for improvement and also to cover the new migration support that is ongoing at serverpod/serverpod#4989.

Comment thread docs/06-concepts/07-configuration.md Outdated
Comment thread docs/06-concepts/06-database/02-models.md
Comment thread docs/06-concepts/06-database/02-models.md Outdated
Comment thread docs/06-concepts/06-database/02-models.md Outdated
Comment thread docs/06-concepts/06-database/02-models.md Outdated
Comment thread docs/06-concepts/06-database/02-models.md Outdated
Comment thread docs/06-concepts/06-database/04-indexing.md
Copy link
Copy Markdown
Collaborator

@marcelomendoncasoares marcelomendoncasoares left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🚀

Only one small comment, but feel free to fix it and merge directly :)

Comment thread docs/06-concepts/07-configuration.md Outdated
Comment thread docs/06-concepts/06-database/02-models.md
@marcelomendoncasoares marcelomendoncasoares merged commit 6b01796 into serverpod:main Apr 24, 2026
4 checks passed
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.

2 participants