Help Center/ GaussDB(DWS)/ User Guide/ Connecting to a GaussDB(DWS) Cluster/ Using a Visualization Tool to Connect to a GaussDB(DWS) Cluster/ Using the SQL Editor to Connect to a GaussDB(DWS) Cluster/ Overview
Updated on 2024-10-21 GMT+08:00
View PDF
Share

Overview

GaussDB(DWS) provides you with a one-stop data development tool, that is, the online SQL editor, for data development, access, and processing.

The online SQL editor lets you connect to cluster databases on the GaussDB(DWS) console. It shows the database metadata details, runs and edits SQL statements, and displays the results in various charts. It also saves scripts with OBS, which can be set up globally and store SQL statements as text files.

  • This tool is supported only by clusters of version 8.1.3 or later.
  • The editor depends on GaussDB(DWS) and OBS . You need to enable the GaussDB(DWS) cluster query and OBS query operations, and interconnect the editor with the Cloud Trace Service (CTS) service to record traces of operation APIs.

Editor Functions

  • In the upper part of the editor, you can switch the data source, database, and schema.
  • SQL statements can be written in the middle, where highlighting, basic syntax tips, and information about databases, schemas, tables, and fields are provided. For details about the SQL syntax, visit SQL Syntax Reference.
  • You can format SQL statements and query execution plans with this tool. But be careful, the PERFORMANCE execution plan executes SQL statements. So, avoid using it for SQL statements that perform operations.
  • You can click Save after writing many SQL statements. Then a dialog box will ask you to save them to the right OBS bucket.
  • The query results show at the bottom in multiple pages. You can make pie, line, or bar charts from different fields. You can also export the results to an Excel file. The SQL execution records area displays non-query SQL statement records from the past six months.
  • You can switch to the script panel and show the directory folder. The script file is saved in the created directory. For details, see Creating a Directory. The editor allows for two directory levels, each with a capacity of 10 folders. Each folder can hold up to 100 script files, which are stored in the corresponding OBS bucket file directory. To make things easier, the OBS bucket file address can be set globally. For details, see Global Settings..
    Figure 1 SQL editor page