A set of parameters for GPUdb::alterDatasource. More...

#include \<gpudb/protocol/alter\_datasource.h>

Public Member Functions
	AlterDatasourceRequest ()
	Constructs an AlterDatasourceRequest object with default parameters.

	AlterDatasourceRequest (const std::string \&name\_, const std::map\< std::string, std::string > \&datasourceUpdatesMap\_, const std::map\< std::string, std::string > \&options\_)
	Constructs an AlterDatasourceRequest object with the specified parameters.

Public Attributes
std::string	name
	Name of the data source to be altered.

std::map\< std::string, std::string >	datasourceUpdatesMap
	Map containing the properties of the data source to be updated.

std::map\< std::string, std::string >	options
	Optional parameters.

Detailed Description

A set of parameters for GPUdb::alterDatasource.

Alters the properties of an existing data source.

Definition at line 19 of file alter\_datasource.h.

Constructor & Destructor Documentation

◆ AlterDatasourceRequest() \[1/2]

gpudb::AlterDatasourceRequest::AlterDatasourceRequest

(

)

inline

Constructs an AlterDatasourceRequest object with default parameters.

Definition at line 24 of file alter\_datasource.h.

◆ AlterDatasourceRequest() \[2/2]

gpudb::AlterDatasourceRequest::AlterDatasourceRequest	(	const std::string &	name\_,
		const std::map\< std::string, std::string > &	datasourceUpdatesMap\_,
		const std::map\< std::string, std::string > &	options\_ )

inline

Constructs an AlterDatasourceRequest object with the specified parameters.

Parameters

\[in]	name\_	Name of the data source to be altered. Must be an existing data source.
\[in]	datasourceUpdatesMap\_	Map containing the properties of the data source to be updated. Error if empty. alter\_datasource\_location: Location of the remote storage in 'storage\_provider\_type://\[storage\_path\[:storage\_port]]' format. Supported storage provider types are 'azure', 'gcs', 'hdfs', 'jdbc', 'kafka', 'confluent', and 's3'. alter\_datasource\_user\_name: Name of the remote system user; may be an empty string. alter\_datasource\_password: Password for the remote system user; may be an empty string. alter\_datasource\_skip\_validation: Bypass validation of connection to remote source. Supported values: alter\_datasource\_true alter\_datasource\_false The default value is alter\_datasource\_false. alter\_datasource\_connection\_timeout: Timeout in seconds for connecting to this storage provider. alter\_datasource\_wait\_timeout: Timeout in seconds for reading from this storage provider. alter\_datasource\_credential: Name of the credential object to be used in data source. alter\_datasource\_s3\_bucket\_name: Name of the Amazon S3 bucket to use as the data source. alter\_datasource\_s3\_region: Name of the Amazon S3 region where the given bucket is located. alter\_datasource\_s3\_verify\_ssl: Whether to verify SSL connections. Supported values: alter\_datasource\_true: Connect with SSL verification. alter\_datasource\_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc. The default value is alter\_datasource\_true. alter\_datasource\_s3\_use\_virtual\_addressing: Whether to use virtual addressing when referencing the Amazon S3 source. Supported values: alter\_datasource\_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL. alter\_datasource\_false: Use path-style URI for requests. The default value is alter\_datasource\_true. alter\_datasource\_s3\_aws\_role\_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user. alter\_datasource\_s3\_encryption\_customer\_algorithm: Customer encryption algorithm used encrypting data. alter\_datasource\_s3\_encryption\_customer\_key: Customer encryption key to encrypt or decrypt data. alter\_datasource\_hdfs\_kerberos\_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file. alter\_datasource\_hdfs\_delegation\_token: Delegation token for the given HDFS user. alter\_datasource\_hdfs\_use\_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: alter\_datasource\_true alter\_datasource\_false The default value is alter\_datasource\_false. alter\_datasource\_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. alter\_datasource\_azure\_container\_name: Name of the Azure storage container to use as the data source. alter\_datasource\_azure\_tenant\_id: Active Directory tenant ID (or directory ID). alter\_datasource\_azure\_sas\_token: Shared access signature token for Azure storage account to use as the data source. alter\_datasource\_azure\_oauth\_token: OAuth token to access given storage container. alter\_datasource\_azure\_use\_virtual\_addressing: Whether to use virtual addressing when referencing the Azure source. Supported values: alter\_datasource\_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL. alter\_datasource\_false: Use path-style URI for requests. The default value is alter\_datasource\_true. alter\_datasource\_gcs\_bucket\_name: Name of the Google Cloud Storage bucket to use as the data source. alter\_datasource\_gcs\_project\_id: Name of the Google Cloud project to use as the data source. alter\_datasource\_gcs\_service\_account\_keys: Google Cloud service account keys to use for authenticating the data source. alter\_datasource\_jdbc\_driver\_jar\_path: JDBC driver jar file location. This may be a KIFS file. alter\_datasource\_jdbc\_driver\_class\_name: Name of the JDBC driver class. alter\_datasource\_kafka\_url: The publicly-accessible full path URL to the Kafka broker, e.g., '[http://172.123.45.67:9300](http://172.123.45.67:9300)'. alter\_datasource\_kafka\_topic\_name: Name of the Kafka topic to use as the data source. alter\_datasource\_anonymous: Create an anonymous connection to the storage provider–DEPRECATED: this is now the default. Specify use\_managed\_credentials for non-anonymous connection. Supported values: alter\_datasource\_true alter\_datasource\_false The default value is alter\_datasource\_true. alter\_datasource\_use\_managed\_credentials: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values: alter\_datasource\_true alter\_datasource\_false The default value is alter\_datasource\_false. alter\_datasource\_use\_https: Use HTTPS to connect to datasource if true, otherwise use HTTP. Supported values: alter\_datasource\_true alter\_datasource\_false The default value is alter\_datasource\_true. alter\_datasource\_schema\_name: Updates the schema name. If schema\_name doesn't exist, an error will be thrown. If schema\_name is empty, then the user's default schema will be used. alter\_datasource\_schema\_registry\_connection\_retries: Confluent Schema registry connection timeout (in secs). alter\_datasource\_schema\_registry\_connection\_timeout: Confluent Schema registry connection timeout (in secs). alter\_datasource\_schema\_registry\_credential: Confluent Schema Registry credential object name. alter\_datasource\_schema\_registry\_location: Location of Confluent Schema Registry in '\[storage\_path\[:storage\_port]]' format. alter\_datasource\_schema\_registry\_port: Confluent Schema Registry port (optional).
\[in]	options\_	Optional parameters.

