ALTER DATA SINK Syntax
Kafka data sinks will be validated upon creation, by default, and
will fail to be created if an authorized connection cannot be established.
Parameters
EXTERNAL
EXTERNAL
Optional keyword for clarity
<schema name>
<schema name>
Name of the schema containing the data sink to alter
<data sink name>
<data sink name>
Name of the data sink to alter
SET PROPERTY
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 sink,kin_dsink, updating the timeouts:
ALTER DATA SINK Example
Set Properties
All data sink properties can be altered via ALTER DATA SINK. The following are the property names and descriptions to use when performing an alteration.CREDENTIAL
CREDENTIAL
Consumer: AnyCredential object to
use to authenticate to the remote consumer
LOCATION
LOCATION
Consumer: AnyLocation of the data sink; see
Consumer-Specific Syntax for details
VALIDATE
VALIDATE
Consumer: AnyWhether to test the connection to the data sink upon
creation; if
TRUE (default), the creation of a
data sink that cannot be connected to will fail; if
FALSE, the data sink will be created regardless
of connectivityWAIT TIMEOUT
WAIT TIMEOUT
Consumer: Any except
JDBCTimeout in seconds for reading from the consumerCONNECTION TIMEOUT
CONNECTION TIMEOUT
Consumer: Any except
JDBCTimeout in seconds for connecting to a consumerUSE_HTTPS
USE_HTTPS
Consumer:
AZURE, GCS, S3Whether to connect to the storage provider over HTTPS or not| Value | Description |
|---|---|
true | Use HTTPS (default) |
false | Use HTTP |
USE_MANAGED_CREDENTIALS
USE_MANAGED_CREDENTIALS
Consumer:
AZURE, GCS, S3Whether to connect to the storage provider with consumer-managed
credentials| Consumer | Notes |
|---|---|
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) |
KAFKA_TOPIC_NAME
KAFKA_TOPIC_NAME
Consumer:
KAFKAKafka topic to write toJSON_FORMAT
JSON_FORMAT
Consumer:
HTTP, HTTPS, KAFKAThe desired format of JSON encoded notifications message.| Type | Description |
|---|---|
flat | A single record is returned per message |
nested | Records are returned in an array per message |
MAX_BATCH_SIZE
MAX_BATCH_SIZE
Consumer:
HTTP, HTTPS, KAFKAMaximum number of records per notification messageMAX_MESSAGE_SIZE
MAX_MESSAGE_SIZE
Consumer:
HTTP, HTTPS, KAFKAMaximum size in bytes of each notification messageCONTAINER NAME
CONTAINER NAME
Consumer:
AZUREAzure storage container nameSAS TOKEN
SAS TOKEN
Consumer:
AZUREAzure storage account shared access signature token; this should be
an account-level access token, not a container-level oneSTORAGE ACCOUNT NAME
STORAGE ACCOUNT NAME
Consumer:
AZUREAzure storage account name (only used if
TENANT ID is specified)TENANT ID
TENANT ID
Consumer:
AZUREAzure Active Directory tenant identifierGCS_BUCKET_NAME
GCS_BUCKET_NAME
Consumer:
GCSName of the GCS bucket to use as the data sinkGCS_PROJECT_ID
GCS_PROJECT_ID
Consumer:
GCSName of the Google Cloud project to use for request billingGCS_SERVICE_ACCOUNT_KEYS
GCS_SERVICE_ACCOUNT_KEYS
Consumer:
GCSText of the JSON key file containing the GCS private keyDELEGATION TOKEN
DELEGATION TOKEN
Consumer:
HDFSOptional Kerberos delegation token for worker nodes;
if not specified, the token will be acquired from HDFSKERBEROS KEYTAB
KERBEROS KEYTAB
Consumer:
HDFSLocation of the Kerberos keytab file in KiFSUSE KERBEROS
USE KERBEROS
Consumer:
HDFSWhether to attempt Kerberos authentication to HDFSJDBC_DRIVER_CLASS_NAME
JDBC_DRIVER_CLASS_NAME
Consumer:
JDBCJDBC driver class name (optional, if the name is available in the
JAR file’s manifest)JDBC_DRIVER_JAR_PATH
JDBC_DRIVER_JAR_PATH
Consumer:
JDBCKiFS path of the JDBC driver JAR file to useBUCKET NAME
BUCKET NAME
Consumer:
S3Amazon S3 bucket nameREGION
REGION
Consumer:
S3Amazon S3 region identifierS3_AWS_ROLE_ARN
S3_AWS_ROLE_ARN
Consumer:
S3Amazon Resource Name (ARN) specifying the roleS3_ENCRYPTION_CUSTOMER_ALGORITHM
S3_ENCRYPTION_CUSTOMER_ALGORITHM
Consumer:
S3Algorithm used to encrypt/decrypt dataS3_ENCRYPTION_CUSTOMER_KEY
S3_ENCRYPTION_CUSTOMER_KEY
Consumer:
S3Key used to encrypt/decrypt dataS3_ENCRYPTION_TYPE
S3_ENCRYPTION_TYPE
Consumer:
S3Server side encryption typeS3_KMS_KEY_ID
S3_KMS_KEY_ID
Consumer:
S3KMS keyS3_USE_VIRTUAL_ADDRESSING
S3_USE_VIRTUAL_ADDRESSING
Consumer:
S3Whether to use virtual addressing when referencing the S3 sink| Value | Description |
|---|---|
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_VERIFY_SSL
Consumer:
S3Whether to verify SSL connections| Value | Description |
|---|---|
true | Verify SSL connections (default) |
false | Don’t verify SSL connections; for testing purposes, bypassing TLS errors, self-signed certificates, etc. |