LogoLogo
  • Welcome to e6data
  • Introduction to e6data
    • Concepts
    • Architecture
      • e6data in VPC Deployment Model
      • Connect to e6data serverless compute
  • Get Started
  • Sign Up
  • Setup
    • AWS Setup
      • In VPC Deployment (AWS)
        • Prerequisite Infrastructure
        • Infrastructure & Permissions for e6data
        • Setup Kubernetes Components
        • Setup using Terraform in AWS
          • Update a AWS Terraform for your Workspace
        • AWS PrivateLink and e6data
        • VPC Peering | e6data on AWS
      • Connect to e6data serverless compute (AWS)
        • Workspace Creation
        • Catalog Creation
          • Glue Metastore
          • Hive Metastore
          • Unity Catalog
        • Cluster Creation
    • GCP Setup
      • In VPC Deployment (GCP)
        • Prerequisite Infrastructure
        • Infrastructure & Permissions for e6data
        • Setup Kubernetes Components
        • Setup using Terraform in GCP
        • Update a GCP Terraform for your Workspace
      • Connect to e6data serverless compute (GCP)
    • Azure Setup
      • Prerequisite Infrastructure
      • Infrastructure & Permissions for e6data
      • Setup Kubernetes Components
      • Setup using Terraform in AZURE
        • Update a AZURE Terraform for your Workspace
  • Workspaces
    • Create Workspaces
    • Enable/Disable Workspaces
    • Update a Workspace
    • Delete a Workspace
  • Catalogs
    • Create Catalogs
      • Hive Metastore
        • Connect to a Hive Metastore
        • Edit a Hive Metastore Connection
        • Delete a Hive Metastore Connection
      • Glue Metastore
        • Connect to a Glue Metastore
        • Edit a Glue Metastore Connection
        • Delete a Glue Metastore Connection
      • Unity Catalog
        • Connect to Unity Catalog
        • Edit Unity Catalog
        • Delete Unity Catalog
      • Cross-account Catalog Access
        • Configure Cross-account Catalog to Access AWS Hive Metastore
        • Configure Cross-account Catalog to Access Unity Catalog
        • Configure Cross-account Catalog to Access AWS Glue
        • Configure Cross-account Catalog to Access GCP Hive Metastore
    • Manage Catalogs
    • Privileges
      • Access Control
      • Column Masking
      • Row Filter
  • Clusters
    • Edit & Delete Clusters
    • Suspend & Resume Clusters
    • Cluster Size
    • Load Based Sizing
    • Auto Suspension
    • Query Timeout
    • Monitoring
    • Connection Info
  • Pools
    • Delete Pools
  • Query Editor
    • Editor Pane
    • Results Pane
    • Schema Explorer
    • Data Preview
  • Notebook
    • Editor Pane
    • Results Pane
    • Schema Explorer
    • Data Preview
  • Query History
    • Query Count API
  • Connectivity
    • IP Sets
    • Endpoints
    • Cloud Resources
    • Network Firewall
  • Access Control
    • Users
    • Groups
    • Roles
      • Permissions
      • Policies
    • Single Sign-On (SSO)
      • AWS SSO
      • Okta
      • Microsoft My Apps-SSO
      • Icons for IdP
    • Service Accounts
    • Multi-Factor Authentication (Beta)
  • Usage and Cost Management
  • Audit Log
  • User Settings
    • Profile
    • Personal Access Tokens (PAT)
  • Advanced Features
    • Cross-Catalog & Cross-Schema Querying
  • Supported Data Types
  • SQL Command Reference
    • Query Syntax
      • General functions
    • Aggregate Functions
    • Mathematical Functions & Operators
      • Arithematic Operators
      • Rounding and Truncation Functions
      • Exponential and Root Functions
      • Trigonometric Functions
      • Logarithmic Functions
    • String Functions
    • Date-Time Functions
      • Constant Functions
      • Conversion Functions
      • Date Truncate Function
      • Addition and Subtraction Functions
      • Extraction Functions
      • Format Functions
      • Timezone Functions
    • Conditional Expressions
    • Conversion Functions
    • Window Functions
    • Comparison Operators & Functions
    • Logical Operators
    • Statistical Functions
    • Bitwise Functions
    • Array Functions
    • Regular Expression Functions
    • Generate Functions
    • Cardinality Estimation Functions
    • JSON Functions
    • Checksum Functions
    • Unload Function (Copy into)
    • Struct Functions
  • Equivalent Functions & Operators
  • Connectors & Drivers
    • DBeaver
    • DbVisualiser
    • Apache Superset
    • Jupyter Notebook
    • Tableau Cloud
    • Tableau Desktop
    • Power BI
    • Metabase
    • Zeppelin
    • Python Connector
      • Code Samples
    • JDBC Driver
      • Code Samples
      • API Support
    • Configure Cluster Ingress
      • ALB Ingress in Kubernetes
      • GCE Ingress in Kubernetes
      • Ingress-Nginx in Kubernetes
  • Security & Trust
    • Best Practices
      • AWS Best Practices
    • Features & Responsibilities Matrix
    • Data Protection Addendum(DPA)
  • Tutorials and Best Practices
    • How to configure HIVE metastore if you don't have one?
    • How-To Videos
  • Known Limitations
    • SQL Limitations
    • Other Limitations
    • Restart Triggers
    • Cloud Provider Limitations
  • Error Codes
    • General Errors
    • User Account Errors
    • Workspace Errors
    • Catalog Errors
    • Cluster Errors
    • Data Governance Errors
    • Query History Errors
    • Query Editor Errors
    • Pool Errors
    • Connectivity Errors
  • Terms & Condition
  • Privacy Policy
    • Cookie Policy
  • FAQs
    • Workspace Setup
    • Security
    • Catalog Privileges
  • Services Utilised for e6data Deployment
    • AWS supported regions
    • GCP supported regions
    • AZURE supported regions
  • Release Notes & Updates
    • 6th Sept 2024
    • 6th June 2024
    • 18th April 2024
    • 9th April 2024
    • 30th March 2024
    • 16th March 2024
    • 14th March 2024
    • 12th March 2024
    • 2nd March 2024
    • 10th February 2024
    • 3rd February 2024
    • 17th January 2024
    • 9th January 2024
    • 3rd January 2024
    • 18th December 2023
    • 12th December 2023
    • 9th December 2023
    • 4th December 2023
    • 27th November 2023
    • 8th September 2023
    • 4th September 2023
    • 26th August 2023
    • 21st August 2023
    • 19th July 2023
    • 23rd May 2023
    • 5th May 2023
    • 28th April 2023
    • 19th April 2023
    • 15th April 2023
    • 10th April 2023
    • 30th March 2023
