Skip to main content

​
◆ alterDatasource() [1/2]

AlterDatasourceResponse kinetica.Kinetica.alterDatasource (AlterDatasourceRequestrequest_)
 inline

Alters the properties of an existing data source.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 9475 of file KineticaFunctions.cs.

​
◆ alterDatasource() [2/2]

AlterDatasourceResponse kinetica.Kinetica.alterDatasource (stringname,
IDictionary< string, string >datasource_updates_map,
IDictionary< string, string >options )
 inline

Alters the properties of an existing data source.

Parameters
nameName of the data source to be altered. Must be an existing data source.
datasource_updates_mapMap containing the properties of the data source to be updated. Error if empty.
  • 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. Supported values: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. Supported values:
    • 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. Supported values:
    • 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. Supported values: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. Supported values:
    • 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’.
  • 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. Supported values: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. Supported values:The default value is FALSE.
  • USE_HTTPS: Use HTTPS to connect to datasource if true, otherwise use HTTP. Supported values: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).
optionsOptional parameters.
Returns
Response object containing the result of the operation.

Definition at line 9939 of file KineticaFunctions.cs.

​
◆ AlterDatasourceAsync() [1/2]

async System.Threading.Tasks.Task< AlterDatasourceResponse > kinetica.Kinetica.AlterDatasourceAsync (AlterDatasourceRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Alters the properties of an existing data source.

(async)

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 9492 of file KineticaFunctions.cs.

​
◆ AlterDatasourceAsync() [2/2]

async System.Threading.Tasks.Task< AlterDatasourceResponse > kinetica.Kinetica.AlterDatasourceAsync (stringname,
IDictionary< string, string >datasource_updates_map,
IDictionary< string, string >options,
System.Threading.CancellationTokencancellationToken = default )
 inline

Alters the properties of an existing data source.

(async)

Parameters
nameName of the data source to be altered. Must be an existing data source.
datasource_updates_mapMap containing the properties of the data source to be updated. Error if empty.
  • 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. Supported values: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. Supported values:
    • 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. Supported values:
    • 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. Supported values: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. Supported values:
    • 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’.
  • 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. Supported values: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. Supported values:The default value is FALSE.
  • USE_HTTPS: Use HTTPS to connect to datasource if true, otherwise use HTTP. Supported values: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).
optionsOptional parameters.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 10388 of file KineticaFunctions.cs.