Version:

/alter/datasource

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/alter/datasource

Alters the properties of an existing data source

Input Parameter Description

Name Type Description
name string Name of the data source to be altered. Must be an existing data source.
datasource_updates_map map of string to strings

Map containing the properties of the data source to be updated. Error if empty.

Supported Parameters (keys) Parameter Description
location Location of the remote storage in 'storage_provider_type://[storage_path[:storage_port]]' format. Supported storage provider types are 'hdfs' and 's3'.
user_name Name of the remote system user; may be an empty string
password Password for the remote system user; may be an empty string
skip_validation

Bypass validation of connection to remote source. The default value is false. The supported values are:

  • true
  • false
connection_timeout Timeout in seconds for connecting to this storage provider
wait_timeout Timeout in seconds for reading from this storage provider
s3_bucket_name Name of the Amazon S3 bucket to use as the data source
s3_region Name of the Amazon S3 region where the given bucket is located
hdfs_kerberos_keytab Kerberos keytab file location for the given HDFS user
hdfs_delegation_token Delegation token for the given HDFS user
hdfs_use_kerberos

Use kerberos authentication for the given HDFS cluster The default value is false. The supported values are:

  • true
  • false
azure_storage_account_name Name of the Azure storage account to use as the data source, this is valid only if tenant_id is specified
azure_container_name Name of the Azure storage container to use as the data source
azure_tenant_id Active Directory tenant ID (or directory ID)
azure_sas_token Shared access signature token for Azure storage account to use as the data source
azure_oauth_token Oauth token to access given storage container
options map of string to strings Optional parameters.

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name Type Description
status String 'OK' or 'ERROR'
message String Empty if success or an error message
data_type String 'alter_datasource_request' or 'none' in case of an error
data String Empty string
data_str JSON or String

This embedded JSON represents the result of the /alter/datasource endpoint:

Name Type Description
updated_properties_map map of string to strings Map of values updated
info map of string to strings Additional information.

Empty string in case of an error.