Enable DuckDB for a primary instance

Step 1: Enable DuckDB acceleration

1. Log on to the ApsaraDB RDS console.

2. In the navigation pane on the left, click Instances. In the top navigation bar, select the region where your instance is located.

3. Find the target instance and click its instance ID.

4. Navigate to the DuckDB acceleration page by using one of the following methods:

   • Method 1: At the top of the Instance Details page, click Enable HTAP Acceleration.

   • Method 2: In the Basic Information section of the Instance Details page, find HTAP Acceleration and click Settings.

5. In the HTAP Acceleration Pre-check dialog box, review the prerequisite check results.

   • If all checks pass, click confirm to start enabling DuckDB acceleration.

   • If any checks fail, resolve the issues by following the instructions below:

     • Auto-fixable items: For items that can be fixed automatically, such as Minor Version and Parameter Settings, click confirm. The system automatically performs the required upgrades or configurations.

     • Manual-fix items: For items that require manual intervention, such as Major Version or Instance Resources, refer to the following documentation to perform the required operations. Then, try to enable DuckDB acceleration again.

       • Upgrade major version: Upgrade the major version of an ApsaraDB RDS for PostgreSQL instance

       • Change specifications: Change instance specifications

     

6. Wait for the process to complete. After DuckDB acceleration is enabled, the HTAP Acceleration status changes to Enabled in the Basic Information section of the Instance Details page.

Step 2: Configure columnar storage

After you enable DuckDB acceleration for the primary instance, configure columnar storage for the tables that you want to use for analytical queries by following these steps:

1. Use Data Management Service (DMS) or another database client tool to connect to the target database with a privileged account.

2. Run the following statement to create the rds_duckdb extension:

   CREATE EXTENSION IF NOT EXISTS rds_duckdb;

3. Run the following statement to convert specified tables to columnar storage:

   • Convert a single table:

     SELECT rds_duckdb.create_duckdb_table('your_table_name');

     Note

     Replace TableName with the actual table name. If you need to convert multiple tables, run this command multiple times.

   • Convert multiple tables in a batch:

     SELECT rds_duckdb.create_duckdb_tables('{table_a,table_b,table_c}');

     Note

     Use create_duckdb_tables (the plural form) to convert multiple tables in a batch. The table names must be enclosed in curly braces and separated by commas.