alter\_datasource(name=None, datasource\_updates\_map=None, options=None)\[source]

Alters the properties of an existing data source.

Parameters

name (str) –

Name of the data source to be altered. Must be an existing data source.

datasource\_updates\_map (dict of str to str) –

Map containing the properties of the data source to be updated. Error if empty. Allowed keys are:

location – 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’.
user\_name – Name of the remote system user; may be an empty string.
password – Password for the remote system user; may be an empty string.
skip\_validation – Bypass validation of connection to remote source. Allowed values are:
- true
- false
The default value is ‘false’.
connection\_timeout – Timeout in seconds for connecting to this storage provider.
wait\_timeout – Timeout in seconds for reading from this storage provider.
credential – Name of the credential object to be used in data source.
s3\_bucket\_name – Name of the Amazon S3 bucket to use as the data source.
s3\_region – Name of the Amazon S3 region where the given bucket is located.
s3\_verify\_ssl – Whether to verify SSL connections. Allowed values are:
- true – Connect with SSL verification.
- false – Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc.
The default value is ‘true’.
s3\_use\_virtual\_addressing – Whether to use virtual addressing when referencing the Amazon S3 source. Allowed values are:
- 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.
The default value is ‘true’.
s3\_aws\_role\_arn – 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.
hdfs\_kerberos\_keytab – Kerberos keytab file location for the given HDFS user. This may be a KIFS file.
hdfs\_delegation\_token – Delegation token for the given HDFS user.
hdfs\_use\_kerberos – Use kerberos authentication for the given HDFS cluster. Allowed values are:
- true
- false
The default value is ‘false’.
azure\_storage\_account\_name – Name of the Azure storage account to use as the data source, this is valid only if tenant\_id is specified.
azure\_container\_name – Name of the Azure storage container to use as the data source.
azure\_tenant\_id – Active Directory tenant ID (or directory ID).
azure\_sas\_token – Shared access signature token for Azure storage account to use as the data source.
azure\_oauth\_token – OAuth token to access given storage container.
azure\_use\_virtual\_addressing – Whether to use virtual addressing when referencing the Azure source. Allowed values are:
- 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.
The default value is ‘true’.
gcs\_bucket\_name – Name of the Google Cloud Storage bucket to use as the data source.
gcs\_project\_id – Name of the Google Cloud project to use as the data source.
gcs\_service\_account\_keys – Google Cloud service account keys to use for authenticating the data source.
jdbc\_driver\_jar\_path – JDBC driver jar file location. This may be a KIFS file.
jdbc\_driver\_class\_name – Name of the JDBC driver class.
kafka\_url – The publicly-accessible full path URL to the Kafka broker, e.g., ‘[http://172.123.45.67:9300](http://172.123.45.67:9300)’.
kafka\_topic\_name – Name of the Kafka topic to use as the data source.
anonymous – Create an anonymous connection to the storage provider–DEPRECATED: this is now the default. Specify use\_managed\_credentials for non-anonymous connection. Allowed values are:
- true
- false
The default value is ‘true’.
use\_managed\_credentials – When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Allowed values are:
- true
- false
The default value is ‘false’.
use\_https – Use HTTPS to connect to datasource if true, otherwise use HTTP. Allowed values are:
- true
- false
The default value is ‘true’.
schema\_name – 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.
schema\_registry\_connection\_retries – Confluent Schema registry connection timeout (in secs).
schema\_registry\_connection\_timeout – Confluent Schema registry connection timeout (in secs).
schema\_registry\_credential – Confluent Schema Registry credential object name.
schema\_registry\_location – Location of Confluent Schema Registry in ‘\[storage\_path\[:storage\_port]]’ format.
schema\_registry\_port – Confluent Schema Registry port (optional).

options (dict of str to str) –

Optional parameters.

Returns

A dict with the following entries–

updated\_properties\_map (dict of str to str) –

Map of values updated.

info (dict of str to str) –

Additional information.