Help Center/ GaussDB(DWS)/ Management Guide/ SQL Editor Development Tool/ Overview
Updated on 2024-09-05 GMT+08:00
View PDF

Overview

GaussDB(DWS) is based on the open-source PG ecosystem. DAS is a common cloud tool for cluster connection. But DAS works with many engines and uses open-source parts. So, GaussDB(DWS) does not have full syntax compatibility with DAS, which can cause some function issues and make it hard to adapt to DAS. GaussDB(DWS) only allows users to perform cluster O&M operations. To use the clusters for data access, development, and processing, they need cloud services. But each service has limited functions. So, GaussDB(DWS) gives users the online SQL editor, a one-stop data development tool that can do data development, access, and processing. The online SQL editor makes GaussDB(DWS) more competitive.

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.

  • This tool is supported only by clusters of version 8.1.3 or later.
  • The editor depends on GaussDB(DWS). You need to enable the GaussDB(DWS) cluster 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.
  • 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