Help Center > > Developer Guide> Data Export> Exporting Data to OBS> Exporting ORC Data to OBS> Creating a Foreign Table

Creating a Foreign Table

Updated at: Sep 17, 2021 GMT+08:00

After operations in Creating a Foreign Server are complete, create an OBS/HDFS write-only foreign table in the GaussDB(DWS) database to access data stored in OBS/HDFS. The foreign table is write-only and can be used only for data export.

Creating a foreign table

The syntax for creating a foreign table is as follows. For details, see the syntax CREATE FOREIGN TABLE (SQL on Hadoop or OBS).
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
CREATE FOREIGN TABLE [ IF NOT EXISTS ] table_name 
( [ { column_name type_name 
    [ { [CONSTRAINT constraint_name] NULL |
    [CONSTRAINT constraint_name] NOT NULL |
      column_constraint [...]} ] |
      table_constraint [, ...]} [, ...] ] ) 
    SERVER dfs_server 
    OPTIONS ( { option_name ' value ' } [, ...] ) 
    [ {WRITE ONLY }]
    DISTRIBUTE BY {ROUNDROBIN | REPLICATION}
    [ PARTITION BY ( column_name ) [ AUTOMAPPED ] ] ;

For example, when creating a foreign table named product_info_ext_obs, set parameters in the syntax as follows:

  • table_name

    Specifies the name of the foreign table to be created.

  • Table column definitions
    • column_name: specifies the name of a column in the foreign table.
    • type_name: specifies the data type of the column.

    Multiple columns are separate by commas (,).

  • SERVER dfs_server

    Specifies the foreign server name of the foreign table. This server must exist. The foreign table connects to OBS/HDFS to read data through the foreign server.

    Set this parameter to the name of the foreign server created in 9.2.3 Creating a Foreign Server.

  • OPTIONS parameters

    These are parameters associated with the foreign table. The key parameters are as follows:

    • format: specifies the format of the exported data file. The ORC format is supported.
    • foldername: (mandatory) specifies the data source file directory in the foreign table. OBS: specifies the OBS path of the source data file. You only need to enter /Bucket name/Directory level, which does not contain the IP address or domain name of OBS. HDFS: specifies the path in the HDFS file system. This parameter is mandatory for the write-only foreign table.
    • encoding: specifies the encoding of the data source file in the foreign table. The default value is utf8.
    • filesize

      (Optional) Specifies the file size of a write-only foreign table. If this parameter is not specified, the file size in the distributed file system configuration is used by default. This syntax is available only for the write-only foreign table.

      Value range: an integer ranging from 1 to 1024

      The filesize parameter is valid only for the ORC-formatted write-only HDFS foreign table.

    • compression

      (Optional) Specifies the compression mode of ORC files. This syntax is available only for the write-only foreign table.

      Value range: zlib, snappy, and lz4 The default value is snappy.

    • version

      (Optional) Specifies the ORC version number. This syntax is available only for the write-only foreign table.

      Value range: Only 0.12 is supported. The default value is 0.12.

    • dataencoding

      (Optional) Specifies the data code of the data table to be exported when the database code is different from the data code of the data table. For example, the database code is Latin-1, but the data in the exported data table is in UTF-8 format. If this parameter is not specified, the database encoding format is used by default. This syntax is valid only for the write-only HDFS foreign table.

      Value range: data code types supported by the database encoding

      The dataencoding parameter is valid only for the ORC-formatted write-only HDFS foreign table.

  • Other parameters in the syntax

    Other parameters are optional. You can set them as required. In this example, you do not need to set these parameters.

    Based on the preceding settings, the command for creating the foreign table is as follows:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    DROP FOREIGN TABLE IF EXISTS product_info_ext_obs;
    
    -- Create an OBS foreign table that does not contain partition columns. The foreign server associated with the table is obs_server, the file format on OBS corresponding to the table is ORC, and the data storage path on OBS is/mybucket/data/.
    
    CREATE FOREIGN TABLE product_info_ext_obs
    (
        product_price                integer        ,
        product_id                   char(30)       ,
        product_time                 date           ,
        product_level                char(10)       ,
        product_name                 varchar(200)   ,
        product_type1                varchar(20)    ,
        product_type2                char(10)       ,
        product_monthly_sales_cnt    integer        ,
        product_comment_time         date           ,
        product_comment_num          integer        ,
        product_comment_content      varchar(200)                      
    ) SERVER obs_server 
    OPTIONS (
    format 'orc', 
    foldername '/mybucket/demo.db/product_info_orc/',
       compression 'snappy',
        version '0.12'
    ) Write Only;
    

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel