Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 0 additions & 42 deletions documentation/getting-started/web-console/create-table.md

This file was deleted.

10 changes: 9 additions & 1 deletion documentation/getting-started/web-console/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,13 @@ The **Schema Explorer** is the navigation hub for exploring tables and materiali
[Learn more about Schema Explorer →](/docs/getting-started/web-console/schema-explorer)


### Table Details

The **Table Details** panel provides real-time monitoring and detailed metadata for any table or materialized view. It includes health status indicators, WAL ingestion metrics such as pending rows and transaction lag, performance alerts, and a full view of the table's DDL, columns, and storage configuration.

[Learn more about Table Details →](/docs/getting-started/web-console/table-details)


### Result Grid

The **Result Grid** displays your query results in an interactive table format with features for data navigation, export, and visualization.
Expand All @@ -83,8 +90,9 @@ The **Import CSV** interface allows you to upload and import CSV files into Ques

The **Right Sidebar** provides quick access to essential tools and information:
- **Help**: Access quick links and contact options through a convenient help menu
- **AI Assistant**: Open AI Assistant chat window and manage conversations
- **QuestDB News**: Stay up-to-date with the latest QuestDB announcements and updates
- **Create Table**: Build new tables visually using an intuitive interface. Define table structure, configure partitioning, enable WAL, and add columns with their data types—all without writing SQL code. [Learn more about Create Table →](/docs/getting-started/web-console/create-table)
- **Table Details**: Monitor real-time ingestion metrics and health status, view metadata for any table or materialized view.


### Instance Naming
Expand Down
18 changes: 10 additions & 8 deletions documentation/getting-started/web-console/schema-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,21 @@ description: Browse and explore your database structure with the Schema Explorer

import Screenshot from "@theme/Screenshot"

The **Schema Explorer** is the navigation panel on the left side of the Web Console that helps you browse and understand your database structure. It provides a hierarchical view of all tables and materialized views with detailed information about their columns, data types, storage configuration, and relationships.
The **Schema Explorer** is the navigation panel on the left side of the Web Console that helps you browse and understand your database structure. It provides a hierarchical view of all data sources with detailed information about their columns, data types, storage configuration, and relationships.

You can toggle the Schema Explorer by using the database icon on the left.

<Screenshot
alt="Schema Explorer in the Web Console"
src="images/docs/console/schema-explorer.webp"
height={614}
width={383}
height={551}
width={319}

/>

## Tree View

The Schema Explorer displays database objects in an expandable tree structure. When you expand a table or materialized view, the following information is available:
The Schema Explorer displays database objects in an expandable tree structure. When you expand a table, a view, or a materialized view, the following information is available:

### Folders

Expand All @@ -36,22 +36,24 @@ All table columns are displayed with their names and data types, each represente
- **WAL**: Indicates whether Write-Ahead Log is enabled or disabled for the table

:::tip
Table and materialized view icons visually indicate key storage details such as partitioning and WAL status. Hover over these icons to see detailed information including partitioning strategy, ordering configuration, and WAL status, allowing you to quickly assess critical storage details without expanding the full table structure.
Icons of the data sources visually indicate key storage details such as partitioning and WAL status. Hover over these icons to see detailed information including partitioning strategy, ordering configuration, and WAL status, allowing you to quickly assess critical storage details without expanding the full table structure.
:::

#### Base Tables
For materialized views, shows the underlying source tables

### Context Menu
Right-clicking on any table or materialized view opens a context menu with the following actions:
Right-clicking on any data source opens a context menu with the following actions:
<Screenshot
alt="Table context menu for quick actions"
src="images/docs/console/table-context-menu.webp"
height={614}
width={383}
height={150}
width={488}

/>
- **View details**: Opens [Table details panel](/docs/getting-started/web-console/table-details) for viewing detailed information about the data source
- **Copy schema**: Copies the schema of the table to the clipboard
- **Explain schema with AI**: If [AI Assistant](/docs/getting-started/web-console/questdb-ai) is enabled, this action starts a conversation about the schema of the data source
- **Resume WAL**: If WAL is suspended for a table, a warning icon is shown to the right of the table name. You can resume WAL from a specific transaction number by clicking on the context menu item.

:::info
Expand Down
134 changes: 134 additions & 0 deletions documentation/getting-started/web-console/table-details.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
---
title: Table Details
description: Monitor real-time ingestion metrics and health status, and view metadata for tables and materialized views in QuestDB Web Console
---

import Screenshot from "@theme/Screenshot"

The **Table Details** panel provides real-time monitoring and detailed metadata for any table or materialized view. It displays health status, WAL ingestion metrics, performance alerts, and a full view of the table's DDL, columns, and storage configuration.

<Screenshot
alt="Table Details panel in the Web Console"
src="images/docs/console/table-details.webp"
width={463}
height={686}
/>

## Opening Table Details

