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

#include <gpudb/protocol/create_datasource.h>

Public Member Functions
	CreateDatasourceRequest ()
	Constructs a CreateDatasourceRequest object with default parameters. More...

	CreateDatasourceRequest (const std::string &name_, const std::string &location_, const std::string &userName_, const std::string &password_, const std::map< std::string, std::string > &options_)
	Constructs a CreateDatasourceRequest object with the specified parameters. More...

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

std::string	location
	Location of the remote storage in 'storage_provider_type://[storage_path[:storage_port]]' format. More...

std::string	userName
	Name of the remote system user; may be an empty string. More...

std::string	password
	Password for the remote system user; may be an empty string. More...

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

Detailed Description

A set of parameters for GPUdb::createDatasource.

Creates a data source, which contains the location and connection information for a data store that is external to the database.

Definition at line 20 of file create_datasource.h.

Constructor & Destructor Documentation

◆ CreateDatasourceRequest() [1/2]

gpudb::CreateDatasourceRequest::CreateDatasourceRequest ( )

inline

Constructs a CreateDatasourceRequest object with default parameters.

Definition at line 25 of file create_datasource.h.

◆ CreateDatasourceRequest() [2/2]

gpudb::CreateDatasourceRequest::CreateDatasourceRequest	(	const std::string &	name_,
		const std::string &	location_,
		const std::string &	userName_,
		const std::string &	password_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a CreateDatasourceRequest object with the specified parameters.

Parameters

[in]	name_	Name of the data source to be created.
[in]	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'.
[in]	userName_	Name of the remote system user; may be an empty string
[in]	password_	Password for the remote system user; may be an empty string
[in]	options_	Optional parameters. create_datasource_skip_validation: Bypass validation of connection to remote source. Supported values: create_datasource_true create_datasource_false The default value is create_datasource_false. create_datasource_connection_timeout: Timeout in seconds for connecting to this storage provider create_datasource_wait_timeout: Timeout in seconds for reading from this storage provider create_datasource_credential: Name of the credential object to be used in data source create_datasource_s3_bucket_name: Name of the Amazon S3 bucket to use as the data source create_datasource_s3_region: Name of the Amazon S3 region where the given bucket is located create_datasource_s3_verify_ssl: Whether to verify SSL connections. Supported values: create_datasource_true: Connect with SSL verification create_datasource_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc. The default value is create_datasource_true. create_datasource_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 source. Supported values: create_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. create_datasource_false: Use path-style URI for requests. The default value is create_datasource_true. create_datasource_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user create_datasource_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data create_datasource_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data create_datasource_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file. create_datasource_hdfs_delegation_token: Delegation token for the given HDFS user create_datasource_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: create_datasource_true create_datasource_false The default value is create_datasource_false. create_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 create_datasource_azure_container_name: Name of the Azure storage container to use as the data source create_datasource_azure_tenant_id: Active Directory tenant ID (or directory ID) create_datasource_azure_sas_token: Shared access signature token for Azure storage account to use as the data source create_datasource_azure_oauth_token: OAuth token to access given storage container create_datasource_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data source create_datasource_gcs_project_id: Name of the Google Cloud project to use as the data source create_datasource_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data source create_datasource_is_stream: To load from Azure/GCS/S3 as a stream continuously. Supported values: create_datasource_true create_datasource_false The default value is create_datasource_false. create_datasource_kafka_topic_name: Name of the Kafka topic to use as the data source create_datasource_jdbc_driver_jar_path: JDBC driver jar file location. This may be a KIFS file. create_datasource_jdbc_driver_class_name: Name of the JDBC driver class create_datasource_anonymous: Use anonymous connection to storage provider–DEPRECATED: this is now the default. Specify use_managed_credentials for non-anonymous connection. Supported values: create_datasource_true create_datasource_false The default value is create_datasource_true. create_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: create_datasource_true create_datasource_false The default value is create_datasource_false. create_datasource_use_https: Use https to connect to datasource if true, otherwise use http. Supported values: create_datasource_true create_datasource_false The default value is create_datasource_true. create_datasource_schema_registry_location: Location of Confluent Schema Registry in '[storage_path[:storage_port]]' format. create_datasource_schema_registry_credential: Confluent Schema Registry credential object name. create_datasource_schema_registry_port: Confluent Schema Registry port (optional). The default value is an empty map.

Definition at line 328 of file create_datasource.h.

Member Data Documentation

◆ location

std::string gpudb::CreateDatasourceRequest::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'.

Definition at line 349 of file create_datasource.h.

◆ name

std::string gpudb::CreateDatasourceRequest::name

Name of the data source to be created.

Definition at line 340 of file create_datasource.h.

◆ options

std::map<std::string, std::string> gpudb::CreateDatasourceRequest::options

Optional parameters.

create_datasource_skip_validation: Bypass validation of connection to remote source. Supported values:
- create_datasource_true
- create_datasource_false
The default value is create_datasource_false.
create_datasource_connection_timeout: Timeout in seconds for connecting to this storage provider
create_datasource_wait_timeout: Timeout in seconds for reading from this storage provider
create_datasource_credential: Name of the credential object to be used in data source
create_datasource_s3_bucket_name: Name of the Amazon S3 bucket to use as the data source
create_datasource_s3_region: Name of the Amazon S3 region where the given bucket is located
create_datasource_s3_verify_ssl: Whether to verify SSL connections. Supported values:
- create_datasource_true: Connect with SSL verification
- create_datasource_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
The default value is create_datasource_true.
create_datasource_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 source. Supported values:
- create_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.
- create_datasource_false: Use path-style URI for requests.
The default value is create_datasource_true.
create_datasource_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
create_datasource_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data
create_datasource_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data
create_datasource_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
create_datasource_hdfs_delegation_token: Delegation token for the given HDFS user
create_datasource_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values:
- create_datasource_true
- create_datasource_false
The default value is create_datasource_false.
create_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
create_datasource_azure_container_name: Name of the Azure storage container to use as the data source
create_datasource_azure_tenant_id: Active Directory tenant ID (or directory ID)
create_datasource_azure_sas_token: Shared access signature token for Azure storage account to use as the data source
create_datasource_azure_oauth_token: OAuth token to access given storage container
create_datasource_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data source
create_datasource_gcs_project_id: Name of the Google Cloud project to use as the data source
create_datasource_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data source
create_datasource_is_stream: To load from Azure/GCS/S3 as a stream continuously. Supported values:
- create_datasource_true
- create_datasource_false
The default value is create_datasource_false.
create_datasource_kafka_topic_name: Name of the Kafka topic to use as the data source
create_datasource_jdbc_driver_jar_path: JDBC driver jar file location. This may be a KIFS file.
create_datasource_jdbc_driver_class_name: Name of the JDBC driver class
create_datasource_anonymous: Use anonymous connection to storage provider–DEPRECATED: this is now the default. Specify use_managed_credentials for non-anonymous connection. Supported values:
- create_datasource_true
- create_datasource_false
The default value is create_datasource_true.
create_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:
- create_datasource_true
- create_datasource_false
The default value is create_datasource_false.
create_datasource_use_https: Use https to connect to datasource if true, otherwise use http. Supported values:
- create_datasource_true
- create_datasource_false
The default value is create_datasource_true.
create_datasource_schema_registry_location: Location of Confluent Schema Registry in '[storage_path[:storage_port]]' format.
create_datasource_schema_registry_credential: Confluent Schema Registry credential object name.
create_datasource_schema_registry_port: Confluent Schema Registry port (optional).

The default value is an empty map.

Definition at line 555 of file create_datasource.h.

◆ password

std::string gpudb::CreateDatasourceRequest::password

Password for the remote system user; may be an empty string.

Definition at line 359 of file create_datasource.h.

◆ userName

std::string gpudb::CreateDatasourceRequest::userName

Name of the remote system user; may be an empty string.

Definition at line 354 of file create_datasource.h.

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

gpudb/protocol/create_datasource.h

Public Member Functions

Public Attributes