Skip to content

Conversation

@carlagn
Copy link
Contributor

@carlagn carlagn commented Oct 14, 2025

Fixes #DC-5297

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive guide to PostgreSQL data types, covering common types, special types (JSON/JSONB, UUID, enums, networking, geometric), input/output formats, precision, constraints, indexing notes, and guidance on choosing types, with references.
    • Fixed minor spacing/formatting issues in glossary entries (Read-through caching, Right join) to improve readability.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 14, 2025

Dangerous URL check

No absolute URLs to prisma.io/docs found.
No local URLs found.

@github-actions
Copy link
Contributor

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

  • This PR does not change any pages in a way that would require a redirect.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 14, 2025

Walkthrough

Adds a new PostgreSQL data types documentation page and makes minor spacing adjustments in the database glossary MDX.

Changes

Cohort / File(s) Summary of Changes
Dataguide docs
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/02-introduction-to-data-types.mdx, content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx
Introduces a comprehensive PostgreSQL data types guide covering numeric, character, boolean, date/time, special types, formats, and guidance; adjusts spacing in two glossary entries without semantic changes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Pre-merge checks

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title Check ❓ Inconclusive The title “feat: DC-5297 Migrate page #2” includes the ticket reference but is too generic and does not specify which documentation pages are being migrated, making it difficult for reviewers to understand the primary change at a glance. Please revise the title to clearly describe the content being migrated, for example “Migrate Database Glossary and Data Types pages (DC-5297)”, so that the main change is immediately understandable.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8233430 and 4ef968a.

📒 Files selected for processing (2)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/02-introduction-to-data-types.mdx (1 hunks)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx
🧰 Additional context used
🪛 LanguageTool
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/02-introduction-to-data-types.mdx

[style] ~11-~11: Consider a more concise word here.
Context: ...e to the requirements that they outline in order to be accepted by PostgreSQL. While it is ...

(IN_ORDER_TO_PREMIUM)


[style] ~60-~60: To reduce wordiness, try specifying a number or using “many” or “numerous” instead.
Context: ...reSQL data types PostgreSQL comes with a large number of types built-in to the software itself. ...

(LARGE_NUMBER_OF)


[grammar] ~64-~64: Use a hyphen to join words.
Context: ...geometric.html#id-1.5.7.16.5) is purpose built to store and validate exactly this...

(QB_NEW_EN_HYPHEN)


[grammar] ~76-~76: There might be a mistake here.
Context: ... | | ------------ | ------- | -------------...

(QB_NEW_EN)


[grammar] ~77-~77: There might be a mistake here.
Context: ...-------------------------------------- | | integer | 4 bytes | -2147483648 t...

(QB_NEW_EN)


[grammar] ~78-~78: Use a hyphen to join words.
Context: ...ype to use as it represents a good trade off between storage and expressiveness f...

(QB_NEW_EN_HYPHEN)


[style] ~82-~82: This phrase is redundant. Consider using “outside”.
Context: ...limited by their valid range. Any value outside of the range will result in an error. In ...

(OUTSIDE_OF)


[style] ~86-~86: ‘new records’ might be wordy. Consider a shorter alternative.
Context: ... in an internally tracked sequence when new records are added. So if the last integer used ...

(EN_WORDINESS_PREMIUM_NEW_RECORDS)


[grammar] ~108-~108: Use a hyphen to join words.
Context: ...omponents). For example, if you need a 5 digit whole number, you can specify: ``...

(QB_NEW_EN_HYPHEN)


[locale-violation] ~114-~114: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...umber of digits using the scale number. Afterwards, it will check whether the complete rou...

(AFTERWARDS_US)


[grammar] ~124-~124: There might be a mistake here.
Context: ...ded value | Accepted (fits precision)? | | ----------- | ------------- | --------...

(QB_NEW_EN)


[grammar] ~125-~125: There might be a mistake here.
Context: ...--------- | -------------------------- | | 400.28080 | 400.28 | Yes ...

(QB_NEW_EN)


[grammar] ~126-~126: There might be a mistake here.
Context: ...28 | Yes | | 8.332799 | 8.33 | Yes ...

(QB_NEW_EN)


[grammar] ~127-~127: There might be a mistake here.
Context: ... | Yes | | 11799.799 | 11799.80 | No ...

(QB_NEW_EN)


[grammar] ~128-~128: There might be a mistake here.
Context: ...9.80 | No | | 11799 | 11799 | Yes ...

(QB_NEW_EN)


[grammar] ~129-~129: There might be a mistake here.
Context: ...9 | Yes | | 2802.27 | 2802.27 | No ...

(QB_NEW_EN)


[grammar] ~134-~134: Use a hyphen to join words.
Context: ... | ### Floating point Floating point numbers are another way to express...

(QB_NEW_EN_HYPHEN)


[grammar] ~134-~134: Use a hyphen to join words.
Context: ... consistent precision. Instead, floating point types only have a concept of a max...

(QB_NEW_EN_HYPHEN)


[grammar] ~136-~136: Use a hyphen to join words.
Context: ...dware. For example, to limit a floating point column to 8 digits of precision, y...

(QB_NEW_EN_HYPHEN)


