diff --git a/documentation/getting-started/web-console/create-table.md b/documentation/getting-started/web-console/create-table.md deleted file mode 100644 index 756847d83..000000000 --- a/documentation/getting-started/web-console/create-table.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Create Table -description: Create a new table using QuestDB Web Console user interface ---- - -import Screenshot from "@theme/Screenshot" - -The Web Console provides an interactive interface for creating new tables through the "Create table" tab that can be opened from the right-hand side bar. - - - -The Create table tab allows you to define the table structure, partition settings, WAL configuration, and add columns using an intuitive UI. - - - - -## Actions -- **Remove column**: Removes the last focused column from the schema -- **Insert column above**: Inserts a new column above the last focused column -- **Insert column below**: Inserts a new column below the last focused column -- **Create**: Creates the table with the specified storage details and columns - -## Table settings -You can set the table name from the name input, select the partitioning type, and specify whether WAL is enabled using the respective dropdowns. - -See [WAL](/docs/concepts/write-ahead-log/) and [Partitions](/docs/concepts/partitions/) concepts for more details. - -## Column settings -You can specify the name and [data type](/docs/query/datatypes/overview/) for a column. -- For columns with type `timestamp`, you can specify if the column will be the designated timestamp. -- For columns with type `geohash`, you can specify the [precision](/docs/query/datatypes/geohashes/#specifying-geohash-precision) of the column. - diff --git a/documentation/getting-started/web-console/overview.md b/documentation/getting-started/web-console/overview.md index feb599430..439086c6c 100644 --- a/documentation/getting-started/web-console/overview.md +++ b/documentation/getting-started/web-console/overview.md @@ -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. @@ -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 diff --git a/documentation/getting-started/web-console/schema-explorer.md b/documentation/getting-started/web-console/schema-explorer.md index fa8c63a85..cafe2b7ae 100644 --- a/documentation/getting-started/web-console/schema-explorer.md +++ b/documentation/getting-started/web-console/schema-explorer.md @@ -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. ## 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 @@ -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: +- **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 diff --git a/documentation/getting-started/web-console/table-details.md b/documentation/getting-started/web-console/table-details.md new file mode 100644 index 000000000..f524cdb40 --- /dev/null +++ b/documentation/getting-started/web-console/table-details.md @@ -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. + + + +## 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. + + + +### 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. + + + +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. + + + +### 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 | diff --git a/documentation/sidebars.js b/documentation/sidebars.js index 0a83522d1..e13d3464c 100644 --- a/documentation/sidebars.js +++ b/documentation/sidebars.js @@ -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", ], }, ], diff --git a/static/images/docs/console/create-table-tab.webp b/static/images/docs/console/create-table-tab.webp deleted file mode 100644 index a85f5edb4..000000000 Binary files a/static/images/docs/console/create-table-tab.webp and /dev/null differ diff --git a/static/images/docs/console/create-table.webp b/static/images/docs/console/create-table.webp deleted file mode 100644 index efdeb1176..000000000 Binary files a/static/images/docs/console/create-table.webp and /dev/null differ diff --git a/static/images/docs/console/details-section.webp b/static/images/docs/console/details-section.webp new file mode 100644 index 000000000..7d064b00e Binary files /dev/null and b/static/images/docs/console/details-section.webp differ diff --git a/static/images/docs/console/import-ui.webp b/static/images/docs/console/import-ui.webp deleted file mode 100644 index 45057b432..000000000 Binary files a/static/images/docs/console/import-ui.webp and /dev/null differ diff --git a/static/images/docs/console/ingestion.webp b/static/images/docs/console/ingestion.webp new file mode 100644 index 000000000..5c9d885e6 Binary files /dev/null and b/static/images/docs/console/ingestion.webp differ diff --git a/static/images/docs/console/monitoring.webp b/static/images/docs/console/monitoring.webp new file mode 100644 index 000000000..0734a56ab Binary files /dev/null and b/static/images/docs/console/monitoring.webp differ diff --git a/static/images/docs/console/schema-explorer.webp b/static/images/docs/console/schema-explorer.webp index 917c4cc85..63234e882 100644 Binary files a/static/images/docs/console/schema-explorer.webp and b/static/images/docs/console/schema-explorer.webp differ diff --git a/static/images/docs/console/table-context-menu.webp b/static/images/docs/console/table-context-menu.webp index 6b8921f31..ffae3eee7 100644 Binary files a/static/images/docs/console/table-context-menu.webp and b/static/images/docs/console/table-context-menu.webp differ diff --git a/static/images/docs/console/table-details.webp b/static/images/docs/console/table-details.webp new file mode 100644 index 000000000..9da78a3a6 Binary files /dev/null and b/static/images/docs/console/table-details.webp differ