alterDatasink - Kinetica Docs

◆ alterDatasink() [1/4]

AlterDatasinkResponse gpudb::GPUdb::alterDatasink ( const AlterDatasinkRequest & request_ ) const

Alters the properties of an existing data sink.

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

◆ alterDatasink() [2/4]

AlterDatasinkResponse & gpudb::GPUdb::alterDatasink	(	const AlterDatasinkRequest &	request_,
		AlterDatasinkResponse &	response_ ) const

Alters the properties of an existing data sink.

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).

◆ alterDatasink() [3/4]

AlterDatasinkResponse gpudb::GPUdb::alterDatasink	(	const std::string &	name,
		const std::map< std::string, std::string > &	datasinkUpdatesMap,
		const std::map< std::string, std::string > &	options ) const

Alters the properties of an existing data sink.

Parameters

[in]	name	Name of the data sink to be altered. Must be an existing data sink.
[in]	datasinkUpdatesMap	Map containing the properties of the data sink to be updated. Error if empty. alter_datasink_destination: Destination for the output data in format ‘destination_type://path[:port]’. Supported destination types are ‘azure’, ‘gcs’, ‘hdfs’, ‘http’, ‘https’, ‘jdbc’, ‘kafka’, and ‘s3’. alter_datasink_connection_timeout: Timeout in seconds for connecting to this sink. alter_datasink_wait_timeout: Timeout in seconds for waiting for a response from this sink. alter_datasink_credential: Name of the credential object to be used in this data sink. alter_datasink_s3_bucket_name: Name of the Amazon S3 bucket to use as the data sink. alter_datasink_s3_region: Name of the Amazon S3 region where the given bucket is located. alter_datasink_s3_verify_ssl: Whether to verify SSL connections. Supported values: alter_datasink_true: Connect with SSL verification. alter_datasink_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc. The default value is alter_datasink_true. alter_datasink_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values: alter_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. alter_datasink_false: Use path-style URI for requests. The default value is alter_datasink_true. alter_datasink_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user. alter_datasink_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data. alter_datasink_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data. alter_datasink_s3_encryption_type: Server side encryption type. alter_datasink_s3_kms_key_id: KMS key. alter_datasink_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file. alter_datasink_hdfs_delegation_token: Delegation token for the given HDFS user. alter_datasink_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: alter_datasink_true alter_datasink_false The default value is alter_datasink_false. alter_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. alter_datasink_azure_container_name: Name of the Azure storage container to use as the data sink. alter_datasink_azure_tenant_id: Active Directory tenant ID (or directory ID). alter_datasink_azure_sas_token: Shared access signature token for Azure storage account to use as the data sink. alter_datasink_azure_oauth_token: OAuth token to access given storage container. alter_datasink_azure_use_virtual_addressing: Whether to use virtual addressing when referencing the Azure source. Supported values: alter_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. alter_datasink_false: Use path-style URI for requests. The default value is alter_datasink_true. alter_datasink_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data sink. alter_datasink_gcs_project_id: Name of the Google Cloud project to use as the data sink. alter_datasink_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data sink. alter_datasink_jdbc_driver_jar_path: JDBC driver jar file location. This may be a KIFS file. alter_datasink_jdbc_driver_class_name: Name of the JDBC driver class. alter_datasink_kafka_url: The publicly-accessible full path URL to the kafka broker, e.g., ‘http://172.123.45.67:9300’. alter_datasink_kafka_topic_name: Name of the Kafka topic to use for this data sink, if it references a Kafka broker. alter_datasink_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_datasink_true alter_datasink_false The default value is alter_datasink_true. alter_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: alter_datasink_true alter_datasink_false The default value is alter_datasink_false. alter_datasink_use_https: Use HTTPS to connect to datasink if true, otherwise use HTTP. Supported values: alter_datasink_true alter_datasink_false The default value is alter_datasink_true. alter_datasink_max_batch_size: Maximum number of records per notification message. The default value is ‘1’. alter_datasink_max_message_size: Maximum size in bytes of each notification message. The default value is ‘1000000’. alter_datasink_json_format: The desired format of JSON encoded notifications message. Supported values: alter_datasink_flat: A single record is returned per message. alter_datasink_nested: Records are returned as an array per message. The default value is alter_datasink_flat. alter_datasink_skip_validation: Bypass validation of connection to this data sink. Supported values: alter_datasink_true alter_datasink_false The default value is alter_datasink_false. alter_datasink_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.
[in]	options	Optional parameters.

Returns

Response object containing the result of the operation.

◆ alterDatasink() [4/4]

AlterDatasinkResponse & gpudb::GPUdb::alterDatasink	(	const std::string &	name,
		const std::map< std::string, std::string > &	datasinkUpdatesMap,
		const std::map< std::string, std::string > &	options,
		AlterDatasinkResponse &	response_ ) const

