Developer Template GFM Verified6 Columns · 6 Sample Rows

Relational Database Table DDL Schema Markdown Table Template

Document database tables, column names, SQL types, nullability, keys (PK/FK), default values, and column semantics.

Primary Use Case: Database migration READMEs, data dictionary wikis, backend architecture documentation.

Interactive Template Customizer

Edit cells, add rows, or sort — changes update the markdown live
Quick Start:
#
1
`id`
UUID
PK
gen_random_uuid()
2
organization_id
UUID
FK
References organizations(id) ON DELETE CASCADE
3
email
VARCHAR(255)
UNIQUE
4
role
VARCHAR(50)
"member"
Permission tier (admin, member, guest)
5
is_verified
BOOLEAN
false
6
created_at
TIMESTAMPTZ
INDEX
NOW()
Flavor:
Style:
| Column Name       | Data Type      |   Key    | Nullable |       Default Value | Description                                      |
| :---------------- | :------------- | :------: | :------: | ------------------: | :----------------------------------------------- |
| **`id`**          | `UUID`         |   `PK`   |    No    | `gen_random_uuid()` | Globally unique row identifier                   |
| `organization_id` | `UUID`         |   `FK`   |    No    |                   — | References `organizations(id)` ON DELETE CASCADE |
| `email`           | `VARCHAR(255)` | `UNIQUE` |    No    |                   — | Normalized lowercase user email address          |
| `role`            | `VARCHAR(50)`  |   None   |    No    |          `"member"` | Permission tier (`admin`, `member`, `guest`)     |
| `is_verified`     | `BOOLEAN`      |   None   |    No    |             `false` | True once user completes email confirmation      |
| `created_at`      | `TIMESTAMPTZ`  | `INDEX`  |    No    |             `NOW()` | UTC creation timestamp                           |
Convert document (PDF, Word, PPTX) → MDConverter
Rendered Preview
GitHub Flavored Markdown style
Column NameData TypeKeyNullableDefault ValueDescription
`id`UUIDPKNogen_random_uuid()Globally unique row identifier
organization_idUUIDFKNoReferences organizations(id) ON DELETE CASCADE
emailVARCHAR(255)UNIQUENoNormalized lowercase user email address
roleVARCHAR(50)NoneNo"member"Permission tier (admin, member, guest)
is_verifiedBOOLEANNoneNofalseTrue once user completes email confirmation
created_atTIMESTAMPTZINDEXNoNOW()UTC creation timestamp

Column Architecture & Alignment Specification

Carefully chosen column alignments ensure optimal visual scannability across desktop and mobile screens:

Column HeaderAlignmentDelimiter SyntaxDesign Rationale
Column Nameleft:---Standard left-aligned readable text & descriptions
Data Typeleft:---Standard left-aligned readable text & descriptions
Keycenter:---:Centers compact status symbols, flags, or tags
Nullablecenter:---:Centers compact status symbols, flags, or tags
Default Valueright---:Aligns numeric scale, defaults, or magnitudes
Descriptionleft:---Standard left-aligned readable text & descriptions

Pro Tips for Relational Database Table DDL Schema

  • Center-align key markers (`PK`, `FK`, `INDEX`, `UNIQUE`).
  • Use standard SQL types (`VARCHAR(255)`, `BIGINT`, `TIMESTAMPTZ`).
  • Bold primary key column names for instant visual scanning.

How to Deploy This Table Across Platforms

GitHub README & PRs

Paste raw Markdown into README.md. Leave one blank newline above and below for GFM compliance.

Obsidian PKM Vaults

Paste directly into Live Preview mode. Use wikilinks ([[Note]]) inside cells for bidirectional linking.

Notion Workspaces

Press Enter to make a fresh empty line block, then paste. Notion auto-transforms it into a native Simple Table block.

Docusaurus & VitePress

Standard GFM tables work out of the box in modern MDX engines. You can style them via custom CSS selectors.

Raw GFM Code

| Column Name       | Data Type      |   Key    | Nullable |       Default Value | Description                                      |
| :---------------- | :------------- | :------: | :------: | ------------------: | :----------------------------------------------- |
| **`id`**          | `UUID`         |   `PK`   |    No    | `gen_random_uuid()` | Globally unique row identifier                   |
| `organization_id` | `UUID`         |   `FK`   |    No    |                   — | References `organizations(id)` ON DELETE CASCADE |
| `email`           | `VARCHAR(255)` | `UNIQUE` |    No    |                   — | Normalized lowercase user email address          |
| `role`            | `VARCHAR(50)`  |   None   |    No    |          `"member"` | Permission tier (`admin`, `member`, `guest`)     |
| `is_verified`     | `BOOLEAN`      |   None   |    No    |             `false` | True once user completes email confirmation      |
| `created_at`      | `TIMESTAMPTZ`  | `INDEX`  |    No    |             `NOW()` | UTC creation timestamp                           |

Standard padded style with boundary pipes matching GitHub GFM parser specifications.

Platform Support

GitHub (GFM)✓ 100% Native
GitLab (GLFM)✓ 100% Native
Obsidian Vault✓ 100% Native
Notion Workspace✓ Paste as Table
Slack & DiscordIn Code Block

Syntax Formatting Rules

  • Pipe Escaping: Use \| for text with pipe symbols.
  • Multi-line Cells: Use <br> for line breaks.
  • Monospace Text: Wrap variables or code in backticks (`key`).
  • Empty Values: Use instead of leaving cells empty.
Template Knowledge Base

Frequently Asked Questions About Relational Database Table DDL Schema

How should I format parameters, flags, or keys in this Relational Database Table DDL Schema table?

Wrap variable names in the "Column Name" column in backticks (e.g., `**id**`). This enforces monospace rendering, prevents underscores from italicizing surrounding text, and improves readability across GitHub and developer documentation sites.

Where in my repository or project documentation should I place this Relational Database Table DDL Schema table?

This template is specifically designed for database migration readmes, data dictionary wikis, backend architecture documentation. Place it inside your project's README.md, technical wiki, or developer portal. Always leave at least one blank newline before and after the table to ensure the GFM parser detects it properly.

Why is the "Column Name" column styled with left alignment?

The "Column Name" column functions as the primary key of this table. Setting it to left alignment establishes an anchor along the left reading margin, making it effortless for developers to scan down the list.

How do I add line breaks inside a single cell of this Relational Database Table DDL Schema table?

Standard Markdown table rows cannot contain literal carriage returns. To create a multi-line list inside a cell, insert HTML <br> tags (e.g. "Item 1<br>Item 2<br>Item 3"). This keeps the entire entry in a single clean row without breaking column alignments.

How do I handle optional or missing values in Relational Database Table DDL Schema?

Never leave table cells completely empty, as some strict Markdown parsers may collapse empty pipes. Instead, insert an em-dash ("—"), "N/A", or "None" to explicitly indicate that a value is not applicable.

Can I export this Relational Database Table DDL Schema table into CSV, Excel, or HTML?

Yes. In the interactive toolkit above, you can edit your data and use our integrated export tools to convert this table directly into CSV, JSON, HTML <table>, or LaTeX with a single click.