Name of the data sink to be altered. Must be an existing data sink.
map of string to strings
Map containing the properties of the data sink to be updated. Error if empty.
Show datasink_updates_map
Destination for the output data in format ‘destination_type://path[:port]’.Supported destination types are ‘azure’, ‘gcs’, ‘hdfs’, ‘http’, ‘https’, ‘jdbc’, ‘kafka’, and ‘s3’.
Timeout in seconds for connecting to this sink.
Timeout in seconds for waiting for a response from this sink.
Name of the credential object to be used in this data sink.
Name of the Amazon S3 bucket to use as the data sink.
Name of the Amazon S3 region where the given bucket is located.
Whether to verify SSL connections.The default value is true.
true: Connect with SSL verification.
false: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
Whether to use virtual addressing when referencing the Amazon S3 sink.The default value is true.
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.
false: Use path-style URI for requests.
Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user.
Customer encryption algorithm used encrypting data.
Customer encryption key to encrypt or decrypt data.
Server side encryption type.
KMS key.
Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
Delegation token for the given HDFS user.
Use kerberos authentication for the given HDFS cluster.The default value is false.The supported values are:
true
false
Name of the Azure storage account to use as the data sink, this is valid only if tenant_id is specified.
Name of the Azure storage container to use as the data sink.
Active Directory tenant ID (or directory ID).
Shared access signature token for Azure storage account to use as the data sink.
OAuth token to access given storage container.
Whether to use virtual addressing when referencing the Azure source.The default value is true.
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.
false: Use path-style URI for requests.
Name of the Google Cloud Storage bucket to use as the data sink.
Name of the Google Cloud project to use as the data sink.
Google Cloud service account keys to use for authenticating the data sink.
JDBC driver jar file location. This may be a KIFS file.
Name of the Kafka topic to use for this data sink, if it references a Kafka broker.
Create an anonymous connection to the storage provider—DEPRECATED: this is now the default. Specify use_managed_credentials for non-anonymous connection.The default value is true.The supported values are:
true
false
When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings.The default value is false.The supported values are:
true
false
Use HTTPS to connect to datasink if true, otherwise use HTTP.The default value is true.The supported values are:
true
false
Maximum number of records per notification message.The default value is 1.
Maximum size in bytes of each notification message.The default value is 1000000.
The desired format of JSON encoded notifications message.The default value is flat.
flat: A single record is returned per message.
nested: Records are returned as an array per message.
Bypass validation of connection to this data sink.The default value is false.The supported values are:
true
false
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.
map of string to strings
Optional parameters.
Output Parameter Description
The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘alter_datasink_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /alter/datasink endpoint:
Show data_str
map of string to strings
Map of values updated.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.