Skip to content

Expand tables() documentation with snake_case column names#310

Merged
bluestreak01 merged 4 commits intomainfrom
vi_mon
Jan 4, 2026
Merged

Expand tables() documentation with snake_case column names#310
bluestreak01 merged 4 commits intomainfrom
vi_mon

Conversation

@bluestreak01
Copy link
Copy Markdown
Member

@bluestreak01 bluestreak01 commented Dec 31, 2025

Summary

Comprehensive documentation for tables() function with renamed columns using snake_case and semantic prefixes:

Column naming convention

  • Base columns (0-11): Original names preserved (id, table_name, designatedTimestamp, etc.)
  • Table metrics (table_*): table_suspended, table_row_count, table_max_timestamp, table_txn, table_memory_pressure_level, table_write_amp_*, table_merge_rate_*
  • WAL metrics (wal_*): wal_pending_row_count, dedup_row_count_since_start, wal_txn, wal_max_timestamp, wal_tx_count, wal_tx_size_*
  • Replica metrics (replica_*): replica_batch_count, replica_batch_size_*, replica_more_pending

Documentation updates

  • Reorganized column tables by category with clear section headings
  • Updated all SQL examples with new column names
  • Added note to wal_tables() recommending tables() for monitoring
  • Updated monitoring-alerting guide with new column names
  • Fixed broken reference paths after docs restructure

Column mapping (old → new)

Old New
suspended table_suspended
rowCount table_row_count
lastWriteTimestamp table_max_timestamp
writerTxn table_txn
memoryPressureLevel table_memory_pressure_level
pendingRowCount wal_pending_row_count
dedupeRowCount dedup_row_count_since_start
sequencerTxn wal_txn
lastWalTimestamp wal_max_timestamp

Related to: questdb/questdb#6581

Test plan

  • Preview tables() documentation at /docs/query/functions/meta/#tables
  • Verify column tables render correctly with new section headings
  • Check monitoring guide at /docs/operations/monitoring-alerting/#monitor-ingestion-with-sql
  • Verify all SQL examples use correct column names

🤖 Generated with Claude Code

- Add comprehensive column documentation for tables() function including
  new monitoring columns: pendingRowCount, dedupeRowCount, memoryPressureLevel,
  write amplification histograms, merge throughput metrics, and replica stats
- Add practical SQL examples for health dashboards, WAL lag detection,
  memory pressure monitoring, and performance analysis
- Document data precision limitations and tracker configuration
- Add note to wal_tables() recommending tables() for monitoring (in-memory vs disk)
- Remove incorrect all_tables() alias documentation
- Add "Monitor ingestion with SQL" section to monitoring-alerting page
  with key columns summary and health dashboard query

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@github-actions
Copy link
Copy Markdown

github-actions bot commented Dec 31, 2025

🚀 Build success!

Latest successful preview: https://preview-310--questdb-documentation.netlify.app/docs/

Commit SHA: 3aa66a8

📦 Build generates a preview & updates link on each commit.

- Rename columns with table_*, wal_*, replica_* prefixes
- Update column order: base columns, then table metrics, wal metrics, replica metrics
- Update all example SQL queries in meta.md
- Update monitoring-alerting.md with new column names
- Fix broken reference path from /docs/reference/function/meta to /docs/query/functions/meta

Column mapping:
- suspended → table_suspended
- rowCount → table_row_count
- lastWriteTimestamp → table_max_timestamp
- writerTxn → table_txn
- memoryPressureLevel → table_memory_pressure_level
- writeAmplification* → table_write_amp_*
- mergeThroughput* → table_merge_rate_*
- pendingRowCount → wal_pending_row_count
- dedupeRowCount → dedup_row_count_since_start
- sequencerTxn → wal_txn
- lastWalTimestamp → wal_max_timestamp
- txnCount/txnSize* → wal_tx_count/wal_tx_size_*
- replicaBatch* → replica_batch_*
- replicaMorePending → replica_more_pending
@bluestreak01 bluestreak01 changed the title Expand tables() documentation with ingestion monitoring metrics Expand tables() documentation with snake_case column names Jan 2, 2026
@bluestreak01 bluestreak01 merged commit 2496a8c into main Jan 4, 2026
2 checks passed
@bluestreak01 bluestreak01 deleted the vi_mon branch January 4, 2026 19:23
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