URL: http://<db.host>:<db.port>/create/datasink
Creates a data sink , which contains the
destination information for a data sink that is external to the database.
Name of the data sink to be created.
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’.
Optional parameters. The default value is an empty map ( {} ). Timeout in seconds for connecting to this data sink.
Timeout in seconds for waiting for a response from this data 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.
s3_use_virtual_addressing
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.
s3_encryption_customer_algorithm
Customer encryption algorithm used encrypting data.
s3_encryption_customer_key
Customer encryption key to encrypt or decrypt data.
Server side encryption type.
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: 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.
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.
azure_use_virtual_addressing
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.
Name of the JDBC driver class.
Name of the Kafka topic to publish to if input parameter destination is a Kafka broker.
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.
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: Use HTTPS to connect to datasink if true, otherwise use HTTP. The default value is true. The supported values are: Bypass validation of connection to this data sink. The default value is false. The supported values are:
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:
Empty if success or an error message
‘create_datasink_response’ or ‘none’ in case of an error
This embedded JSON represents the result of the /create/datasink endpoint: Value of input parameter name .
Empty string in case of an error.