Definition at line 430 of file alter\_datasource.h.

Member Data Documentation

◆ datasourceUpdatesMap

std::map\ gpudb::AlterDatasourceRequest::datasourceUpdatesMap

Map containing the properties of the data source to be updated.

Error if empty.

alter\_datasource\_location: Location of the remote storage in 'storage\_provider\_type://\[storage\_path\[:storage\_port]]' format. Supported storage provider types are 'azure', 'gcs', 'hdfs', 'jdbc', 'kafka', 'confluent', and 's3'.
alter\_datasource\_user\_name: Name of the remote system user; may be an empty string.
alter\_datasource\_password: Password for the remote system user; may be an empty string.
alter\_datasource\_skip\_validation: Bypass validation of connection to remote source. Supported values:
- alter\_datasource\_true
- alter\_datasource\_false
The default value is alter\_datasource\_false.
alter\_datasource\_connection\_timeout: Timeout in seconds for connecting to this storage provider.
alter\_datasource\_wait\_timeout: Timeout in seconds for reading from this storage provider.
alter\_datasource\_credential: Name of the credential object to be used in data source.
alter\_datasource\_s3\_bucket\_name: Name of the Amazon S3 bucket to use as the data source.
alter\_datasource\_s3\_region: Name of the Amazon S3 region where the given bucket is located.
alter\_datasource\_s3\_verify\_ssl: Whether to verify SSL connections. Supported values:
- alter\_datasource\_true: Connect with SSL verification.
- alter\_datasource\_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
The default value is alter\_datasource\_true.
alter\_datasource\_s3\_use\_virtual\_addressing: Whether to use virtual addressing when referencing the Amazon S3 source. Supported values:
- alter\_datasource\_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- alter\_datasource\_false: Use path-style URI for requests.
The default value is alter\_datasource\_true.
alter\_datasource\_s3\_aws\_role\_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user.
alter\_datasource\_s3\_encryption\_customer\_algorithm: Customer encryption algorithm used encrypting data.
alter\_datasource\_s3\_encryption\_customer\_key: Customer encryption key to encrypt or decrypt data.
alter\_datasource\_hdfs\_kerberos\_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
alter\_datasource\_hdfs\_delegation\_token: Delegation token for the given HDFS user.
alter\_datasource\_hdfs\_use\_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values:
- alter\_datasource\_true
- alter\_datasource\_false
The default value is alter\_datasource\_false.
alter\_datasource\_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.
alter\_datasource\_azure\_container\_name: Name of the Azure storage container to use as the data source.
alter\_datasource\_azure\_tenant\_id: Active Directory tenant ID (or directory ID).
alter\_datasource\_azure\_sas\_token: Shared access signature token for Azure storage account to use as the data source.
alter\_datasource\_azure\_oauth\_token: OAuth token to access given storage container.
alter\_datasource\_azure\_use\_virtual\_addressing: Whether to use virtual addressing when referencing the Azure source. Supported values:
- alter\_datasource\_true: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL.
- alter\_datasource\_false: Use path-style URI for requests.
The default value is alter\_datasource\_true.
alter\_datasource\_gcs\_bucket\_name: Name of the Google Cloud Storage bucket to use as the data source.
alter\_datasource\_gcs\_project\_id: Name of the Google Cloud project to use as the data source.
alter\_datasource\_gcs\_service\_account\_keys: Google Cloud service account keys to use for authenticating the data source.
alter\_datasource\_jdbc\_driver\_jar\_path: JDBC driver jar file location. This may be a KIFS file.
alter\_datasource\_jdbc\_driver\_class\_name: Name of the JDBC driver class.
alter\_datasource\_kafka\_url: The publicly-accessible full path URL to the Kafka broker, e.g., '[http://172.123.45.67:9300](http://172.123.45.67:9300)'.
alter\_datasource\_kafka\_topic\_name: Name of the Kafka topic to use as the data source.
alter\_datasource\_anonymous: Create an anonymous connection to the storage provider–DEPRECATED: this is now the default. Specify use\_managed\_credentials for non-anonymous connection. Supported values:
- alter\_datasource\_true
- alter\_datasource\_false
The default value is alter\_datasource\_true.
alter\_datasource\_use\_managed\_credentials: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values:
- alter\_datasource\_true
- alter\_datasource\_false
The default value is alter\_datasource\_false.
alter\_datasource\_use\_https: Use HTTPS to connect to datasource if true, otherwise use HTTP. Supported values:
- alter\_datasource\_true
- alter\_datasource\_false
The default value is alter\_datasource\_true.
alter\_datasource\_schema\_name: Updates the schema name. If schema\_name doesn't exist, an error will be thrown. If schema\_name is empty, then the user's default schema will be used.
alter\_datasource\_schema\_registry\_connection\_retries: Confluent Schema registry connection timeout (in secs).
alter\_datasource\_schema\_registry\_connection\_timeout: Confluent Schema registry connection timeout (in secs).
alter\_datasource\_schema\_registry\_credential: Confluent Schema Registry credential object name.
alter\_datasource\_schema\_registry\_location: Location of Confluent Schema Registry in '\[storage\_path\[:storage\_port]]' format.
alter\_datasource\_schema\_registry\_port: Confluent Schema Registry port (optional).

Definition at line 668 of file alter\_datasource.h.

◆ name

std::string gpudb::AlterDatasourceRequest::name

Name of the data source to be altered.

Must be an existing data source.

Definition at line 441 of file alter\_datasource.h.

◆ options

std::map\ gpudb::AlterDatasourceRequest::options

Optional parameters.

Definition at line 673 of file alter\_datasource.h.

The documentation for this struct was generated from the following file:

gpudb/protocol/alter\_datasource.h

Public Member Functions

Public Attributes