Powered by GitBook
On this page
  • Tabs
  • Managing Tabs
  • Additional Features
  • Query Action Bar
  • Run a Query
  • Stop a Query
  • Select Catalog
  • Select Database
  • Select Cluster
  • Format Query
  • Save Query
  • SQL Query Editor
  • Selectively Run Queries
  • Auto-Completion
  • Find & Replace
  • Error Highlighting
  1. Query Editor

Editor Pane

This page explains the features and functionalities of the Editor Pane in e6data's Query Editor.

PreviousQuery EditorNextResults Pane

Last updated 1 year ago

The must be assigned to each user who needs access to the Query Editor, including SuperAdmins.

Please be sure to use it cautiously, as it provides access to .

The Editor Pane consists of three parts:

Tabs

Queries can be written, edited, and run in multiple tabs to organize work.

Managing Tabs

Naming Tabs

The names of tabs can be changed by double-clicking the existing tab name.

Ordering Tabs

Tabs can be dragged and moved to change their order. This lets users customize the Editor Pane to suit their workflow. Each user's tab order will be auto-saved for future sessions.

Adding Tabs

To open multiple editor tabs, click the plus sign after the last tab.

Deleting Tabs

Hover over any tab and click the X to delete a tab.

Additional Features

Click the kebab menu (three dots) option to access additional features. The features available are :

Keyboard Shortcuts

You can access these shortcuts by clicking the kebab menu (three dots) option and then the 'Keyboard Shortcuts' button. They can also be accessed by pressing the 'F1' key.

The following shortcuts are available for the specified actions.

Action
Shortcut

Run Query

<cmd> + enter

