Skip to content

Yellowbrick

Overview

This guide provides instructions on how to set up and use Yellowbrick with Team Edition.

Before you start, you must start creating a connection in Team Edition and select Yellowbrick. If you haven’t done this yet, see our Create Connection article.

Yellowbrick specialty

Yellowbrick is a high-performance, cloud-native data warehouse built for complex analytics at scale. It’s optimized for fast SQL execution on large volumes of data, making it ideal for enterprise workloads that demand speed and concurrency.

Yellowbrick is based on PostgreSQL, so it supports standard SQL and offers compatibility with PostgreSQL clients, drivers, and tools. You can run complex queries using familiar syntax, with low-latency results even on billions of rows.

It integrates easily with BI tools, ETL pipelines, and existing data ecosystems. Yellowbrick supports hybrid deployments - on-premises, in the cloud, or both - and includes features for workload management, high availability, and enterprise-grade security.

Info

For more, see the Yellowbrick documentation.

Setting Up

This section explains how to configure a direct connection in Team Edition and set up secure connections using SSH, proxies, SSL, and other available network configurations.

Yellowbrick connection settings

In this subsection, we will outline the settings for establishing a direct connection to a Yellowbrick database using Team Edition. Correctly configuring your connection ensures seamless interaction between Team Edition and your Yellowbrick database.

  1. The Main tab of the connection settings requires you to fill in specific fields to establish the initial connection.

    Field Description
    Connect by (Host/URL) Choose whether you want to connect using a host or a URL.
    URL If you are connecting via URL, enter the URL of your Yellowbrick database here. This field is hidden if you are connecting via the host.
    Host If you are connecting via host, enter the host address of your Yellowbrick database here.
    Database Enter the name of the Yellowbrick database you want to connect to.
    Show all databases (Enabled by default) Displays all databases in the database navigator.
    Note: This option works only when the Host connection type is selected. It does not work when connecting via URL.
    Port Enter the port number for your Yellowbrick database. The default Yellowbrick port is 5432.
    Authentication Choose the type of authentication you want to use for the connection. For detailed guides on authentication types, please refer to the following articles:

    - Native Database Authentication
    - DBeaver Profile Authentication
    - Kerberos Authentication
    - PgPass Authentication
    - SSPI Authentication (Windows SSO)
    Connection Details Provide additional connection details if necessary.
    Driver Name This field will be auto-filled based on your selected driver type.
    Driver Settings If there are any specific driver settings, configure them here.

  2. The Advanced tab of the connection settings offers additional options that allow you to customize your further connection to the Yellowbrick database.

    Field Description
    Session Role This option allows you to define a specific role that your database session assumes upon connection. Setting a session role can be useful for managing permissions and access control within your Yellowbrick database.
    Local Client Specify the local client, see our article about local client configuration.
    Show template databases Displays template databases. This option is available when Show all databases is checked.
    Show databases unavailable for connection Show databases not available for connection in database list. This option is available when Show all databases is checked.
    Show databases statistics Displays statistics for databases.
    Read all data types Reads all data types from the server (including arrays).
    Read table keys with columns Enable reading table constraints during the column reading stage to ensure accurate recognition of keys. Note that this setting may decrease metadata loading performance.
    Replace legacy timezone Replaces legacy timezone settings. Enable only if you need to connect with legacy timezones like Europe/Kyiv or Asia/Calcutta. Only these two timezones are affected.
    Show $$ quote as Displays $$ quotes as code blocks or strings.
    Show $tagName$ quote as Displays $tagName$ quotes as code blocks or strings.

Connection details

The Connection Details section in Team Edition allows for further customization of your Yellowbrick connection. This includes options for adjusting the Navigator View, setting up Security measures, applying Filters, configuring Connection Initialization settings, and setting up Shell Commands. Each of these settings can significantly impact your database operations and workflow. For detailed guides on these settings, please refer to the following articles:

Yellowbrick driver properties

The settings for Yellowbrick Driver properties enable you to adjust the performance of the Yellowbrick JDBC and ODBC driver. These adjustments can influence the efficiency, compatibility, and features of your Yellowbrick database.

You can customize the Yellowbrick driver in Team Edition via the Edit Driver page, accessible by clicking on the Driver Settings button on the first page of the driver settings. This page offers a range of settings that can influence your Yellowbrick database connections. For a comprehensive guide on these settings, please refer to our Database drivers article.

Secure Connection Configurations

Team Edition supports secure connections to your Yellowbrick database. Guidance on configuring such connections, specifically SSH, Proxy, Kubernetes, AWS SSM and SSL connections, can be found in various referenced articles. For a comprehensive understanding, please refer to these articles:

Secure Storage with Secret Providers

Team Edition supports various cloud-based secret providers to retrieve database credentials. For detailed setup instructions, see Secret Providers.

Powering Yellowbrick with Team Edition

Team Edition provides a host of features designed for Yellowbrick databases. This includes the ability to view schemas, along with numerous unique capabilities aimed at optimizing database operations.

Yellowbrick database objects

Team Edition lets you view and manipulate a wide range of Yellowbrick database objects. Team Edition has extensive support for various Yellowbrick metadata types, allowing you to interact with a wide variety of database objects, such as:

  • Databases
    • Schemas
      • Tables
        • Columns
        • Constraints
        • Foreign Keys
      • Foreign Tables
      • Views
      • Materialized Views
      • Sequences
      • Data types
      • Aggregate functions
    • Extensions
    • Storage
    • Tablespaces
    • Roles
  • Administer
    • Jobs
    • Session Manager
    • Lock Manager

Yellowbrick features in Team Edition

Team Edition is not limited to typical SQL tasks. It also supports advanced features available in Yellowbrick, many of which extend PostgreSQL compatibility. These include:

Category Feature
Data types Support for arrays, ranges, network, JSON, and GIS-style types (geography, etc.)
Extensions Built-in support for extensions like pgcrypto, plpgsql, plpythonu
Collations Wide range of locale-based collations (C, POSIX, utf8, regional variants)
Storage Tablespaces management (pg_default, pg_global)

Additional features compatible with Yellowbrick, but not exclusive to it:

Category Feature
Data Transfer Data Import
Data Export
Session Management Session Manager
Lock Management Lock Manager
Backup and Restore How to Backup/Restore data
Schema Management Schema Compare
Data Visualization GIS Guide
ERD Guide