MySQL HeatWave User Guide

4.3.9.4 Use PAR to Load Data Manually

To load data manually using pre-authenticated requests (PAR), review the following examples for different ways to set them up.

This topic contains the following sections:

Before You Begin
Types of PARs

You can create the following types of PARs:

  • Bucket or prefix PAR: This type of PAR ends with /o/. You can load multiple files with this PAR. You can also use name, prefix, or pattern parameters to specify files in the bucket or Object Storage folder.

  • Object PAR: This type of PAR ends with /o/object_name. This PAR specifies individual files. You cannot use name, prefix, or pattern parameters with this PAR.

PAR Recommendations

When creating PARs consider the following recommendations:

  • Only use read-only PARs.

  • Set a short expiration date for the PAR URL that matches the data loading plan.

  • Do not make a PAR URL publicly accessible.

  • If the target defines a bucket or uses a prefix or pattern:

    • Use Enable Object Listing when creating the PAR in the Oracle Cloud Infrastructure (OCI) console.

    • When creating the PAR from the command line, include the --access-type AnyObjectRead parameter.

Note

Use a resource principal for access to more sensitive data in Object Storage as it is more secure. See Access Object Storage with Resource Principals.

PAR Parameters

To set up PARs, you configure the following parameters:

  • par: Provide the PAR URL.

  • name: Use this to specify a file for an object or bucket PAR.

  • pattern: Use this to set a regular expression that defines a set of Object Storage files. The pattern follows the modified Modified ECMAScript regular expression grammar.

  • prefix: Use this to define a set of Object Storage folders and files.

PAR Examples

The following examples use these parameters and commands to set up the loading of data with PARs. Replace the values in the examples with your own.

  • SET @input_list creates a session variable that stores all the parameters for the loading of the file.

  • db_name identifies the database name to store the table. MySQL HeatWave automatically creates the database if it does not exist.

  • table_name sets the table name to store the data. MySQL HeatWave automatically creates the table if it does not exist.

  • engine_attribute defines the parameters of the external file.

  • dialect defines the format options of the file.

  • file defines the file or files to load.

Note

If you are on MySQL 9.1.2 and earlier, you need to update dialect with the field delimiter and record delimiter parameters. As of MySQL 9.2.0, MySQL HeatWave Lakehouse can automatically detect these values. See Lakehouse External Table Syntax to learn more.

To review all syntax options for loading external files, see Auto Parallel Load Syntax and Lakehouse External Table Syntax.

CREATE TABLE Statement

Depending on the version of MySQL you are using, use the appropriate CREATE TABLE statement.

  • As of MySQL 9.4.0, you can use the CREATE EXTERNAL TABLE statement, which automatically sets ENGINE to lakehouse, and SECONDARY_ENGINE to rapid.

  • In versions earlier than MySQL 9.4.0, you must use the CREATE TABLE statement, and manually set ENGINE to lakehouse, and SECONDARY_ENGINE to rapid.

For example, you can use the following command in MySQL 9.4.0:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"}, 
                           "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/data_file_1.csv"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

For earlier versions, you must use the following command:

mysql> CREATE TABLE table_1(col_1 int, col_2 int, col_3 int)
ENGINE=lakehouse
SECONDARY_ENGINE = rapid
ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"}, 
                   "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/data_file_1.csv"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;
JSON Syntax and SQL Syntax

As of MySQL 9.4.0, you can specify parameter values when creating external tables using SQL syntax. For earlier versions, you must specify parameter values using JSON syntax.