Alters the properties of an existing data sink.

Parameters

[in]	name	Name of the data sink to be altered. Must be an existing data sink.
[in]	datasinkUpdatesMap	Map containing the properties of the data sink to be updated. Error if empty. alter_datasink_destination: Destination for the output data in format ‘destination_type://path[:port]’. Supported destination types are ‘azure’, ‘gcs’, ‘hdfs’, ‘http’, ‘https’, ‘jdbc’, ‘kafka’, and ‘s3’. alter_datasink_connection_timeout: Timeout in seconds for connecting to this sink. alter_datasink_wait_timeout: Timeout in seconds for waiting for a response from this sink. alter_datasink_credential: Name of the credential object to be used in this data sink. alter_datasink_s3_bucket_name: Name of the Amazon S3 bucket to use as the data sink. alter_datasink_s3_region: Name of the Amazon S3 region where the given bucket is located. alter_datasink_s3_verify_ssl: Whether to verify SSL connections. Supported values: alter_datasink_true: Connect with SSL verification. alter_datasink_false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc. The default value is alter_datasink_true. alter_datasink_s3_use_virtual_addressing: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values: alter_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. alter_datasink_false: Use path-style URI for requests. The default value is alter_datasink_true. alter_datasink_s3_aws_role_arn: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user. alter_datasink_s3_encryption_customer_algorithm: Customer encryption algorithm used encrypting data. alter_datasink_s3_encryption_customer_key: Customer encryption key to encrypt or decrypt data. alter_datasink_s3_encryption_type: Server side encryption type. alter_datasink_s3_kms_key_id: KMS key. alter_datasink_hdfs_kerberos_keytab: Kerberos keytab file location for the given HDFS user. This may be a KIFS file. alter_datasink_hdfs_delegation_token: Delegation token for the given HDFS user. alter_datasink_hdfs_use_kerberos: Use kerberos authentication for the given HDFS cluster. Supported values: alter_datasink_true alter_datasink_false The default value is alter_datasink_false. alter_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. alter_datasink_azure_container_name: Name of the Azure storage container to use as the data sink. alter_datasink_azure_tenant_id: Active Directory tenant ID (or directory ID). alter_datasink_azure_sas_token: Shared access signature token for Azure storage account to use as the data sink. alter_datasink_azure_oauth_token: OAuth token to access given storage container. alter_datasink_azure_use_virtual_addressing: Whether to use virtual addressing when referencing the Azure source. Supported values: alter_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. alter_datasink_false: Use path-style URI for requests. The default value is alter_datasink_true. alter_datasink_gcs_bucket_name: Name of the Google Cloud Storage bucket to use as the data sink. alter_datasink_gcs_project_id: Name of the Google Cloud project to use as the data sink. alter_datasink_gcs_service_account_keys: Google Cloud service account keys to use for authenticating the data sink. alter_datasink_jdbc_driver_jar_path: JDBC driver jar file location. This may be a KIFS file. alter_datasink_jdbc_driver_class_name: Name of the JDBC driver class. alter_datasink_kafka_url: The publicly-accessible full path URL to the kafka broker, e.g., ‘http://172.123.45.67:9300’. alter_datasink_kafka_topic_name: Name of the Kafka topic to use for this data sink, if it references a Kafka broker. alter_datasink_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_datasink_true alter_datasink_false The default value is alter_datasink_true. alter_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: alter_datasink_true alter_datasink_false The default value is alter_datasink_false. alter_datasink_use_https: Use HTTPS to connect to datasink if true, otherwise use HTTP. Supported values: alter_datasink_true alter_datasink_false The default value is alter_datasink_true. alter_datasink_max_batch_size: Maximum number of records per notification message. The default value is ‘1’. alter_datasink_max_message_size: Maximum size in bytes of each notification message. The default value is ‘1000000’. alter_datasink_json_format: The desired format of JSON encoded notifications message. Supported values: alter_datasink_flat: A single record is returned per message. alter_datasink_nested: Records are returned as an array per message. The default value is alter_datasink_flat. alter_datasink_skip_validation: Bypass validation of connection to this data sink. Supported values: alter_datasink_true alter_datasink_false The default value is alter_datasink_false. alter_datasink_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.
[in]	options	Optional parameters.
[out]	response_	Response object containing the results of the operation.

Returns

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

​◆ alterDatasink() [1/4]

​◆ alterDatasink() [2/4]

​◆ alterDatasink() [3/4]

​◆ alterDatasink() [4/4]

◆ alterDatasink() [1/4]

◆ alterDatasink() [2/4]

◆ alterDatasink() [3/4]

◆ alterDatasink() [4/4]