ALTER LOCATION

Purpose

This statement is used to modify the properties of a Location object.

Privilege requirements

• Execution privilege:

  To execute the ALTER LOCATION statement, the current user must have the CREATE LOCATION privilege. For more information about OceanBase Database privileges, see Privilege classification in MySQL mode.

• Authentication credential privilege:

  The provided ACCESSID and ACCESSKEY must have valid access permissions to the target storage service.

Syntax

ALTER LOCATION location_name SET 
    {URL = 'file_path'
    | CREDENTIAL = (credential_list)
    };

credential_list:
    ACCESSID = 'string'
    ACCESSKEY = 'string'
    HOST = 'string'
    [S3_REGION = 'string']
    [PRINCIPAL = 'string']
    [KEYTAB = 'string']
    [KRB5CONF = 'string']
    [CONFIGS = 'string']
    [USERNAME = 'string']

Parameters

file_path

The path for storing external table files can be in the following formats:

• Local path: URL = 'file://local_file_path', where local_file_path can be a relative path or an absolute path.

• HDFS path: URL = 'hdfs://localhost:port/PATH', where localhost specifies the HDFS address, port specifies the HDFS port number, and PATH specifies the directory path in HDFS.

• Object storage (OSS/S3) path: URL = '{oss | s3}://bucket/remote_file_path'.

credential_list

• ACCESSID: the AccessKey ID of the user for accessing object storage.
• ACCESSKEY: the AccessKey secret of the user for accessing object storage.
• HOST: the host address of the object storage service.
• S3_REGION: optional. The service region of the S3 object storage.
• PRINCIPAL: optional. The login authentication user when the target HDFS cluster is in a Kerberos environment.
• KEYTAB: optional. The authentication key file path when the target HDFS cluster is in a Kerberos environment.
• KRB5CONF: optional. The file path for using Kerberos when the target HDFS cluster is in a Kerberos environment.
• CONFIGS: optional. Additional cluster configuration items when the target HDFS cluster is in a Kerberos environment.
• USERNAME: optional. The unique identifier for the user when the target HDFS cluster is in a Kerberos environment.

Examples

Modify the CREDENTIAL information of the test_location_oss Location object.

obclient> CREATE LOCATION test_location_oss
    URL = 'oss://dir'
    CREDENTIAL = (
        ACCESSID = '******'
        ACCESSKEY = '******'
        HOST = '******'
        );

References

For more information about viewing files under a Location object, see SHOW.