Create an external table

This topic describes how to create an external table by using SQL statements.

Overview

An external table is a logical table object. Its data is stored in an external storage system instead of in the database.

For more information about external tables, see Overview.

Prerequisites

Before you create an external table, make sure that:

• You have connected to OceanBase Database. For more information about how to connect to the database, see Overview of connection methods.

  Note

  The tenant mode to which the logged-in tenant belongs can be queried in the oceanbase.DBA_OB_TENANTS view from the sys tenant.

• The current user has the CREATE TABLE privilege. To view the privileges of the current user, see View user privileges.

Considerations

• An external table can only be used for query operations and does not support DML operations.

• When you query an external table, if the external file accessed by the external table has been deleted, the system does not return an error, but instead returns an empty result set.

• If the external storage system that manages the file accessed by the external table becomes unavailable, an error is returned when you query the external table.

• External tables store data in external data sources. Therefore, query operations involve factors such as network transmission and file systems, which may affect query performance. When you create an external table, you can specify a data source and optimization strategy to improve query efficiency.

CREATE EXTERNAL TABLE syntax

The CREATE EXTERNAL TABLE statement typically takes the following form:

CREATE EXTERNAL TABLE table_name (column_options [AS (metadata$filecol{N})])
LOCATION = '<string>'
FORMAT = (format_options)
[PATTERN = '<regex_pattern>'];
;

For more information about the CREATE EXTERNAL TABLE statement, see CREATE EXTERNAL TABLE.

Parameter description:

• table_name: The external table name.

• column_options: Column definitions of the external table, including column names and data types.

• [AS (metadata$filecol{N})]: This is an optional parameter that allows you to manually define column mappings.

  Note

  By default, data columns in an external file are automatically mapped to columns in an external table in the same order. For example, the first column in the external table corresponds to the first column of data in the external file. If the order of columns in the external file differs from that in the external table, you can use the `metadata$filecol{N}` pseudocolumn to specify that the Nth column in the external file corresponds to a column in the external table. Note that the columns in the file are numbered starting from 1.

• LOCATION: specifies the path where the external file is stored.

• FORMAT: specifies the format of the external file.

• PATTERN: specifies a regular pattern string to filter files in the LOCATION directory.

Define an external table name

When you create an external table, you must name it. We recommend that you use specific naming conventions or prefixes in the table name to distinguish normal tables from external tables. For example, you can add a suffix like _csv to the name of an external table.

Here is an example:

When you create an external table that stores student information, you can name it students_csv.

CREATE EXTERNAL TABLE students_csv external_options

Define columns

You cannot define constraints such as DEFAULT, NOT NULL, UNIQUE, CHECK, PRIMARY KEY, and FOREIGN KEY for columns of an external table.

The column types supported by an external table are the same as those supported by a normal table. For more information about the data types supported in Oracle mode of OceanBase Database, see Overview.

Define LOCATION

The LOCATION option specifies the path where the files of the external table are stored. Generally, the data files of an external table are stored in a dedicated directory. The directory can contain subdirectories. When you create an external table, the system automatically collects all files in the specified directory.

OceanBase Database supports the following two path formats:

• Local path: LOCATION = '[file://] local_file_path'

  Notice

  In the scenario that uses the local path, you must set the system variable secure_file_priv to specify an accessible path. For more information, see secure_file_priv.

• Remote path: LOCATION = '{oss|cos}://$ACCESS_ID:$ACCESS_KEY@$HOST/remote_file_path'

  $ACCESS_ID, $ACCESS_KEY, and $HOST are the access information required to access Alibaba Cloud OSS or Tencent Cloud COS. These sensitive access information is stored in encrypted form in system tables of the database.

Define FORMAT

The FORMAT option specifies the format of external files. The following parameters are supported:

• TYPE: the type of external files. Only the CSV file type is supported.
• LINE_DELIMITER: the line delimiter for CSV files. The default value is '\n'.
• FIELD_DELIMITER: the field delimiter for CSV files. The default value is '\t'.
• ESCAPE: the escape character for CSV files, which can be only 1 byte in length. The default value is '\'.
• FIELD_OPTIONALLY_ENCLOSED_BY: the characters that enclose field values in CSV files. The default value is an empty string.
• ENCODING: the character set encoding format of files. For more information about the character sets supported in the Oracle mode, see Character sets. If this parameter is not specified, the default value UTF8MB4 takes effect.
• NULL_IF: the strings that are to be treated as NULL values. The default value is an empty string.
• SKIP_HEADER: specifies to skip the file header and indicates the number of lines to skip.
• SKIP_BLANK_LINES: specifies whether to skip blank lines. The default value is FALSE, which specifies not to skip blank lines.
• TRIM_SPACE: specifies whether to remove leading and trailing spaces from fields in files. The default value is FALSE, which specifies not to remove leading and trailing spaces from fields in files.
• EMPTY_FIELD_AS_NULL: specifies whether to treat empty strings as NULL values. The default value is FALSE, which specifies not to treat empty strings as NULL values.

(Optional) Define PATTERN

The PATTERN option specifies a regular pattern string for filtering files in the LOCATION directory. For each file in the LOCATION directory, the path of which can match the pattern string, the external table accesses the file. Otherwise, the external table skips the file. If this parameter is not specified, the external table accesses all files in the LOCATION directory by default. The external table stores the list of files that match the PATTERN in the database system table and accesses external files during a scan based on this list. The file list can be automatically or manually updated.

Examples

The following examples describe how to create an external table in the Oracle mode of OceanBase Database when the external file is located locally and on an OceanBase server. The steps are as follows:

1. Create an external file.

   Execute the following command to create a file named test_tbl1.csv in the /home/admin/external_csv directory on the server that you will log in to later.

   [admin@xxx /home/admin/external_csv]# vi test_tbl1.csv
   

   The content of the file is as follows:

   1,'Emma'
   2,'William'
   3,'Olivia'
   

2. Set the path of the imported file.

   Notice

   For security reasons, when you set the system variable secure_file_priv, you can connect to the database only by using a local socket to execute the SQL statement that modifies the global variable. For more information, see secure_file_priv.

   1. Execute the following command to log in to the server where the OBServer node is located.

      ssh admin@10.10.10.1
      

   2. Execute the following command to connect to the oracle001 tenant by using a local Unix socket.

      obclient -S /home/admin/oceanbase/run/sql.sock -usys@oracle001 -p******
      

   3. Execute the following SQL statement to set the import path to /home/admin/external_csv.

      SET GLOBAL secure_file_priv = "/home/admin/external_csv";
      

3. Reconnect to the oracle001 tenant.

   Here is an example:

   obclient -h10.10.10.1 -P2881 -usys@oracle001 -p****** -A
   

4. Execute the following SQL statement to create an external table named test_tbl1_csv.

   CREATE EXTERNAL TABLE test_tbl1_csv ( 
       id INT, 
       name VARCHAR(50)
       )
       LOCATION = '/home/admin/external_csv'
       FORMAT = (
         TYPE = 'CSV'
         FIELD_DELIMITER = ','
         FIELD_OPTIONALLY_ENCLOSED_BY =''''
         )
       PATTERN = 'test_tbl1.csv';
   

5. Execute the following SQL statement to view the data in the test_tbl1_csv table.

   SELECT * FROM test_tbl1_csv;
   

   The return result is as follows:

   +------+---------+
   | ID   | NAME    |
   +------+---------+
   |    1 | Emma    |
   |    2 | William |
   |    3 | Olivia  |
   +------+---------+
   3 rows in set
   

References

• Overview of external tables
• Overview of connection methods
• secure_file_priv