Expand tables() documentation with snake_case column names#310
Merged
bluestreak01 merged 4 commits intomainfrom Jan 4, 2026
Merged
Expand tables() documentation with snake_case column names#310bluestreak01 merged 4 commits intomainfrom
bluestreak01 merged 4 commits intomainfrom
Conversation
- 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]>
|
🚀 Build success! Latest successful preview: https://preview-310--questdb-documentation.netlify.app/docs/ Commit SHA: 3aa66a8
|
4 tasks
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive documentation for
tables()function with renamed columns using snake_case and semantic prefixes:Column naming convention
id,table_name,designatedTimestamp, etc.)table_*):table_suspended,table_row_count,table_max_timestamp,table_txn,table_memory_pressure_level,table_write_amp_*,table_merge_rate_*wal_*):wal_pending_row_count,dedup_row_count_since_start,wal_txn,wal_max_timestamp,wal_tx_count,wal_tx_size_*replica_*):replica_batch_count,replica_batch_size_*,replica_more_pendingDocumentation updates
wal_tables()recommendingtables()for monitoringColumn mapping (old → new)
suspendedtable_suspendedrowCounttable_row_countlastWriteTimestamptable_max_timestampwriterTxntable_txnmemoryPressureLeveltable_memory_pressure_levelpendingRowCountwal_pending_row_countdedupeRowCountdedup_row_count_since_startsequencerTxnwal_txnlastWalTimestampwal_max_timestampRelated to: questdb/questdb#6581
Test plan
/docs/query/functions/meta/#tables/docs/operations/monitoring-alerting/#monitor-ingestion-with-sql🤖 Generated with Claude Code