Skip to main content

​
◆ createDatasink() [1/2]

CreateDatasinkResponse kinetica.Kinetica.createDatasink (CreateDatasinkRequestrequest_)
 inline

Creates a data sink, which contains the destination information for a data sink that is external to the database.

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

Definition at line 18119 of file KineticaFunctions.cs.

​
◆ createDatasink() [2/2]

CreateDatasinkResponse kinetica.Kinetica.createDatasink (stringname,
stringdestination,
IDictionary< string, string >options = null )
 inline

Creates a data sink, which contains the destination information for a data sink that is external to the database.

Parameters
nameName of the data sink to be created.
destinationDestination for the output data in format ‘storage_provider_type://path[:port]’. Supported storage provider types are ‘azure’, ‘gcs’, ‘hdfs’, ‘http’, ‘https’, ‘jdbc’, ‘kafka’, and ‘s3’.
optionsOptional parameters.
  • CONNECTION_TIMEOUT: Timeout in seconds for connecting to this data sink.
  • WAIT_TIMEOUT: Timeout in seconds for waiting for a response from this data sink.
  • CREDENTIAL: Name of the credential object to be used in this data sink.
  • S3_BUCKET_NAME: Name of the Amazon S3 bucket to use as the data sink.
  • 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 sink. 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.
  • S3_ENCRYPTION_TYPE: Server side encryption type.
  • S3_KMS_KEY_ID: KMS key.
  • 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 sink, this is valid only if tenant_id is specified.
  • AZURE_CONTAINER_NAME: Name of the Azure storage container to use as the data sink.
  • 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 sink.
  • 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 sink.
  • GCS_PROJECT_ID: Name of the Google Cloud project to use as the data sink.
  • GCS_SERVICE_ACCOUNT_KEYS: Google Cloud service account keys to use for authenticating the data sink.
  • JDBC_DRIVER_JAR_PATH: JDBC driver jar file location.
  • JDBC_DRIVER_CLASS_NAME: Name of the JDBC driver class.
  • KAFKA_TOPIC_NAME: Name of the Kafka topic to publish to if destination is a Kafka broker.
  • MAX_BATCH_SIZE: Maximum number of records per notification message. The default value is ‘1’.
  • MAX_MESSAGE_SIZE: Maximum size in bytes of each notification message. The default value is ‘1000000’.
  • JSON_FORMAT: The desired format of JSON encoded notifications message. Supported values:
    • FLAT: A single record is returned per message.
    • NESTED: Records are returned as an array per message.
    The default value is FLAT.
  • 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 datasink if true, otherwise use HTTP. Supported values:The default value is TRUE.
  • SKIP_VALIDATION: Bypass validation of connection to this data sink. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 18536 of file KineticaFunctions.cs.

​
◆ CreateDatasinkAsync() [1/2]

async System.Threading.Tasks.Task< CreateDatasinkResponse > kinetica.Kinetica.CreateDatasinkAsync (CreateDatasinkRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Creates a data sink, which contains the destination information for a data sink that is external to the database.

(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 18136 of file KineticaFunctions.cs.

​
◆ CreateDatasinkAsync() [2/2]

async System.Threading.Tasks.Task< CreateDatasinkResponse > kinetica.Kinetica.CreateDatasinkAsync (stringname,
stringdestination,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Creates a data sink, which contains the destination information for a data sink that is external to the database.

(async)

Parameters
nameName of the data sink to be created.
destinationDestination for the output data in format ‘storage_provider_type://path[:port]’. Supported storage provider types are ‘azure’, ‘gcs’, ‘hdfs’, ‘http’, ‘https’, ‘jdbc’, ‘kafka’, and ‘s3’.
optionsOptional parameters.
  • CONNECTION_TIMEOUT: Timeout in seconds for connecting to this data sink.
  • WAIT_TIMEOUT: Timeout in seconds for waiting for a response from this data sink.
  • CREDENTIAL: Name of the credential object to be used in this data sink.
  • S3_BUCKET_NAME: Name of the Amazon S3 bucket to use as the data sink.
  • 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 sink. 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.
  • S3_ENCRYPTION_TYPE: Server side encryption type.
  • S3_KMS_KEY_ID: KMS key.
  • 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 sink, this is valid only if tenant_id is specified.
  • AZURE_CONTAINER_NAME: Name of the Azure storage container to use as the data sink.
  • 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 sink.
  • 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 sink.
  • GCS_PROJECT_ID: Name of the Google Cloud project to use as the data sink.
  • GCS_SERVICE_ACCOUNT_KEYS: Google Cloud service account keys to use for authenticating the data sink.
  • JDBC_DRIVER_JAR_PATH: JDBC driver jar file location.
  • JDBC_DRIVER_CLASS_NAME: Name of the JDBC driver class.
  • KAFKA_TOPIC_NAME: Name of the Kafka topic to publish to if destination is a Kafka broker.
  • MAX_BATCH_SIZE: Maximum number of records per notification message. The default value is ‘1’.
  • MAX_MESSAGE_SIZE: Maximum size in bytes of each notification message. The default value is ‘1000000’.
  • JSON_FORMAT: The desired format of JSON encoded notifications message. Supported values:
    • FLAT: A single record is returned per message.
    • NESTED: Records are returned as an array per message.
    The default value is FLAT.
  • 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 datasink if true, otherwise use HTTP. Supported values:The default value is TRUE.
  • SKIP_VALIDATION: Bypass validation of connection to this data sink. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 18937 of file KineticaFunctions.cs.