[grammar] ~142-~142: Use a hyphen to join words.
Context: ...ecause of these design choices, floating point numbers can work with numbers with...

(QB_NEW_EN_HYPHEN)


[grammar] ~142-~142: There might be a mistake here.
Context: ...ing point numbers can work with numbers with large number of decimals efficiently, b...

(QB_NEW_EN)


[grammar] ~142-~142: Use a hyphen to join words.
Context: ...or when comparing values, doing floating point math, or performing operations tha...

(QB_NEW_EN_HYPHEN)


[grammar] ~146-~146: Use a hyphen to join words.
Context: ...loating point) vs numeric Both floating point numbers provided by types like `fl...

(QB_NEW_EN_HYPHEN)


[style] ~152-~152: The word ‘anyways’ is informal American English. Did you mean “anyway”?
Context: ...ary (for example, if they'll be rounded anyways) and when speed is highly valuable. Var...

(ANYWAYS)


[style] ~166-~166: ‘in spite of’ might be wordy. Consider a shorter alternative.
Context: ...mance for simple use cases, however, so in spite of these constraints, it can still be valu...

(EN_WORDINESS_PREMIUM_IN_SPITE_OF)


[grammar] ~182-~182: Use a hyphen to join words.
Context: ...on, the char column will store a fixed length character string equal to the num...

(QB_NEW_EN_HYPHEN)


[grammar] ~190-~190: There might be a mistake here.
Context: ... | # of stored characters | | ------ | --------------------- | -----...

(QB_NEW_EN)


[grammar] ~191-~191: There might be a mistake here.
Context: ...------------- | ---------------------- | | 'tree' | 4 | 'tree...

(QB_NEW_EN)


[grammar] ~196-~196: Use a hyphen to join words.
Context: ...lly desirable. The alternative to fixed length character fields are variable len...

(QB_NEW_EN_HYPHEN)


[grammar] ~196-~196: Use a hyphen to join words.
Context: ...xed length character fields are variable length fields. For this, PostgreSQL prov...

(QB_NEW_EN_HYPHEN)


[grammar] ~210-~210: There might be a mistake here.
Context: ... Stored value | # of stored characters | | ------ | --------------------- | -----...

(QB_NEW_EN)


[grammar] ~211-~211: There might be a mistake here.
Context: ... ------------ | ---------------------- | | 'tree' | 4 | 'tree...

(QB_NEW_EN)


[style] ~232-~232: ‘In keeping with’ might be wordy. Consider a shorter alternative.
Context: ...rue and false values: BOOLEAN In keeping with [SQL standards](https://en.wikipedia.or...

(EN_WORDINESS_PREMIUM_IN_KEEPING_WITH)


[style] ~239-~239: Qualifiers like “somewhat” can weaken your message and make your writing sound uncertain. Consider removing it or choosing an alternative to sound more confident.
Context: ...own. As mentioned above, PostgreSQL is somewhat flexible on boolean input values, but s...

(SOMEWHAT)


[grammar] ~259-~259: Use a hyphen to join words.
Context: ...to store. Some formats are based on well known standards, while others are colloq...

(QB_NEW_EN_HYPHEN)


[grammar] ~259-~259: Use a hyphen to join words.
Context: ...are colloquial formats used in many real world contexts. The full range of input...

(QB_NEW_EN_HYPHEN)


[style] ~263-~263: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...could be interpreted as either July 12, 2019 or December 07, 2019 depending on forma...

(MISSING_COMMA_AFTER_YEAR)


[style] ~263-~263: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...as either July 12, 2019 or December 07, 2019 depending on format), you can set the e...

(MISSING_COMMA_AFTER_YEAR)


[style] ~267-~267: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...wikipedia.org/wiki/ISO_8601). March 18, 2009 would be represented as 2009-03-18. -...

(MISSING_COMMA_AFTER_YEAR)


[grammar] ~267-~267: There might be a mistake here.
Context: ...09 would be represented as 2009-03-18. - SQL: The traditional SQL date format. ...

(QB_NEW_EN)


[style] ~268-~268: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ... traditional SQL date format. March 18, 2009 would be represented as 03/18/2009. -...

(MISSING_COMMA_AFTER_YEAR)


[style] ~269-~269: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...Mirrors ISO format for dates. March 18, 2009 would be represented as 2009-03-18. -...

(MISSING_COMMA_AFTER_YEAR)


[grammar] ~269-~269: There might be a mistake here.
Context: ...09 would be represented as 2009-03-18. - German: The German regional style. Mar...

(QB_NEW_EN)


[style] ~270-~270: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...*: The German regional style. March 18, 2009 would be represented as 18.03.2009. ...

(MISSING_COMMA_AFTER_YEAR)


[style] ~278-~278: Consider using a different adjective in this context to strengthen your wording.
Context: ...type, covered in the next section, is a good alternative that provides the date comp...

(GOOD_ALTERNATIVE)


[style] ~305-~305: This phrase is redundant. Consider writing “moment” or “time”.
Context: ...e and time used to represent a specific moment in time, in two different variations: with and ...

(MOMENT_IN_TIME)


[style] ~329-~329: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...ing values for timestamptz fields are exactly the same as for timestamp but with the additio...

(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)


[style] ~335-~335: This phrase is redundant. Consider writing “point” or “time”.
Context: ...://en.wikipedia.org/wiki/ISO_8601). The point in time of 04:28 PM and 52 seconds on March 18,...

(MOMENT_IN_TIME)


[style] ~335-~335: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...of 04:28 PM and 52 seconds on March 18, 2009 in Eastern Standard Time would be repre...

(MISSING_COMMA_AFTER_YEAR)


[style] ~336-~336: This phrase is redundant. Consider writing “point” or “time”.
Context: ...*: The traditional SQL date format. The point in time of 04:28 PM and 52 seconds on March 18,...

(MOMENT_IN_TIME)


[style] ~336-~336: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...of 04:28 PM and 52 seconds on March 18, 2009 in Eastern Standard Time would be repre...

(MISSING_COMMA_AFTER_YEAR)


[style] ~337-~337: This phrase is redundant. Consider writing “point” or “time”.
Context: ...at used by the Unix date command. The point in time of 04:28 PM and 52 seconds on March 18,...

(MOMENT_IN_TIME)


[style] ~337-~337: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...of 04:28 PM and 52 seconds on March 18, 2009 in Eastern Standard Time would be repre...

(MISSING_COMMA_AFTER_YEAR)


[style] ~338-~338: This phrase is redundant. Consider writing “point” or “time”.
Context: ...erman**: The German regional style. The point in time of 04:28 PM and 52 seconds on March 18,...

(MOMENT_IN_TIME)


[style] ~338-~338: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...of 04:28 PM and 52 seconds on March 18, 2009 in Eastern Standard Time would be repre...

(MISSING_COMMA_AFTER_YEAR)


[style] ~398-~398: The word ‘greater’ tends to be overused in this context. Consider an alternative.
Context: ... used to represent intervals that use a greater number of fields. There are two separate input...

(A_GREAT_NUMBER)


[grammar] ~402-~402: There might be a mistake here.
Context: ...nt of the following fields: - Years - Months - Weeks - Days - Ho...

(QB_NEW_EN)


[grammar] ~403-~403: There might be a mistake here.
Context: ...lowing fields: - Years - Months - Weeks - Days - Hours - Min...

(QB_NEW_EN)


[grammar] ~404-~404: There might be a mistake here.
Context: ...s: - Years - Months - Weeks - Days - Hours - Minutes - S...

(QB_NEW_EN)


[grammar] ~405-~405: There might be a mistake here.
Context: ...ears - Months - Weeks - Days - Hours - Minutes - Seconds You...

(QB_NEW_EN)


[grammar] ~406-~406: There might be a mistake here.
Context: ...onths - Weeks - Days - Hours - Minutes - Seconds You may notice ...

(QB_NEW_EN)


[grammar] ~407-~407: There might be a mistake here.
Context: ...eks - Days - Hours - Minutes - Seconds You may notice that M is ...

(QB_NEW_EN)


[grammar] ~410-~410: There might be a mistake here.
Context: ...ears before the T, it is interpreted as months; if it occurs after the T, it means minu...

(QB_NEW_EN)


[locale-violation] ~428-~428: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...ths are separated by a dash: YYYY-MM. Afterwards, day and time components are represente...

(AFTERWARDS_US)


[grammar] ~435-~435: Use a hyphen to join words.
Context: ...seful. ### Does PostgreSQL support user defined types? PostgreSQL supports user...

(QB_NEW_EN_HYPHEN)


[grammar] ~437-~437: Use a hyphen to join words.
Context: ...defined types? PostgreSQL supports user defined types in a few different ways. ...

(QB_NEW_EN_HYPHEN)


[grammar] ~441-~441: Use a hyphen to join words.
Context: ...values. This functions similar to a drop down menu in that a choice can be made f...

(QB_NEW_EN_HYPHEN)


[locale-violation] ~450-~450: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...egory, as well as the possible values. Afterwards, you can define a column to be of the `...

