◆ createDatasink() \[1/4]

CreateDatasinkResponse gpudb::GPUdb::createDatasink

(

const CreateDatasinkRequest &

request\_

)

const

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

Parameters

\[in]

request\_

Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

◆ createDatasink() \[2/4]

CreateDatasinkResponse & gpudb::GPUdb::createDatasink	(	const CreateDatasinkRequest &	request\_,
		CreateDatasinkResponse &	response\_ ) const

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

Parameters

\[in]	request\_	Request object containing the parameters for the operation.
\[out]	response\_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

◆ createDatasink() \[3/4]

CreateDatasinkResponse gpudb::GPUdb::createDatasink	(	const std::string &	name,
		const std::string &	destination,
		const std::map\< std::string, std::string > &	options ) const

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

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\_azure\_use\_virtual\_addressing: Whether to use virtual addressing when referencing the Azure source. 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\_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.

Returns

Response object containing the result of the operation.

◆ createDatasink() \[4/4]

CreateDatasinkResponse & gpudb::GPUdb::createDatasink	(	const std::string &	name,
		const std::string &	destination,
		const std::map\< std::string, std::string > &	options,
		CreateDatasinkResponse &	response\_ ) const

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

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\_azure\_use\_virtual\_addressing: Whether to use virtual addressing when referencing the Azure source. 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\_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.
\[out]	response\_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).