Abort Query

<cmd> + esc

Find and Replace

<cmd> + f

Format Query

<cmd> + shift + o

Show/Hide Result

<option> + shift + t

Undo

<cmd> + z

Redo

<cmd> + shift + z

Show keyboard Shortcuts

F1

Format Query

This feature is used to beautify the SQL query in the currently active tab. In the case of lengthy query text, the formatting process may require some time, during which a progress bar will be displayed to indicate the formatting status.

Duplicate

This feature duplicates the current tab, preserving the executed queries only. The results will not be copied to the new tab.

Query Action Bar

Run a Query

If the Cluster used to run the query is suspended, the user will be asked for consent to resume the Cluster before the query is run.

A query can be run from the editor in two ways:

  • Click the Run button

  • Press Cmd + Enter

If multiple queries are run and there is an error in any query, the execution of all queries will be aborted and no results will be displayed.

The query containing the error will be highlighted in red.

Stop a Query

When a query is running the Run button will change to Cancel. Click Cancel to stop any running query.

Set Default LIMITs

A default LIMIT can be set to prevent inadvertently running queries without a defined LIMIT, which may incur high infrastructure costs.

To set a LIMIT, click the drop-down arrow next to the Run button and select the desired limit.

The LIMIT options are:

  1. NO LIMIT: The query will run till all results are available.

  2. LIMIT 10: The query will stop executing after the first 10 results are available.

  3. LIMIT 100: The query will stop executing after the first 100 results are available.

  4. LIMIT 1000: The query will stop executing after the first 1000 results are available.

Select Catalog

Select from the list of attached catalogs, which should be used.

Select Database

Select from the list of databases inside the selected catalog.

Select Cluster

Set the cluster that should be used to execute queries.

Format Query

Click the <|> (Format Query) button to beautify the SQL query in the currently active tab.

Save Query

You can save a query for future use by clicking the Save button.

SQL Query Editor

The SQL query text should be entered in the SQL Query Editor.

Selectively Run Queries

Although multiple queries can be written in the same tab, if a user wants to run only one query, simply place the cursor on the line containing the query (before the :), prior to clicking Run.

If the cursor is on the last line of the SQL Query Editor, only the last query will be run.

Queries can also be commented out using standard SQL syntax -- (single-line comments) or /* */ (multi-line comments).

Auto-Completion

As you type a query, the SQL editor suggests commands and functions, suggesting various ways to finish the command or function you've started. To select a proposal, hit the Tab key to accept it, or keep typing to dismiss the dialogue window.

Find & Replace

The Find & Replace feature can search or replace strings that match a pattern in the query text.

Open Find & Replace

Press CMD + F (MacOS) or CTRL + F (Windows) to bring up the search dialog.

Find

  • Type the string to search for in the Search for... field.

  • The search will start highlighting matches when the first character is entered.

  • Use the < and > buttons to toggle between appearances of the search string.

  • Click the All button to highlight all appearances of the search string.

Replace & Replace All

  • Click the + button to open the Replace field.

  • Type the string to search for in the Search for... field.

  • Enter the string that should replace the search string in the Replace with... field.

  • Click Replace to replace only the current selected instance of the search string, or click All to replace all instances.

Regular Expression (RegExp) Search

  • Click the .* button to enable the RegExp search feature.

  • Enter the regular expression to search for in the Search for... field.

Case-sensitive Search

  • Click the Aa button to toggle on case sensitivity in search.

Whole Word Search

  • Click the \b button to toggle on Whole Word Search, this will return only complete matches to the search string.

Search in Selection

  • Click the S button to toggle on Search in Selection which only searches within the lines selected by the user.

Error Highlighting

Error highlighting helps identify and rectify errors in the queries. In case of any error, the line or query paragraph containing the error will be highlighted in the query editor.

By default, all queries in a tab are run and the results of the last query will be displayed in the .

To run only one query, see .

The Query Editor will display only the first 10,000 results. To access more than 10,000 rows use an

external connector.
Tabs
Query Action Bar
SQL Query Editor
Result Pane
Selectively Run Queries
DataAnalyst role
read potentially sensitive data
Editor pane of the Query Editor
Find & Replace Feature