(AFTERWARDS_US)


[grammar] ~457-~457: Use a hyphen to join words.
Context: ... table: SEASON #### Other user defined types Other types can also be d...

(QB_NEW_EN_HYPHEN)


[style] ~463-~463: Consider using a different adverb to strengthen your wording.
Context: ... types:** Base types are used to define a completely new type of data that isn't reliant on ...

(COMPLETELY_ENTIRELY)


[style] ~463-~463: Consider a more expressive alternative.
Context: ...reliant on modifying existing types. To do this, you'll need to code up type funct...

(DO_ACHIEVE)


[style] ~467-~467: Consider a more concise word here.
Context: ...hey are used in many different contexts in order to assign a global identifier that is extr...

(IN_ORDER_TO_PREMIUM)


[style] ~493-~493: This phrase is redundant. Consider using “outside”.
Context: ...pe-json.html#id-1.5.7.22.19). These are outside of the scope of this guide, but will be co...

(OUTSIDE_OF)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Check internal links
  • GitHub Check: runner / linkspector
  • GitHub Check: Cloudflare Pages

Comment @coderabbitai help to get the list of available commands and usage tips.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 14, 2025

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4ef968a
Status: ✅  Deploy successful!
Preview URL: https://02267204.docs-51g.pages.dev
Branch Preview URL: https://feat-dc-5297-dataguide-migra.docs-51g.pages.dev