You can open the Table Details panel by clicking on the information icon next to the table name, or the "View details" context menu option in the [Schema Explorer](/docs/getting-started/web-console/schema-explorer). The panel opens as a drawer on the right side of the Web Console.

## Header

The header displays the following information:

- **Health Status Icon**: Color-coded indicator showing the overall health of the table (green for healthy, orange for warnings, red for critical issues)
- **Table Name**: The name of the table or materialized view, with a copy button
- **Type Badge**: Indicates whether the object is a "Table" or "Materialized View"

The panel is organized into two tabs: **Monitoring** and **Details**.

## Monitoring Tab

The Monitoring tab provides real-time health and ingestion information. It is the default view when opening the panel.

<Screenshot
alt="Table Details Monitoring tab"
src="images/docs/console/monitoring.webp"
width={464}
height={562}
/>

### Critical Error Banners

When critical issues are detected, error banners appear at the top of the tab with actionable options:

- **WAL Suspended**: Shown when Write-Ahead Log operations are suspended. Includes a "Resume WAL" button, an "Ask AI" button, and a link to relevant documentation.
- **Materialized View Invalid**: Shown when a materialized view is in an invalid state. Displays the invalidation reason along with "Ask AI" and documentation links.

### Row Count

Displays the current row count and the last write timestamp. Hover over the timestamp to see the exact ISO timestamp with a copy option.

### Materialized View Status

For materialized views, an additional status section shows:

- **View Status**: Valid, Refreshing, or Invalid
- **Base Table Status**: Valid, Suspended, or Dropped, with a link to navigate to the base table's details

### Ingestion

For WAL-enabled tables, the Ingestion section displays real-time metrics in a two-column grid. This section is collapsible and automatically expands when warnings are detected.

<Screenshot
alt="Table Details ingestion metrics"
src="images/docs/console/ingestion.webp"
width={461}
height={289}
/>

The following metrics are available:

- **Pending Rows**: Rows waiting in WAL to be written to table storage, with a trend indicator (increasing, decreasing, or stable) and rate
- **Transaction Lag**: Number of transactions committed to WAL but not yet applied to table storage, with trend indicator and rate
- **WAL Transaction Number**: Current WAL transaction count
- **Memory Pressure**: Current memory pressure level (None, Reduced Parallelism, or Backoff)
- **Deduped Rows**: Total deduplicated rows since table start
- **Transaction Size (p90)**: 90th percentile transaction size in rows
- **Write Amplification (p50)**: Median write amplification ratio
- **Merge Rate (p99)**: 99th percentile merge rate in rows per second

A pulsing indicator appears when active ingestion is detected.

:::info
For tables without WAL enabled, the Ingestion section displays a "Write-Ahead Log is disabled" status instead of the metrics grid.
:::

### Performance Alerts

When the health check system detects performance issues, alerts are displayed with:

- The issue title and a warning icon
- Current value compared to the optimal value
- An "Ask AI" button for troubleshooting assistance
- A link to the relevant documentation

## Details Tab

The Details tab provides structural information about the data source.

<Screenshot
alt="Table Details tab"
src="images/docs/console/details-section.webp"
width={448}
height={816}
/>

### Base Table

For materialized views, this section shows the base table name with a clickable link to navigate to its details.

### DDL

Displays the DDL (Data Definition Language) statement for the data source.

Available actions:
- **Explain with AI**: Opens an AI chat to explain the schema
- **Copy**: Copies the full DDL to the clipboard
- **Open in Editor**: Opens the DDL in a preview editor tab

### Columns

An expandable list showing all columns with their names and data types. Hover over a column to reveal a copy button for the column name.

### Details

A grid displaying key storage configuration:

| Property | Description |
| --- | --- |
| TTL | Time-to-live value and unit, or "None" |
| Deduplication | Whether deduplication is enabled or disabled |
| Partitioning | Partition strategy of the data source |
| Refresh Type | Refresh mode of a materialized view. See [materialized view refresh docs](/docs/query/sql/refresh-mat-view) for details |
2 changes: 1 addition & 1 deletion documentation/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ module.exports = {
"getting-started/web-console/questdb-ai",
"getting-started/web-console/metrics-view",
"getting-started/web-console/schema-explorer",
"getting-started/web-console/table-details",
"getting-started/web-console/result-grid",
"getting-started/web-console/query-log",
"getting-started/web-console/import-csv",
"getting-started/web-console/create-table",
],
},
],
Expand Down
Binary file removed static/images/docs/console/create-table-tab.webp
Binary file not shown.
Binary file removed static/images/docs/console/create-table.webp
Binary file not shown.
Binary file added static/images/docs/console/details-section.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed static/images/docs/console/import-ui.webp
Binary file not shown.
Binary file added static/images/docs/console/ingestion.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/docs/console/monitoring.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/docs/console/schema-explorer.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/docs/console/table-context-menu.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images/docs/console/table-details.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading