All Products
Search
Document Center

Hologres:Connect to HoloWeb

Last Updated:Feb 05, 2026

HoloWeb is a visual development and database management platform built on Hologres. This topic walks you through the basic workflow for using HoloWeb.

Prerequisites

You have activated a Hologres instance. For more information, see Purchase a Hologres instance.

Procedure

  1. Log on to the Hologres Management Console.

  2. In the navigation pane on the left of the top menu bar, select the desired region.

  3. You can click Go to HoloWeb to go to the HoloWeb development page.

  4. Log on to the Hologres instance.

    1. On the Metadata Management tab, click Instances.

    2. In the Instances dialog box, configure the parameters and click OK.

      Parameter

      Description

      Required

      Network type

      • Public Network: Supported in China (Shanghai), China (Shenzhen), China (Beijing), China (Hangzhou), China (Zhangjiakou), Singapore, China (Hong Kong), Malaysia (Kuala Lumpur), Indonesia (Jakarta), and US (Silicon Valley).

        An instance with the 公网实例 icon uses the public network type.

      • VPC: Only supported in the region where HoloWeb is logged on.

        An instance with the VPC网络 icon uses the VPC type. You cannot edit its details or delete it.

      No

      Instance name

      Select an instance that has been created under your current account.

      Note

      After purchasing an instance, HoloWeb may take time to load the instance information. If the instance name does not appear immediately, manually configure connection details such as the Domain Name to connect to the target instance.

      No

      Name

      If you select an Instance Name, the Name field defaults to the selected instance name. You can also customize the connection name.

      Yes

      Description

      A description for the connection.

      No

      Domain name

      The network domain name of the Hologres instance.

      You can go to the instance details page in the Hologres Management Console and obtain the domain name from the Network Information section.

      If you select an Instance Name, the system automatically fills in the corresponding Domain Name. You can also enter the domain name manually.

      Yes

      Port

      The network port of the Hologres instance.

      You can navigate to the Hologres Management Console instance details page and obtain the port from the Network Information.

      If you select an Instance Name, the system automatically fills in the corresponding Port. You can also enter the port number manually.

      Yes

      Logon method

      • Password-free Logon: Log on directly using your current account without entering a username or password.

      • Password Logon: Enter the username and password of your account or another account to log on.

      Yes

      Username

      This parameter is required only if you set logon method to logon with account and password.

      The AccessKey ID for the current account.

      You can obtain your AccessKey ID from AccessKey Management.

      No

      Password

      This parameter is required only if you set logon method to logon with account and password.

      Enter the AccessKey secret of your current account.

      No

      Test connectivity

      Check whether the connection succeeds:

      • If The test is successful. appears, the connection succeeded.

      • If The test failed. appears, the connection failed.

      No

      Log on after connecting

      Choose whether to log on to the instance after connecting.

      • Yes: The instance logs on and appears in the logged-on instances list on the left.

      • No: The instance appears in the not logged-on instances list on the left.

      Yes

  5. (Optional) Create a database.

    After you activate a Hologres instance, the system automatically creates a postgres database. This database is allocated minimal resources and is intended only for management tasks. To develop business services, create a new database.

    Note

    If you have already created a database, skip this step and create an SQL query.

    1. Click Metadata Management > Database.

      Alternatively, on the Metadata Management page, find the Logged On Instances list. Right-click the target connection and select Create Database.数据库

    2. In the Create Database dialog box, configure the parameters and click OK.新建数据库

      Parameter

      Description

      Instance Name

      The name of the logged-on instance where the current database resides is displayed by default.

      Database Name

      Name the current database.

      Note

      The configured database name must be unique.

      Access Policy

      Configure permissions for the database as needed. For more information about access policies, see:

      Log on Immediately

      • Yes: Use the created database directly after logging on.

      • No: Log on to the database before using it.

  6. Create an SQL query.

    After you connect to the Hologres instance, use standard PostgreSQL syntax to develop in the SQL Editor module.

    1. On the SQL Editor page, click the New SQL query icon.

      Alternatively, in the navigation pane on the left, right-click My SQL Queries and select Create SQL Query. For more information, see SQL window.

    2. On the new Ad-hoc Query page, select the created Instance Name and Database. Then, enter the following sample statements in the SQL editor and click Run.

      BEGIN;
      CREATE TABLE nation (
       n_nationkey bigint NOT NULL,
       n_name text NOT NULL,
       n_regionkey bigint NOT NULL,
       n_comment text NOT NULL,
      PRIMARY KEY (n_nationkey)
      );
      CALL SET_TABLE_PROPERTY('nation', 'bitmap_columns', 'n_nationkey,n_name,n_regionkey');
      CALL SET_TABLE_PROPERTY('nation', 'dictionary_encoding_columns', 'n_name,n_comment');
      CALL SET_TABLE_PROPERTY('nation', 'time_to_live_in_seconds', '31536000');
      COMMIT;
      
      INSERT INTO nation VALUES
      (11,'zRAQ', 4,'nic deposits boost atop the quickly final requests? quickly regula'),
      (22,'RUSSIA', 3  ,'requests against the platelets use never according to the quickly regular pint'),
      (2,'BRAZIL',  1 ,'y alongside of the pending deposits. carefully special packages are about the ironic forges. slyly special '),
      (5,'ETHIOPIA',  0 ,'ven packages wake quickly. regu'),
      (9,'INDONESIA', 2  ,'slyly express asymptotes. regular deposits haggle slyly. carefully ironic hockey players sleep blithely. carefull'),
      (14,'KENYA',  0  ,'pending excuses haggle furiously deposits. pending, express pinto beans wake fluffily past t'),
      (3,'CANADA',  1 ,'eas hang ironic, silent packages. slyly regular packages are furiously over the tithes. fluffily bold'),
      (4,'EGYPT', 4 ,'y above the carefully unusual theodolites. final dugouts are quickly across the furiously regular d'),
      (7,'GERMANY', 3 ,'l platelets. regular accounts x-ray: unusual, regular acco'),
      (20 ,'SAUDI ARABIA',  4 ,'ts. silent requests haggle. closely express packages sleep across the blithely');
      
      SELECT * FROM nation;
      Note

      SQL queries are not case-sensitive for table names and field names. To run a case-sensitive query for a table name, enclose the table name in double quotation marks ("").

    3. In the Result [1] section below the SQL editor, view the execution result of the statement.

      国内运行结果.png

  7. Create a foreign table to accelerate queries of MaxCompute data.

    Hologres seamlessly connects to MaxCompute and lets you create foreign tables to accelerate queries of MaxCompute data. The following steps describe how to create a foreign table in HoloWeb using the visualization feature:

    Note
    • Make sure that you have created a MaxCompute project and that you have created the source table and written data to it. You can perform these operations in one of the following ways:

      1. Use the DataWorks platform. Attach a MaxCompute data source, and then create the table and write data to it.

      2. Use a local client to access MaxCompute to create the table and write data to it.

    • You must log on to a database in HoloWeb before you can use features to accelerate queries of MaxCompute and OSS data lake data.

    1. Click Metadata Management > MaxCompute Query Acceleration > Create Foreign Table.

    2. Configure the parameters in the Create Foreign Table dialog box, select an acceleration mode as needed, and click Submit.

      Whole-database acceleration

      Category

      Parameter

      Description

      Acceleration Method

      Select an acceleration method.

      Hologres supports three acceleration modes:

      • Entire Project

      • Selected Tables

      • Single Table

      Select Entire Project.

      MaxCompute Data Source

      Project Name

      The name of the MaxCompute project.

      Schema Name

      The name of the MaxCompute schema.

      For a MaxCompute project for which schemas are enabled, you can specify the name of any schema in the project for which you have permissions. You do not need to configure this parameter for projects for which schemas are not enabled. For more information about schemas, see Schema operations.

      Destination Table Position

      Holo Schema

      The name of the pattern.

      You can select the default public schema or a new schema.

      Advanced Settings

      Processing Rule for Table Name Conflicts

      Three methods to resolve table name conflicts:

      • Ignore and continue to create other tables

      • Update and modify the table with the same name

      • Report an error and do not create the table again

      Processing Rule for Unsupported Data Types

      Processing is not supported for the following two data types:

      • Report an error and fail the import

      • Ignore and Skip Table of Unsupported Fields

      Partial acceleration

      Category

      Parameter

      Description

      Acceleration Method

      Select an acceleration method.

      Hologres supports three acceleration modes:

      • Entire Project

      • Selected Tables

      • Single Table

      Select Selected Tables.

      MaxCompute Data Source

      Project Name

      The name of the MaxCompute project.

      Schema Name

      The name of the MaxCompute schema.

      For a MaxCompute project for which schemas are enabled, you can specify the name of any schema in the project for which you have permissions. You do not need to configure this parameter for projects for which schemas are not enabled. For more information about schemas, see Schema operations.

      Destination Table Position

      Holo Schema

      The schema name.

      You can select the default public schema or a new schema.

      Advanced Settings

      Processing Rule for Table Name Conflicts

      Three methods to resolve table name conflicts:

      • Ignore and continue to create other tables

      • Update and modify the table with the same name

      • Report an Error and Do Not Create a Duplicate

      Processing Rule for Unsupported Data Types

      Two data types are not supported for processing:

      • Report an error and fail the import

      • Ignore and Skip Table of Unsupported Fields

      Search

      Performs a fuzzy search by table name. A maximum of 200 tables can be displayed.

      Single-table acceleration

      Category

      Parameter

      Description

      Acceleration Method

      Select an acceleration method.

      Hologres supports three acceleration modes:

      • Entire Project

      • Selected Tables

      • Single Table

      Select Single Table.

      MaxCompute Data Source

      Project Name

      The name of the MaxCompute project.

      Schema Name

      The name of the MaxCompute schema.

      For a MaxCompute project for which schemas are enabled, you can specify the name of any schema in the project for which you have permissions. You do not need to configure this parameter for projects for which schemas are not enabled. For more information about schemas, see Schema operations.

      Table Name

      The data table in the corresponding schema of MaxCompute. Fuzzy search based on table name prefixes is supported.

      Destination Hologres Table

      Schema

      The schema name.

      You can select the default public schema or a new schema.

      Table Name

      The name of the single table in Hologres that you want to accelerate.

      Destination Table Description

      The description of the single table in Hologres that you want to accelerate.

    3. After the foreign table is created, in the navigation pane on the left, choose Metadata Management > Logged On Instances. Double-click the destination foreign table. On the page that appears, click Data Preview to accelerate queries of MaxCompute data.

Create an internal table using the visualization feature

HoloWeb provides a one-click table creation feature that lets you create tables without writing SQL commands. The following steps describe how to create a table.

  1. Log on to the Hologres console. In the navigation pane on the left, click Instances to go to the Instances page. Click the instance in the Instance ID/Name column to go to the Instance Details page. In the upper-right corner, click Connect to Instance to go to the HoloWeb page.

  2. In the top menu bar of the HoloWeb page, click Database and select Log On to Database. In the Log On to Database dialog box, select the compute resource attached to the Select a virtual warehouse.. For Select Database, select Existing Database. From the Database Name drop-down list, select the destination database. Then, click OK. After you log on to the database, the HoloWeb page is automatically refreshed.

  3. In the top menu bar of the HoloWeb page, click Metadata Management > Create Table to go to the internal table design page.

    Alternatively, on the Metadata Management page, find the Logged On Instances list. Click the destination database, right-click the destination schema created in the database, and select Create Internal Table.

  4. On the Create Internal Table page, configure the parameters.

    Parameter descriptions (click to expand)

    Category

    Parameter

    Description

    Basic Properties

    Schema

    The schema name.

    You can select the default public schema or a new schema.

    Table Name

    The name of the new Hologres internal table.

    Description

    The description of the new Hologres internal table.

    Fields

    Field Name

    The identifier of each column in the table.

    Data Type

    The type of value for the field.

    Primary Key

    The unique identifier of each row of data in the table.

    Nullable

    Specifies whether the field can be empty.

    Array

    An ordered sequence of elements.

    Description

    The description of the field.

    Operation

    Includes Delete, Up, and Down.

    Properties

    Storage Mode

    Three storage modes are supported: Column-oriented Storage, Row-oriented Storage, and Row-column Storage.

    The default value is Column-oriented Storage.

    Table Data TTL (days)

    The time to live (TTL) is calculated from the time when data is first written. When the TTL is reached, the table data is purged within a period of time. The period of time is not fixed.

    The default TTL is Permanent.

    Binary logging

    Specifies whether to enable binary logging for the table. For more information, see Subscribe to Hologres binary logs.

    Binary logging lifecycle

    The lifecycle of binary logging. For more information, see Subscribe to Hologres binary logs. The default lifecycle is Permanent.

    Distribution Column

    distribution_key. For more information, see Distribution key.

    Segment Column

    event_time_column. For more information, see Event Time Column (Segment Key).

    Clustering Column

    clustering_key. For more information, see Clustering Key.

    Dictionary Encoding Column

    dictionary_encoding_columns. For more information, see Dictionary Encoding.

    Bitmap Column

    bitmap_columns. For more information, see Bitmap Index.

    Partitioned Table

    None

    Select a partition field.

  5. In the upper-right corner of the page, click Submit. After submission, refresh the corresponding schema on the left to view the new internal table.

Manage internal tables in HoloWeb:

  • Edit an internal table

    1. On the Metadata Management page, find the Logged On Instances list and double-click the destination internal table.

    2. On the information page of the internal table, click Edit Table. You can add fields and modify table properties, such as the data lifecycle.

    3. Click Submit.

  • Delete an internal table

    1. On the Metadata Management page, find the Logged On Instances list, right-click the destination internal table, and select Delete Table.

    2. In the Delete Table dialog box, click OK.

  • Preview table data

    1. In the Logged On Instances list, double-click the destination internal table.

    2. Go to the table information tab and click Data Preview to preview the table data.

  • Preview a DDL statement

    On the information tab of the destination table, click DDL Statements to preview the DDL statement.