View logs

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2b7c440 and c83beb6.

📒 Files selected for processing (2)
  • content/200-orm/800-more/600-help-and-troubleshooting/dataguide/200-introduction-to-data-types.mdx (1 hunks)
  • content/200-orm/800-more/600-help-and-troubleshooting/dataguide/index.mdx (1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Documentation Checks
content/200-orm/800-more/600-help-and-troubleshooting/dataguide/index.mdx

[error] 2-2: Unknown word 'Dataguide'.


[error] 3-3: Unknown word 'Dataguide'.


[error] 14-14: Unknown word 'Dataguide'.

content/200-orm/800-more/600-help-and-troubleshooting/dataguide/200-introduction-to-data-types.mdx

[error] 6-6: Unknown word 'justinellingwood'.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Check internal links
  • GitHub Check: runner / linkspector

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

♻️ Duplicate comments (1)
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx (1)

2-14: Fix spelling pipeline failure for “Dataguide”.

Docs lint is still blocking the PR because “Dataguide” (Lines 2, 3, 14) isn’t in the accepted dictionary. Please either align the wording with existing usage (for example, “Data Guide”) or add “Dataguide” to the shared dictionary before merging.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c83beb6 and 86f4601.

📒 Files selected for processing (3)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (1 hunks)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/200-introduction-to-data-types.mdx (1 hunks)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/200-introduction-to-data-types.mdx
🧰 Additional context used
🪛 GitHub Actions: Documentation Checks
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx

[error] 2-2: CSpell: Unknown word 'Dataguide'.


[error] 3-3: CSpell: Unknown word 'Dataguide'.


[error] 14-14: CSpell: Unknown word 'Dataguide'.

content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx

[error] 5-5: CSpell: Unknown word 'justinellingwood'.


[error] 43-43: CSpell: Unknown word 'BCNF'.


[error] 43-43: CSpell: Unknown word 'multivalued'.


[error] 135-135: CSpell: Unknown word 'BCNF'.


[error] 136-136: CSpell: Unknown word 'BCNF'.


[error] 136-136: CSpell: Unknown word 'Boyce'.


[error] 136-136: CSpell: Unknown word 'Codd'.


[error] 215-215: CSpell: Unknown word 'superkey'.


[error] 690-690: CSpell: Unknown word 'HTAP'.


[error] 691-691: CSpell: Unknown word 'HTAP'.


[error] 897-897: CSpell: Unknown word 'Multiversion'.


[error] 897-897: CSpell: Unknown word 'MVCC'.


[error] 898-898: CSpell: Unknown word 'Multiversion'.


[error] 898-898: CSpell: Unknown word 'MVCC'.


[error] 900-900: CSpell: Unknown word 'MVCC'.


[error] 901-901: CSpell: Unknown word 'MVCC'.


[error] 958-958: CSpell: Unknown word 'Nonrepeatable'.


[error] 959-959: CSpell: Unknown word 'nonrepeatable'.


[error] 960-960: CSpell: Unknown word 'nonrepeatable'.


[error] 975-975: CSpell: Unknown word 'OLAP'.


[error] 976-976: CSpell: Unknown word 'OLAP'.


[error] 978-978: CSpell: Unknown word 'OLAP'.


[error] 984-984: CSpell: Unknown word 'OLTP'.


[error] 985-985: CSpell: Unknown word 'OLTP'.


[error] 987-987: CSpell: Unknown word 'OLTP'.


[error] 989-989: CSpell: Unknown word 'OLTP'.


[error] 1000-1000: CSpell: Unknown word 'mismatc'.


[error] 1010-1010: CSpell: Unknown word 'contro'.


[error] 1010-1010: CSpell: Unknown word 'fix:'.


[error] 1059-1059: CSpell: Unknown word 'contro'.


[error] 1059-1059: CSpell: Unknown word 'fix:'.


[error] 1152-1152: CSpell: Unknown word 'leve'.


[error] 1157-1157: CSpell: Unknown word 'Nonrepeatable'.


[error] 1176-1176: CSpell: Unknown word 'leve'.


[error] 1180-1180: CSpell: Unknown word 'nonrepeatable'.


[error] 1217-1217: CSpell: Unknown word 'RDBMS'.


[error] 1218-1218: CSpell: Unknown word 'RDBMS'.


[error] 1219-1219: CSpell: Unknown word 'RDBMS'.


[error] 1221-1221: CSpell: Unknown word 'RDBMS'.


[error] 1223-1223: CSpell: Unknown word 'leve'.


[error] 1227-1227: CSpell: Unknown word 'nonrepeatable'.


[error] 1340-1340: CSpell: Unknown word 'leve'.


[error] 1343-1343: CSpell: Unknown word 'nonrepeatable'.


[error] 1428-1428: CSpell: Unknown word 'Superkey'.


[error] 1429-1429: CSpell: Unknown word 'superkey'.


[error] 1432-1432: CSpell: Unknown word 'superkey'.


[error] 1433-1433: CSpell: Unknown word 'superkey'.

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Check internal links
  • GitHub Check: runner / linkspector

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 4

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ba55688 and 4f35217.

📒 Files selected for processing (1)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Check internal links
  • GitHub Check: runner / linkspector

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4f35217 and 54b9437.

📒 Files selected for processing (2)
  • src/theme/DocCard/index.tsx (1 hunks)
  • src/theme/DocCard/styles.module.scss (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Check internal links
  • GitHub Check: runner / linkspector
🔇 Additional comments (1)
src/theme/DocCard/styles.module.scss (1)

44-46: LGTM! Minor note on redundancy.

The .cardDescription class with max-width: 100% is applied correctly. Note that block-level elements like <p> already have this as default behavior, so this may be redundant. However, it's harmless and may serve as defensive styling to ensure consistent layout.

@carlagn carlagn force-pushed the feat/DC-5297-dataguide-migration-2 branch from 54b9437 to 9021a66 Compare October 14, 2025 10:45
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

♻️ Duplicate comments (6)
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/02-introduction-to-data-types.mdx (2)

278-279: Replace the nonexistent data type reference.

PostgreSQL’s time-with-time-zone variant is timestamptz/timestamp with time zone; timezonetz is not a valid identifier. Line 278 should point readers to timestamptz to keep the guidance accurate.

-For times that require a time zone component, the `timezonetz` type, covered in the next section, is a good alternative that provides the date component context.
+For times that require a time zone component, the `timestamptz` type, covered in the next section, is a good alternative that provides the date component context.

318-319: Show the correct timestamptz declaration.

Line 318 repeats the plain TIMESTAMP (3) example, omitting the required WITH TIME ZONE. Readers will copy the wrong syntax. Please include the full TIMESTAMP (3) WITH TIME ZONE.

-TIMESTAMP (3)
+TIMESTAMP (3) WITH TIME ZONE
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (4)

420-426: Tighten the “Data type” definition wording.

The sentences still read “during when” and “are also help,” making the definition clumsy. Please apply the earlier correction so the prose flows cleanly.

-Data types allow you to specify expectations and requirements about your data during when defining a field or container. The programming language or application can then validate that introduced data meets the necessary criteria. Data types are also help determine the available operations that can be performed on a piece of data.
+Data types allow you to specify expectations and requirements about your data when defining a field or container. The programming language or application can then validate that introduced data meets the necessary criteria. Data types also help determine the available operations that can be performed on a piece of data.

1037-1043: Clarify the parameterized query sentence.

The phrase “has been to take user input” is still malformed. Please adopt the earlier wording so the definition clearly explains that prepared statements accept parameters instead of concatenated SQL.

-A parameterized query, also known as a prepared statement, is a database query that has been to take user input as parameters instead of by concatenating strings with user input.
+A parameterized query, also known as a prepared statement, is a database query that is designed to take user input as parameters instead of concatenating strings with user input.

1259-1266: Fix the RBAC acronym in the heading.

The heading still says “RBA” even though the text (correctly) uses RBAC. Align the heading so readers see the standard RBAC abbreviation.

-#### Role-based access control (RBA)
+#### Role-based access control (RBAC)

1466-1470: Clean up the “Token” entry grammar.

“Recognized to the system” and “it’s type” remain. Updating them to “recognized by the system” and “its type” keeps the entry professional.

-In natural language processing and full-text search, a token is a discrete word that is recognized to the system and can be categorized according to different features. A token might be stored with information including its relative position in a piece of text, it's type (number, word, phrase, etc.), as well as any additional metadata that might be useful.
+In natural language processing and full-text search, a token is a discrete word that is recognized by the system and can be categorized according to different features. A token might be stored with information including its relative position in a piece of text, its type (number, word, phrase, etc.), as well as any additional metadata that might be useful.
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 54b9437 and 9021a66.

📒 Files selected for processing (4)
  • cSpell.json (1 hunks)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/02-introduction-to-data-types.mdx (1 hunks)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/050-database-glossary.mdx (1 hunks)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/index.mdx
  • cSpell.json
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: runner / linkspector
  • GitHub Check: Check internal links
  • GitHub Check: Cloudflare Pages

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

♻️ Duplicate comments (2)
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/02-introduction-to-data-types.mdx (2)

278-280: Replace the incorrect timezonetz reference.

PostgreSQL doesn’t expose a timezonetz type; the time-with-zone variant you describe next is timestamptz (timestamp with time zone). Please fix the identifier and link text to avoid misleading readers.

-PostgreSQL does not recommend using `time with time zone`, the `time` type's variant that pairs a time zone with the clock time. This is due to complications and ambiguities that arise that cannot be resolved without additional context, like an associated date. For times that require a time zone component, the `timezonetz` type, covered in the next section, is a good alternative that provides the date component context.
+PostgreSQL does not recommend using `time with time zone`, the `time` type's variant that pairs a time zone with the clock time. This is due to complications and ambiguities that arise that cannot be resolved without additional context, like an associated date. For times that require a time zone component, the `timestamptz` type (timestamp with time zone), covered in the next section, is a good alternative that provides the date component context.

318-319: Fix the timestamptz declaration snippet.

The sample meant to show timestamp with time zone still repeats TIMESTAMP (3) and omits the WITH TIME ZONE clause, so readers would create the wrong type. Please correct the snippet.

-TIMESTAMP (3)
+TIMESTAMP (3) WITH TIME ZONE
🧹 Nitpick comments (1)
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/02-introduction-to-data-types.mdx (1)

72-73: Clarify the integer storage sentence.

The sentence drops “less,” which makes it read incorrectly. Add it back so the guidance is clear.

-Integer types with smaller ranges of acceptable values take up space than those with wider ranges.
+Integer types with smaller ranges of acceptable values take up less space than those with wider ranges.
📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9021a66 and 1d9501c.

📒 Files selected for processing (1)
  • content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/02-introduction-to-data-types.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
content/200-orm/800-more/600-help-and-troubleshooting/050-dataguide/02-introduction-to-data-types.mdx

[style] ~11-~11: Consider a more concise word here.
Context: ...e to the requirements that they outline in order to be accepted by PostgreSQL. While it is ...

(IN_ORDER_TO_PREMIUM)


[style] ~60-~60: To reduce wordiness, try specifying a number or using “many” or “numerous” instead.
Context: ...reSQL data types PostgreSQL comes with a large number of types built-in to the software itself. ...

(LARGE_NUMBER_OF)


[grammar] ~64-~64: Use a hyphen to join words.
Context: ...geometric.html#id-1.5.7.16.5) is purpose built to store and validate exactly this...

(QB_NEW_EN_HYPHEN)


[grammar] ~76-~76: There might be a mistake here.
Context: ... | | ------------ | ------- | -------------...

(QB_NEW_EN)


[grammar] ~77-~77: There might be a mistake here.
Context: ...-------------------------------------- | | integer | 4 bytes | -2147483648 t...

(QB_NEW_EN)


[grammar] ~78-~78: Use a hyphen to join words.
Context: ...ype to use as it represents a good trade off between storage and expressiveness f...

(QB_NEW_EN_HYPHEN)


[style] ~82-~82: This phrase is redundant. Consider using “outside”.
Context: ...limited by their valid range. Any value outside of the range will result in an error. In ...

(OUTSIDE_OF)


[style] ~86-~86: ‘new records’ might be wordy. Consider a shorter alternative.
Context: ... in an internally tracked sequence when new records are added. So if the last integer used ...

(EN_WORDINESS_PREMIUM_NEW_RECORDS)


[grammar] ~108-~108: Use a hyphen to join words.
Context: ...omponents). For example, if you need a 5 digit whole number, you can specify: ``...

(QB_NEW_EN_HYPHEN)


[locale-violation] ~114-~114: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...umber of digits using the scale number. Afterwards, it will check whether the complete rou...

(AFTERWARDS_US)


[grammar] ~124-~124: There might be a mistake here.
Context: ...ded value | Accepted (fits precision)? | | ----------- | ------------- | --------...

(QB_NEW_EN)


[grammar] ~125-~125: There might be a mistake here.
Context: ...--------- | -------------------------- | | 400.28080 | 400.28 | Yes ...

(QB_NEW_EN)


[grammar] ~126-~126: There might be a mistake here.
Context: ...28 | Yes | | 8.332799 | 8.33 | Yes ...

(QB_NEW_EN)


[grammar] ~127-~127: There might be a mistake here.
Context: ... | Yes | | 11799.799 | 11799.80 | No ...

(QB_NEW_EN)


[grammar] ~128-~128: There might be a mistake here.
Context: ...9.80 | No | | 11799 | 11799 | Yes ...

(QB_NEW_EN)


[grammar] ~129-~129: There might be a mistake here.
Context: ...9 | Yes | | 2802.27 | 2802.27 | No ...

(QB_NEW_EN)


[grammar] ~134-~134: Use a hyphen to join words.
Context: ... | ### Floating point Floating point numbers are another way to express...

(QB_NEW_EN_HYPHEN)


[grammar] ~134-~134: Use a hyphen to join words.
Context: ... consistent precision. Instead, floating point types only have a concept of a max...

(QB_NEW_EN_HYPHEN)


[grammar] ~136-~136: Use a hyphen to join words.
Context: ...dware. For example, to limit a floating point column to 8 digits of precision, y...

(QB_NEW_EN_HYPHEN)


[grammar] ~142-~142: Use a hyphen to join words.
Context: ...ecause of these design choices, floating point numbers can work with numbers with...

(QB_NEW_EN_HYPHEN)


[grammar] ~142-~142: There might be a mistake here.
Context: ...ing point numbers can work with numbers with large number of decimals efficiently, b...

(QB_NEW_EN)


[grammar] ~142-~142: Use a hyphen to join words.
Context: ...or when comparing values, doing floating point math, or performing operations tha...

(QB_NEW_EN_HYPHEN)


[grammar] ~146-~146: Use a hyphen to join words.
Context: ...loating point) vs numeric Both floating point numbers provided by types like `fl...

(QB_NEW_EN_HYPHEN)


[style] ~152-~152: The word ‘anyways’ is informal American English. Did you mean “anyway”?
Context: ...ary (for example, if they'll be rounded anyways) and when speed is highly valuable. Var...

(ANYWAYS)


[style] ~166-~166: ‘in spite of’ might be wordy. Consider a shorter alternative.
Context: ...mance for simple use cases, however, so in spite of these constraints, it can still be valu...

(EN_WORDINESS_PREMIUM_IN_SPITE_OF)


[grammar] ~182-~182: Use a hyphen to join words.
Context: ...on, the char column will store a fixed length character string equal to the num...

(QB_NEW_EN_HYPHEN)


[grammar] ~190-~190: There might be a mistake here.
Context: ... | # of stored characters | | ------ | --------------------- | -----...

(QB_NEW_EN)


[grammar] ~191-~191: There might be a mistake here.
Context: ...------------- | ---------------------- | | 'tree' | 4 | 'tree...

(QB_NEW_EN)


[grammar] ~196-~196: Use a hyphen to join words.
Context: ...lly desirable. The alternative to fixed length character fields are variable len...

(QB_NEW_EN_HYPHEN)


[grammar] ~196-~196: Use a hyphen to join words.
Context: ...xed length character fields are variable length fields. For this, PostgreSQL prov...

(QB_NEW_EN_HYPHEN)


[grammar] ~210-~210: There might be a mistake here.
Context: ... Stored value | # of stored characters | | ------ | --------------------- | -----...

(QB_NEW_EN)


[grammar] ~211-~211: There might be a mistake here.
Context: ... ------------ | ---------------------- | | 'tree' | 4 | 'tree...

(QB_NEW_EN)


[style] ~232-~232: ‘In keeping with’ might be wordy. Consider a shorter alternative.
Context: ...rue and false values: BOOLEAN In keeping with [SQL standards](https://en.wikipedia.or...

(EN_WORDINESS_PREMIUM_IN_KEEPING_WITH)


[style] ~239-~239: Qualifiers like “somewhat” can weaken your message and make your writing sound uncertain. Consider removing it or choosing an alternative to sound more confident.
Context: ...own. As mentioned above, PostgreSQL is somewhat flexible on boolean input values, but s...

(SOMEWHAT)


[grammar] ~259-~259: Use a hyphen to join words.
Context: ...to store. Some formats are based on well known standards, while others are colloq...

(QB_NEW_EN_HYPHEN)


[grammar] ~259-~259: Use a hyphen to join words.
Context: ...are colloquial formats used in many real world contexts. The full range of input...

(QB_NEW_EN_HYPHEN)


[style] ~263-~263: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...could be interpreted as either July 12, 2019 or December 07, 2019 depending on forma...

(MISSING_COMMA_AFTER_YEAR)


[style] ~263-~263: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...as either July 12, 2019 or December 07, 2019 depending on format), you can set the e...

(MISSING_COMMA_AFTER_YEAR)


[style] ~267-~267: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...wikipedia.org/wiki/ISO_8601). March 18, 2009 would be represented as 2009-03-18. -...

(MISSING_COMMA_AFTER_YEAR)


[grammar] ~267-~267: There might be a mistake here.
Context: ...09 would be represented as 2009-03-18. - SQL: The traditional SQL date format. ...

(QB_NEW_EN)


[style] ~268-~268: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ... traditional SQL date format. March 18, 2009 would be represented as 03/18/2009. -...

(MISSING_COMMA_AFTER_YEAR)


[style] ~269-~269: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...Mirrors ISO format for dates. March 18, 2009 would be represented as 2009-03-18. -...

(MISSING_COMMA_AFTER_YEAR)


[grammar] ~269-~269: There might be a mistake here.
Context: ...09 would be represented as 2009-03-18. - German: The German regional style. Mar...

(QB_NEW_EN)


[style] ~270-~270: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...*: The German regional style. March 18, 2009 would be represented as 18.03.2009. ...

(MISSING_COMMA_AFTER_YEAR)


[style] ~278-~278: Consider using a different adjective in this context to strengthen your wording.
Context: ...type, covered in the next section, is a good alternative that provides the date comp...

(GOOD_ALTERNATIVE)


[style] ~305-~305: This phrase is redundant. Consider writing “moment” or “time”.
Context: ...e and time used to represent a specific moment in time, in two different variations: with and ...

(MOMENT_IN_TIME)


[style] ~329-~329: ‘exactly the same’ might be wordy. Consider a shorter alternative.
Context: ...ing values for timestamptz fields are exactly the same as for timestamp but with the additio...

(EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)


[style] ~335-~335: This phrase is redundant. Consider writing “point” or “time”.
Context: ...://en.wikipedia.org/wiki/ISO_8601). The point in time of 04:28 PM and 52 seconds on March 18,...

(MOMENT_IN_TIME)


[style] ~335-~335: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...of 04:28 PM and 52 seconds on March 18, 2009 in Eastern Standard Time would be repre...

(MISSING_COMMA_AFTER_YEAR)


[grammar] ~335-~335: There might be a mistake here.
Context: ...QL uses a space to delimit these fields. - SQL: The traditional SQL date format. ...

(QB_NEW_EN)


[style] ~336-~336: This phrase is redundant. Consider writing “point” or “time”.
Context: ...*: The traditional SQL date format. The point in time of 04:28 PM and 52 seconds on March 18,...

(MOMENT_IN_TIME)


[style] ~336-~336: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...of 04:28 PM and 52 seconds on March 18, 2009 in Eastern Standard Time would be repre...

(MISSING_COMMA_AFTER_YEAR)


[style] ~337-~337: This phrase is redundant. Consider writing “point” or “time”.
Context: ...at used by the Unix date command. The point in time of 04:28 PM and 52 seconds on March 18,...

(MOMENT_IN_TIME)


[style] ~337-~337: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...of 04:28 PM and 52 seconds on March 18, 2009 in Eastern Standard Time would be repre...

(MISSING_COMMA_AFTER_YEAR)


[style] ~338-~338: This phrase is redundant. Consider writing “point” or “time”.
Context: ...erman**: The German regional style. The point in time of 04:28 PM and 52 seconds on March 18,...

(MOMENT_IN_TIME)


[style] ~338-~338: Some style guides suggest that commas should set off the year in a month-day-year date.
Context: ...of 04:28 PM and 52 seconds on March 18, 2009 in Eastern Standard Time would be repre...

(MISSING_COMMA_AFTER_YEAR)


[style] ~398-~398: The word ‘greater’ tends to be overused in this context. Consider an alternative.
Context: ... used to represent intervals that use a greater number of fields. There are two separate input...

(A_GREAT_NUMBER)


[grammar] ~402-~402: There might be a mistake here.
Context: ...nt of the following fields: - Years - Months - Weeks - Days - Ho...

(QB_NEW_EN)


[grammar] ~403-~403: There might be a mistake here.
Context: ...lowing fields: - Years - Months - Weeks - Days - Hours - Min...

(QB_NEW_EN)


[grammar] ~404-~404: There might be a mistake here.
Context: ...s: - Years - Months - Weeks - Days - Hours - Minutes - S...

(QB_NEW_EN)


[grammar] ~405-~405: There might be a mistake here.
Context: ...ears - Months - Weeks - Days - Hours - Minutes - Seconds You...

(QB_NEW_EN)


[grammar] ~406-~406: There might be a mistake here.
Context: ...onths - Weeks - Days - Hours - Minutes - Seconds You may notice ...

(QB_NEW_EN)


[grammar] ~407-~407: There might be a mistake here.
Context: ...eks - Days - Hours - Minutes - Seconds You may notice that M is ...

(QB_NEW_EN)


[grammar] ~410-~410: There might be a mistake here.
Context: ...ears before the T, it is interpreted as months; if it occurs after the T, it means minu...

(QB_NEW_EN)


[locale-violation] ~428-~428: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...ths are separated by a dash: YYYY-MM. Afterwards, day and time components are represente...

(AFTERWARDS_US)


[grammar] ~435-~435: Use a hyphen to join words.
Context: ...seful. ### Does PostgreSQL support user defined types? PostgreSQL supports user...

(QB_NEW_EN_HYPHEN)


[grammar] ~437-~437: Use a hyphen to join words.
Context: ...defined types? PostgreSQL supports user defined types in a few different ways. ...

(QB_NEW_EN_HYPHEN)


[grammar] ~441-~441: Use a hyphen to join words.
Context: ...values. This functions similar to a drop down menu in that a choice can be made f...

(QB_NEW_EN_HYPHEN)


[locale-violation] ~450-~450: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...egory, as well as the possible values. Afterwards, you can define a column to be of the `...

