Creates a data source, which contains the
location and connection information for a data store that is external to the
database.
Input Parameter Description
string
Name of the data source to be created.
string
Location of the remote storage in ‘storage_provider_type://[storage_path[:storage_port]]’ format.Supported storage provider types are ‘azure’, ‘gcs’, ‘hdfs’, ‘jdbc’, ‘kafka’, ‘confluent’, and ‘s3’.
string
Name of the remote system user; may be an empty string.
string
Password for the remote system user; may be an empty string.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
Bypass validation of connection to remote source.The default value is false.The supported values are:
true
false
Timeout in seconds for connecting to this storage provider.
Timeout in seconds for reading from this storage provider.
Name of the credential object to be used in data source.
Name of the Amazon S3 bucket to use as the data source.
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 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.
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.
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 source, this is valid only if tenant_id is specified.
Name of the Azure storage container to use as the data source.
Active Directory tenant ID (or directory ID).
Shared access signature token for Azure storage account to use as the data source.
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 source.
Name of the Google Cloud project to use as the data source.
Google Cloud service account keys to use for authenticating the data source.
To load from Azure/GCS/S3 as a stream continuously.The default value is false.The supported values are:
true
false
Name of the Kafka topic to use as the data source.
JDBC driver jar file location. This may be a KIFS file.
Name of the JDBC driver class.
Use anonymous connection to 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 datasource if true, otherwise use HTTP.The default value is true.The supported values are:
true
false
Location of Confluent Schema Registry in ‘[storage_path[:storage_port]]’ format.
Confluent Schema registry connection timeout (in secs).
Confluent Schema registry connection timeout (in secs).
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
‘create_datasource_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /create/datasource endpoint:
Show data_str
string
Value of input parameter name.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.