ALTER DATA SOURCE - Kinetica Docs

Alters the connection parameters of an existing data source.

ALTER DATA SOURCE Syntax

ALTER [EXTERNAL] DATA SOURCE [<data source schema name>.]<data source name>
SET PROPERTY
    <property name> = '<property value>'[,...]

The data source will be validated upon alteration, by default, and will fail to be altered if an authorized connection cannot be established.

Parameters

EXTERNAL

Optional keyword for clarity

Name of the schema containing the data source to alter

Name of the data source to alter

SET PROPERTY

Indicator that a comma-delimited list of alterations to make will follow.See Set Properties for the complete list of properties.

Examples

To alter a data source, kin_ds, updating the username & password:

ALTER DATA SOURCE Example

ALTER DATA SOURCE kin_ds
SET PROPERTY
    USER = '<new aws access id>',
    PASSWORD = '<new aws access key>'

Set Properties

All data source properties can be altered via ALTER DATA SOURCE. The following are the property names and descriptions to use when performing an alteration.

Provider-Agnostic Properties

LOCATION

Location of the data source; see Provider-Specific Syntax for detailsThe data source can be from any of the following providers:

Provider	Description
`AZURE`	Microsoft Azure blob storage
`CONFLUENT`	Confluent Kafka streaming feed
`GCS`	Google Cloud Storage
`HDFS`	Apache Hadoop Distributed File System
`JDBC`	JDBC connection, where `LOCATION` is the JDBC or CData JDBC URL. See the supported list for the full list of supported drivers, or specify one with `JDBC_DRIVER_JAR_PATH` and `JDBC_DRIVER_CLASS_NAME`.
`KAFKA`	Apache Kafka streaming feed
`S3`	Amazon S3 bucket

USER

User name, given in <username>, to use for authenticating to the data source

PASSWORD

Password, given in <password>, to use for authenticating to the data source

CREDENTIAL

Credential object to use to authenticate to the remote system

VALIDATE

Whether to test the connection to the data source upon creation; if TRUE, the creation of a data source that cannot be connected to will fail; if FALSE, the data source will be created regardless of connectivity. Default is TRUE.

Provider-Specific Properties

Option	Provider	Description
`WAIT TIMEOUT`	Any except `JDBC`	Timeout in seconds for reading from the storage provider
`USE_MANAGED_CREDENTIALS`	`AZURE`, `GCS`, `S3`	Whether to connect to the storage provider with provider-managed credentials `AZURE`: Use the Azure Instance Metadata Service (IMDS) endpoint local to the Kinetica cluster to acquire credentials (only for on-prem clusters deployed within Azure) `GCS`: Satisfy the Application Default Credentials requirements for credentials, making sure any supporting server-side configuration (files, environment variables) is done on every node in the cluster (only for on-prem clusters deployed within GCS) `S3`: Use the AWS Default Credential Provider Chain to acquire credentials, making sure any supporting server-side configuration (files, environment variables) is done on every node in the cluster (only for on-prem clusters deployed within S3)
`CONNECTION TIMEOUT`	`HDFS`, `S3`	Timeout in seconds for connecting to a given storage provider
`CONTAINER NAME`	`AZURE`	Azure storage container name
`SAS TOKEN`	`AZURE`	Azure storage account shared access signature token; this should be an account-level access token, not a container-level one
`STORAGE ACCOUNT NAME`	`AZURE`	Azure storage account name (only used if `TENANT ID` is specified)
`TENANT ID`	`AZURE`	Azure Active Directory tenant identifier
`GCS_BUCKET_NAME`	`GCS`	Name of the GCS bucket to use as the data source
`GCS_PROJECT_ID`	`GCS`	Name of the Google Cloud project to use for request billing
`GCS_SERVICE_ACCOUNT_KEYS`	`GCS`	Text of the JSON key file containing the GCS private key
`DELEGATION TOKEN`	`HDFS`	Optional Kerberos delegation token for worker nodes; if not specified, the token will be acquired from HDFS
`KERBEROS KEYTAB`	`HDFS`	Location of the Kerberos keytab file in KiFS
`USE KERBEROS`	`HDFS`	Whether to attempt Kerberos authentication to HDFS
`JDBC_DRIVER_CLASS_NAME`	`JDBC`	JDBC driver class name (optional, if the name is available in the JAR file’s manifest)
`JDBC_DRIVER_JAR_PATH`	`JDBC`	KiFS path of the JDBC driver JAR file to use
`KAFKA_TOPIC_NAME`	`KAFKA`, `CONFLUENT`	Kafka topic to access
`SCHEMA_REGISTRY_CREDENTIAL`	`KAFKA`, `CONFLUENT`	Credential object to use to authenticate to the Confluent Schema Registry
`SCHEMA_REGISTRY_LOCATION`	`KAFKA`,	Location of the Confluent Schema Registry in format: `[storage_path[:storage_port]]`
`SCHEMA_REGISTRY_PORT`	`KAFKA`, `CONFLUENT`	Port of the Confluent Schema Registry
`BUCKET NAME`	`S3`	Amazon S3 bucket name
`REGION`	`S3`	Amazon S3 region identifier
`S3_AWS_ROLE_ARN`	`S3`	Amazon Resource Name (ARN) specifying the role
`S3_ENCRYPTION_CUSTOMER_ALGORITHM`	`S3`	Algorithm used to encrypt/decrypt data
`S3_ENCRYPTION_CUSTOMER_KEY`	`S3`	Key used to encrypt/decrypt data
`S3_USE_VIRTUAL_ADDRESSING`	`S3`	Whether to use virtual addressing when referencing the S3 sink `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
`S3_VERIFY_SSL`	`S3`	Whether to verify SSL connections `true`: Verify SSL connections (default) `false`: Don’t verify SSL connections; for testing purposes, bypassing TLS errors, self-signed certificates, etc.

​Parameters

​Examples

​Set Properties

​Provider-Agnostic Properties

​Provider-Specific Properties

Parameters

Examples

Set Properties

Provider-Agnostic Properties

Provider-Specific Properties