The following example specifies parameter values using SQL syntax:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        FILE_FORMAT = (FORMAT csv)
        FILES = (URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenancy_1/b/bucket_1/o/data_file_1.csv');
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

The following example specifies parameter values using JSON syntax:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"}, 
                           "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/data_file_1.csv"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

To review external table options in JSON syntax, see Lakehouse External Table JSON Syntax.

To review external table options in SQL syntax, see Lakehouse External Table SQL Syntax.

Load a Single File

To load a single file with a pre-authenticated request, you can create a pre-authenticated request for that individual file or specify the file in the command.

The following examples load a single file by using a PAR for that file.

JSON syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"},
                           "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/data_file_1.csv"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

SQL syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        FILE_FORMAT = (FORMAT csv)
        FILES = (URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenancy_1/b/bucket_1/o/data_file_1.csv');
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

The following examples load a single file by using a PAR for a bucket and specifying the file in the name parameter. The file is in the data_files folder.

JSON syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"},
                           "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/", 
                           "name": "data_files/data_file_1.csv"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

SQL syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        FILE_FORMAT = (FORMAT csv)
        FILES = (URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/'
                 FILE_NAME = 'data_files/data_file_1.csv');
mysql> ALTER TABLE table_1 SECONDARY_LOAD;
Load Multiple Files into One External Table

If you want to load multiple files into one external table, you can do one of the following:

  • Create a folder in the Object Storage bucket and upload the required files into that folder. See Managing Folders in an Object Storage Bucket in Oracle Cloud Infrastructure Documentation.

  • Create a PAR for a bucket or folder, and then specify each file to load with the name parameter.

  • Create a PAR for each file to load, and then specify the files as separate items in the ENGINE_ATTRIBUTE parameter.

To load multiple external files into one external table, you can create a folder in the Object Storage bucket and upload the required files into that folder. See Managing Folders in an Object Storage Bucket in Oracle Cloud Infrastructure Documentation.

If you create a folder with the files to load, create a PAR for that folder and do the following:

  • For the Pre-Authenticated Request Target, select Objects with prefix.

  • Use Enable Object Listing.

The following examples load all the files uploaded to the folder in the Object Storage bucket into one external table.

JSON syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"},
                           "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

SQL syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        FILE_FORMAT = (FORMAT csv)
        FILES = (URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/');
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

The following examples use one PAR for a bucket and specify two files to load with the name parameter.

JSON syntax example:

CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"},
                           "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/", "name": "data_files/data_file_1.csv"},
                                    {"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/", "name": "data_files/data_file_2.csv"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

SQL syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        FILE_FORMAT = (FORMAT csv)
        FILES = (URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/' FILE_NAME = 'data_files/data_file_1.csv',
                 URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/' FILE_NAME = 'data_files/data_file_2.csv');
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

The following examples load two separate PARs to load two files.

JSON syntax example:

CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"},
                           "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/data_files/data_file_1.csv"},
                                    {"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/data_files/data_file_2.csv"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

SQL syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        FILE_FORMAT = (FORMAT csv)
        FILES = (URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/data_files/data_file_1.csv',
                 URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/data_files/data_file_2.csv');
mysql> ALTER TABLE table_1 SECONDARY_LOAD;
Load Files with a Prefix

You can add a prefix parameter to a PAR to load specific files. To do this, create a PAR for the folder that stores the files to load.

The following examples load all files in the data_files folder that begin with data_file_. For example, MySQL HeatWave loads the files data_file_1, data_file_2, and data_file_3 into table_1.

JSON syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"},
                           "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/", 
                           "prefix": "data_files/data_file_"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

SQL syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        FILE_FORMAT = (FORMAT csv)
        FILES = (URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/'
                 FILE_PREFIX = 'data_files/data_file_');
mysql> ALTER TABLE table_1 SECONDARY_LOAD;
Load Files with a Pattern

You can add a pattern parameter to a PAR to use regular expression to load specific files.

The regular expression syntax requires certain characters to have an escape character.

The escape character is the backslash character, and it is a reserved character in both JSON and MySQL. Therefore, it is necessary to escape the backslash character twice, and specify \\ for both JSON and MySQL.

However, the regular expression escape sequence depends upon the NO_BACKSLASH_ESCAPES SQL mode:

  • Use \\. to escape a period if NO_BACKSLASH_ESCAPES is enabled.

  • Use \\\\. to escape a period if NO_BACKSLASH_ESCAPES is not enabled. The following examples use this sequence because it is the default mode.

See the following to learn more:

The following examples load all files in the data_files folder that have a numerical suffix of one or more digits. For example, MySQL HeatWave loads the files data_file_1.csv, data_file_2.csv, and data_file_3.csv into table_1.

JSON syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"},
                           "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/", 
                           "pattern": "data_files/data_file_\\\\d+\\\\.csv"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

SQL syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        FILE_FORMAT = (FORMAT csv)
        FILES = (URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/'
                 FILE_PATTERN = 'data_files/data_file_\\\\d+\\\\.csv');
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

The following examples load all files in the bank_data folder that have an alphabetical suffix of one or more lowercase characters. For example, MySQL HeatWave loads the files data_file_a.csv, data_file_b.csv, and data_file_c.csv.

JSON syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"},
                           "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/", 
                           "pattern": "data_files/data_file_[a-z]+\\\\.csv"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

SQL syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        FILE_FORMAT = (FORMAT csv)
        FILES = (URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/'
                 FILE_PATTERN = 'data_files/data_file_[a-z]+\\\\.csv');
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

To update the previous example to include uppercase and lowercase characters, replace [a-z] with [A-Za-z].

The following example loads all files in the bank_data folder that have a numerical suffix that end in 0 with one preceding digit. For example, MySQL HeatWave loads the files data_file_10.csv, data_file_20.csv, and data_file_30.csv.

JSON syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        ENGINE_ATTRIBUTE='{"dialect": {"format": "csv"},
                           "file": [{"par": "https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/", 
                           "pattern": "data_files/data_file_\\\\d0\\\\.csv"}]}';
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

SQL syntax example:

mysql> CREATE EXTERNAL TABLE table_1(col_1 int, col_2 int, col_3 int)
        FILE_FORMAT = (FORMAT csv)
        FILES = (URL = 'https://objectstorage.us-ashburn-1.oraclecloud.com/p/.../n/tenant_1/b/bucket_1/o/'
                 FILE_PATTERN = 'data_files/data_file_\\\\d0\\\\.csv');
mysql> ALTER TABLE table_1 SECONDARY_LOAD;

To update the previous example to load files with one or more digits preceding the 0, update \\\\d0\\\\ with \\\\d+0\\\\.

What's Next