(AFTERWARDS_US)


[grammar] ~457-~457: Use a hyphen to join words.
Context: ... table: SEASON #### Other user defined types Other types can also be d...

(QB_NEW_EN_HYPHEN)


[style] ~463-~463: Consider using a different adverb to strengthen your wording.
Context: ... types:** Base types are used to define a completely new type of data that isn't reliant on ...

(COMPLETELY_ENTIRELY)


[style] ~463-~463: Consider a more expressive alternative.
Context: ...reliant on modifying existing types. To do this, you'll need to code up type funct...

(DO_ACHIEVE)


[style] ~467-~467: Consider a more concise word here.
Context: ...hey are used in many different contexts in order to assign a global identifier that is extr...

(IN_ORDER_TO_PREMIUM)


[style] ~493-~493: This phrase is redundant. Consider using “outside”.
Context: ...pe-json.html#id-1.5.7.22.19). These are outside of the scope of this guide, but will be co...

(OUTSIDE_OF)

mhartington
mhartington previously approved these changes Oct 14, 2025
coderabbitai[bot]
coderabbitai bot previously approved these changes Oct 15, 2025
@carlagn carlagn force-pushed the feat/DC-5297-dataguide-migration-2 branch from 8233430 to 4ef968a Compare October 15, 2025 08:00
@carlagn carlagn merged commit a48ae21 into main Oct 15, 2025
8 checks passed
@carlagn carlagn deleted the feat/DC-5297-dataguide-migration-2 branch October 15, 2025 08:13
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.

3 participants