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

#include <gpudb/protocol/create_datasink.h>

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

	CreateDatasinkRequest (const std::string &name_, const std::string &destination_, const std::map< std::string, std::string > &options_)
	Constructs a CreateDatasinkRequest object with the specified parameters. More...

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

std::string	destination
	Destination for the output data in format 'storage_provider_type://path[:port]'. More...

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

Detailed Description

A set of parameters for GPUdb::createDatasink.

Creates a data sink, which contains the destination information for a data sink that is external to the database.

Definition at line 20 of file create_datasink.h.

Constructor & Destructor Documentation

◆ CreateDatasinkRequest() [1/2]

gpudb::CreateDatasinkRequest::CreateDatasinkRequest ( )

inline

Constructs a CreateDatasinkRequest object with default parameters.

Definition at line 25 of file create_datasink.h.

◆ CreateDatasinkRequest() [2/2]

gpudb::CreateDatasinkRequest::CreateDatasinkRequest	(	const std::string &	name_,
		const std::string &	destination_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a CreateDatasinkRequest object with the specified parameters.

Parameters

[in]	name_	Name of the data sink to be created.
[in]	destination_	Destination for the output data in format 'storage_provider_type://path[:port]'. Supported storage provider types are 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'.
[in]	options_	Optional parameters. create_datasink_connection_timeout: Timeout in seconds for connecting to this data sink create_datasink_wait_timeout: Timeout in seconds for waiting for a response from this data sink create_datasink_credential: Name of the credential object to be used in this data sink create_datasink_s3_bucket_name: Name of the Amazon S3 bucket to use as the data sink create_datasink_s3_region: Name of the Amazon S3 region where the given bucket is located create_datasink_s3_verify_ssl: Whether to verify SSL connections. Supported values: create_datasink_true: Connect with SSL verification create_datasink_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc. The default value is create_datasink_true. create_datasink_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values: create_datasink_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_datasink_false: Use path-style URI for requests. The default value is create_datasink_true. create_datasink_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user create_datasink_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data create_datasink_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data create_datasink_s3_encryption_type: Server side encryption type create_datasink_s3_kms_key_id: KMS key create_datasink_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file. create_datasink_hdfs_delegation_token: Delegation token for the given HDFS user create_datasink_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: create_datasink_true create_datasink_false The default value is create_datasink_false. create_datasink_azure_storage_account_name: Name of the Azure storage account to use as the data sink, this is valid only if tenant_id is specified create_datasink_azure_container_name: Name of the Azure storage container to use as the data sink create_datasink_azure_tenant_id: Active Directory tenant ID (or directory ID) create_datasink_azure_sas_token: Shared access signature token for Azure storage account to use as the data sink create_datasink_azure_oauth_token: Oauth token to access given storage container create_datasink_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data sink create_datasink_gcs_project_id: Name of the Google Cloud project to use as the data sink create_datasink_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data sink create_datasink_jdbc_driver_jar_path: JDBC driver jar file location create_datasink_jdbc_driver_class_name: Name of the JDBC driver class create_datasink_kafka_topic_name: Name of the Kafka topic to publish to if destination_ is a Kafka broker create_datasink_max_batch_size: Maximum number of records per notification message. The default value is '1'. create_datasink_max_message_size: Maximum size in bytes of each notification message. The default value is '1000000'. create_datasink_json_format: The desired format of JSON encoded notifications message. Supported values: create_datasink_flat: A single record is returned per message create_datasink_nested: Records are returned as an array per message The default value is create_datasink_flat. create_datasink_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_datasink_true create_datasink_false The default value is create_datasink_false. create_datasink_use_https: Use https to connect to datasink if true, otherwise use http. Supported values: create_datasink_true create_datasink_false The default value is create_datasink_true. create_datasink_skip_validation: Bypass validation of connection to this data sink. Supported values: create_datasink_true create_datasink_false The default value is create_datasink_false. The default value is an empty map.

Definition at line 306 of file create_datasink.h.

Member Data Documentation

◆ destination

std::string gpudb::CreateDatasinkRequest::destination

Destination for the output data in format 'storage_provider_type://path[:port]'.

Supported storage provider types are 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'.

Definition at line 325 of file create_datasink.h.

◆ name

std::string gpudb::CreateDatasinkRequest::name

Name of the data sink to be created.

Definition at line 316 of file create_datasink.h.

◆ options

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

Optional parameters.

create_datasink_connection_timeout: Timeout in seconds for connecting to this data sink
create_datasink_wait_timeout: Timeout in seconds for waiting for a response from this data sink
create_datasink_credential: Name of the credential object to be used in this data sink
create_datasink_s3_bucket_name: Name of the Amazon S3 bucket to use as the data sink
create_datasink_s3_region: Name of the Amazon S3 region where the given bucket is located
create_datasink_s3_verify_ssl: Whether to verify SSL connections. Supported values:
- create_datasink_true: Connect with SSL verification
- create_datasink_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
The default value is create_datasink_true.
create_datasink_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values:
- create_datasink_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_datasink_false: Use path-style URI for requests.
The default value is create_datasink_true.
create_datasink_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user
create_datasink_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data
create_datasink_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data
create_datasink_s3_encryption_type: Server side encryption type
create_datasink_s3_kms_key_id: KMS key
create_datasink_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
create_datasink_hdfs_delegation_token: Delegation token for the given HDFS user
create_datasink_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values:
- create_datasink_true
- create_datasink_false
The default value is create_datasink_false.
create_datasink_azure_storage_account_name: Name of the Azure storage account to use as the data sink, this is valid only if tenant_id is specified
create_datasink_azure_container_name: Name of the Azure storage container to use as the data sink
create_datasink_azure_tenant_id: Active Directory tenant ID (or directory ID)
create_datasink_azure_sas_token: Shared access signature token for Azure storage account to use as the data sink
create_datasink_azure_oauth_token: Oauth token to access given storage container
create_datasink_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data sink
create_datasink_gcs_project_id: Name of the Google Cloud project to use as the data sink
create_datasink_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data sink
create_datasink_jdbc_driver_jar_path: JDBC driver jar file location
create_datasink_jdbc_driver_class_name: Name of the JDBC driver class
create_datasink_kafka_topic_name: Name of the Kafka topic to publish to if destination is a Kafka broker
create_datasink_max_batch_size: Maximum number of records per notification message. The default value is '1'.
create_datasink_max_message_size: Maximum size in bytes of each notification message. The default value is '1000000'.
create_datasink_json_format: The desired format of JSON encoded notifications message. Supported values:
- create_datasink_flat: A single record is returned per message
- create_datasink_nested: Records are returned as an array per message
The default value is create_datasink_flat.
create_datasink_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_datasink_true
- create_datasink_false
The default value is create_datasink_false.
create_datasink_use_https: Use https to connect to datasink if true, otherwise use http. Supported values:
- create_datasink_true
- create_datasink_false
The default value is create_datasink_true.
create_datasink_skip_validation: Bypass validation of connection to this data sink. Supported values:
- create_datasink_true
- create_datasink_false
The default value is create_datasink_false.

The default value is an empty map.

Definition at line 505 of file create_datasink.h.

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

gpudb/protocol/create_datasink.h

Public Member Functions

Public Attributes