> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# gpudb::AlterDatasinkRequest

> gpudb::AlterDatasinkRequest — Kinetica C++ API

<div className="kinetica-doxygen">
  <div className="contents">
    <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aa7b2ae37561ffd0675a2ec5d18b6e5ce">GPUdb::alterDatasink</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/alter__datasink_8h_source">gpudb/protocol/alter\_datasink.h</a>></code></p>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Member Functions</h2>
        </td>
      </tr>

      <tr className="memitem:a601d876bb338a04ba1b0db9ddb9b301a" id="r_a601d876bb338a04ba1b0db9ddb9b301a">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a601d876bb338a04ba1b0db9ddb9b301a">AlterDatasinkRequest</a> ()</td>
      </tr>

      <tr className="memdesc:a601d876bb338a04ba1b0db9ddb9b301a">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterDatasinkRequest" title="A set of parameters for GPUdb::alterDatasink.">AlterDatasinkRequest</a> object with default parameters. <br /></td>
      </tr>

      <tr className="separator:a601d876bb338a04ba1b0db9ddb9b301a">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:aca5d0ed44882513d36210cc5bb35dee4" id="r_aca5d0ed44882513d36210cc5bb35dee4">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aca5d0ed44882513d36210cc5bb35dee4">AlterDatasinkRequest</a> (const std::string \&name\_, const std::map\< std::string, std::string > \&datasinkUpdatesMap\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

      <tr className="memdesc:aca5d0ed44882513d36210cc5bb35dee4">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterDatasinkRequest" title="A set of parameters for GPUdb::alterDatasink.">AlterDatasinkRequest</a> object with the specified parameters. <br /></td>
      </tr>

      <tr className="separator:aca5d0ed44882513d36210cc5bb35dee4">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <table className="memberdecls">
      <tr className="heading">
        <td colSpan="2">
          <h2 className="groupheader"> Public Attributes</h2>
        </td>
      </tr>

      <tr className="memitem:a76edfd0b6b519022eed5696ef0d1b3b6" id="r_a76edfd0b6b519022eed5696ef0d1b3b6">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a76edfd0b6b519022eed5696ef0d1b3b6">name</a></td>
      </tr>

      <tr className="memdesc:a76edfd0b6b519022eed5696ef0d1b3b6">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Name of the data sink to be altered. <br /></td>
      </tr>

      <tr className="separator:a76edfd0b6b519022eed5696ef0d1b3b6">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ab427fc1d0e17d67d5c47375987d348a1" id="r_ab427fc1d0e17d67d5c47375987d348a1">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ab427fc1d0e17d67d5c47375987d348a1">datasinkUpdatesMap</a></td>
      </tr>

      <tr className="memdesc:ab427fc1d0e17d67d5c47375987d348a1">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Map containing the properties of the data sink to be updated. <br /></td>
      </tr>

      <tr className="separator:ab427fc1d0e17d67d5c47375987d348a1">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>

      <tr className="memitem:ae50f1c225dc02389bb267c771f95e609" id="r_ae50f1c225dc02389bb267c771f95e609">
        <td className="memItemLeft" align="right" valign="top">std::map\< std::string, std::string > </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#ae50f1c225dc02389bb267c771f95e609">options</a></td>
      </tr>

      <tr className="memdesc:ae50f1c225dc02389bb267c771f95e609">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Optional parameters. <br /></td>
      </tr>

      <tr className="separator:ae50f1c225dc02389bb267c771f95e609">
        <td className="memSeparator" colSpan="2"> </td>
      </tr>
    </table>

    <h2 className="groupheader">Detailed Description</h2>

    <div className="textblock">
      <p>A set of parameters for <a className="el" href="/content/api/cpp/classgpudb_1_1GPUdb#aa7b2ae37561ffd0675a2ec5d18b6e5ce">GPUdb::alterDatasink</a>. </p>
      <p>Alters the properties of an existing <a href="/content/concepts/data_sinks/" target="_top">data sink</a>. </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__datasink_8h_source#l00019">19</a> of file <a className="el" href="/content/api/cpp/alter__datasink_8h_source">alter\_datasink.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a601d876bb338a04ba1b0db9ddb9b301a">◆ </a></span>AlterDatasinkRequest() <span className="overload">\[1/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::AlterDatasinkRequest::AlterDatasinkRequest </td>
                  <td>(</td>

                  <td className="paramname">
                    <span className="paramname">
                      <span className="em" />
                    </span>
                  </td>

                  <td>)</td>

                  <td />
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterDatasinkRequest" title="A set of parameters for GPUdb::alterDatasink.">AlterDatasinkRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__datasink_8h_source#l00024">24</a> of file <a className="el" href="/content/api/cpp/alter__datasink_8h_source">alter\_datasink.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aca5d0ed44882513d36210cc5bb35dee4">◆ </a></span>AlterDatasinkRequest() <span className="overload">\[2/2]</span></h2>

    <div className="memitem">
      <div className="memproto">
        <table className="mlabels">
          <tr>
            <td className="mlabels-left">
              <table className="memname">
                <tr>
                  <td className="memname">gpudb::AlterDatasinkRequest::AlterDatasinkRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">name\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">datasinkUpdatesMap\_</span></span>, </td>
                </tr>

                <tr>
                  <td className="paramkey" />

                  <td />

                  <td className="paramtype">const std::map\< std::string, std::string > &</td>
                  <td className="paramname"><span className="paramname"><span className="em">options\_</span></span> )</td>
                </tr>
              </table>
            </td>

            <td className="mlabels-right"> <span className="mlabels"><span className="mlabel inline">inline</span></span> </td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Constructs an <a className="el" href="/content/api/cpp/structgpudb_1_1AlterDatasinkRequest" title="A set of parameters for GPUdb::alterDatasink.">AlterDatasinkRequest</a> object with the specified parameters. </p>

        <div className="dl params">
          <div className="dt">Parameters</div>

          <div className="dd">
            <table className="params">
              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">name\_</td>
                <td>Name of the data sink to be altered. Must be an existing data sink. </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">datasinkUpdatesMap\_</td>

                <td>
                  Map containing the properties of the data sink to be updated. Error if empty.

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4a0d104c0178c4b56f7b03995f058fb1">alter\_datasink\_destination</a>: Destination for the output data in format 'destination\_type://path\[:port]'. Supported destination types are 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6a43e5c70a4c21da60ffe78da948329a">alter\_datasink\_connection\_timeout</a>: Timeout in seconds for connecting to this sink. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3eb2340f0817eec3552c34e557dfeb12">alter\_datasink\_wait\_timeout</a>: Timeout in seconds for waiting for a response from this sink. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a7bd38a886837904caaa90b1446124fc0">alter\_datasink\_credential</a>: Name of the <a href="/content/concepts/credentials/" target="_top">credential</a> object to be used in this data sink. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8b092f302ce0ea59d53580f5947b1628">alter\_datasink\_s3\_bucket\_name</a>: Name of the Amazon S3 bucket to use as the data sink. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac11298cb08ca616f27aaac0cc34bb161">alter\_datasink\_s3\_region</a>: Name of the Amazon S3 region where the given bucket is located. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a30e5b754c8a2df5f6969ef041ab1db3b">alter\_datasink\_s3\_verify\_ssl</a>: Whether to verify SSL connections. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>: Connect with SSL verification. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a1db4f002d25d102b7ba31935c2e45d48">alter\_datasink\_s3\_use\_virtual\_addressing</a>: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>: Use path-style URI for requests. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a69dfac31dca1748eb94404a31da12f47">alter\_datasink\_s3\_aws\_role\_arn</a>: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab798fd48f8b77e996c4a4c65d2967395">alter\_datasink\_s3\_encryption\_customer\_algorithm</a>: Customer encryption algorithm used encrypting data. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a25c46b801c402251cfaaafd65a798955">alter\_datasink\_s3\_encryption\_customer\_key</a>: Customer encryption key to encrypt or decrypt data. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a17b6839e447e0153fcb835a03f079a4e">alter\_datasink\_s3\_encryption\_type</a>: Server side encryption type. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3b645c8952af2ec7f0be514075b858a0">alter\_datasink\_s3\_kms\_key\_id</a>: KMS key. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4565916d715519b80e8918e06ab4d373">alter\_datasink\_hdfs\_kerberos\_keytab</a>: Kerberos keytab file location for the given HDFS user. This may be a KIFS file. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9f22437c6abe08f43700ae4b148cbebd">alter\_datasink\_hdfs\_delegation\_token</a>: Delegation token for the given HDFS user. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#ac7a8e19d121c1a415041107304ccac70">alter\_datasink\_hdfs\_use\_kerberos</a>: Use kerberos authentication for the given HDFS cluster. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6fc43867972e58f8ba547343cd9fac94">alter\_datasink\_azure\_storage\_account\_name</a>: Name of the Azure storage account to use as the data sink, this is valid only if tenant\_id is specified. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab0311625dc87be79ee115bf3971939e6">alter\_datasink\_azure\_container\_name</a>: Name of the Azure storage container to use as the data sink. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a66c75cbec45f62b2eca99ef4fad4dbb7">alter\_datasink\_azure\_tenant\_id</a>: Active Directory tenant ID (or directory ID). </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#abee3c93f7c05c0b61557988422b3d9f2">alter\_datasink\_azure\_sas\_token</a>: Shared access signature token for Azure storage account to use as the data sink. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a12cee8b842b07e7805c3dbc9a0fdd89f">alter\_datasink\_azure\_oauth\_token</a>: OAuth token to access given storage container. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#ab443a3dc0af9f6fa60053afe22d1ac91">alter\_datasink\_azure\_use\_virtual\_addressing</a>: Whether to use virtual addressing when referencing the Azure source. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>: Use path-style URI for requests. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#adbac9d3d999f61393b3cfe6671c00a9b">alter\_datasink\_gcs\_bucket\_name</a>: Name of the Google Cloud Storage bucket to use as the data sink. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aea3fe0340868c921a707b8e38cae696e">alter\_datasink\_gcs\_project\_id</a>: Name of the Google Cloud project to use as the data sink. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac804cc8c2ff3ff5510482e68db86c6ab">alter\_datasink\_gcs\_service\_account\_keys</a>: Google Cloud service account keys to use for authenticating the data sink. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a99bc70e8ab904940587d65c009c3346c">alter\_datasink\_jdbc\_driver\_jar\_path</a>: JDBC driver jar file location. This may be a KIFS file. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#afffd05e87de3f0f5c3a1e733d251a70f">alter\_datasink\_jdbc\_driver\_class\_name</a>: Name of the JDBC driver class. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a952726ddeca5a96def745416a2e0696f">alter\_datasink\_kafka\_url</a>: The publicly-accessible full path URL to the kafka broker, e.g., '<a href="http://172.123.45.67:9300'">[http://172.123.45.67:9300](http://172.123.45.67:9300)'</a>. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad9c0af60634ffc3e998b04a9a0b03f74">alter\_datasink\_kafka\_topic\_name</a>: Name of the Kafka topic to use for this data sink, if it references a Kafka broker. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a91c2f8678b82b9bd3e44597a7f602d12">alter\_datasink\_anonymous</a>: Create an anonymous connection to the storage provider–DEPRECATED: this is now the default. Specify use\_managed\_credentials for non-anonymous connection. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#aa928649c126abfc1a446e0a8a426dead">alter\_datasink\_use\_managed\_credentials</a>: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a92c588a54be469b8969e0e52568c6839">alter\_datasink\_use\_https</a>: Use HTTPS to connect to datasink if true, otherwise use HTTP. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad6145d07105197fae52c8fc87bc8f1b4">alter\_datasink\_max\_batch\_size</a>: Maximum number of records per notification message. The default value is '1'. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a529332811f765c8339ede1f81d360b27">alter\_datasink\_max\_message\_size</a>: Maximum size in bytes of each notification message. The default value is '1000000'. </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a86f0b3cd992b783cf34fa1998d4ffe18">alter\_datasink\_json\_format</a>: The desired format of JSON encoded notifications message. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6a7dee0a0304a051b5626c46aee04dfc">alter\_datasink\_flat</a>: A single record is returned per message. </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa1bf7eaedcaa8ed4f98abd100afd30e1">alter\_datasink\_nested</a>: Records are returned as an array per message. </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6a7dee0a0304a051b5626c46aee04dfc">alter\_datasink\_flat</a>.
                    </li>

                    <li>
                      <a className="el" href="/content/api/cpp/namespacegpudb#a8d331eabb1eaa0d017e2dc8c7a61764f">alter\_datasink\_skip\_validation</a>: Bypass validation of connection to this data sink. Supported values:

                      <ul>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a> </li>
                        <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a> </li>
                      </ul>

                      The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>.
                    </li>

                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#acd037aa58526d85bd5133adc55350362">alter\_datasink\_schema\_name</a>: Updates the schema name. If <a className="el" href="/content/api/cpp/namespacegpudb#acd037aa58526d85bd5133adc55350362">schema\_name</a> doesn't exist, an error will be thrown. If <a className="el" href="/content/api/cpp/namespacegpudb#acd037aa58526d85bd5133adc55350362">schema\_name</a> is empty, then the user's default schema will be used. </li>
                  </ul>
                </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">options\_</td>
                <td>Optional parameters. </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__datasink_8h_source#l00422">422</a> of file <a className="el" href="/content/api/cpp/alter__datasink_8h_source">alter\_datasink.h</a>.</p>
      </div>
    </div>

    <h2 className="groupheader">Member Data Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#ab427fc1d0e17d67d5c47375987d348a1">◆ </a></span>datasinkUpdatesMap</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::AlterDatasinkRequest::datasinkUpdatesMap</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Map containing the properties of the data sink to be updated. </p>
        <p>Error if empty. </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4a0d104c0178c4b56f7b03995f058fb1">alter\_datasink\_destination</a>: Destination for the output data in format 'destination\_type://path\[:port]'. Supported destination types are 'azure', 'gcs', 'hdfs', 'http', 'https', 'jdbc', 'kafka', and 's3'. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6a43e5c70a4c21da60ffe78da948329a">alter\_datasink\_connection\_timeout</a>: Timeout in seconds for connecting to this sink. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3eb2340f0817eec3552c34e557dfeb12">alter\_datasink\_wait\_timeout</a>: Timeout in seconds for waiting for a response from this sink. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a7bd38a886837904caaa90b1446124fc0">alter\_datasink\_credential</a>: Name of the <a href="/content/concepts/credentials/" target="_top">credential</a> object to be used in this data sink. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a8b092f302ce0ea59d53580f5947b1628">alter\_datasink\_s3\_bucket\_name</a>: Name of the Amazon S3 bucket to use as the data sink. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac11298cb08ca616f27aaac0cc34bb161">alter\_datasink\_s3\_region</a>: Name of the Amazon S3 region where the given bucket is located. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a30e5b754c8a2df5f6969ef041ab1db3b">alter\_datasink\_s3\_verify\_ssl</a>: Whether to verify SSL connections. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>: Connect with SSL verification. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>: Connect without verifying the SSL connection; for testing purposes, bypassing TLS errors, self-signed certificates, etc. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a1db4f002d25d102b7ba31935c2e45d48">alter\_datasink\_s3\_use\_virtual\_addressing</a>: Whether to use virtual addressing when referencing the Amazon S3 sink. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>: Use path-style URI for requests. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a69dfac31dca1748eb94404a31da12f47">alter\_datasink\_s3\_aws\_role\_arn</a>: Amazon IAM Role ARN which has required S3 permissions that can be assumed for the given S3 IAM user. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab798fd48f8b77e996c4a4c65d2967395">alter\_datasink\_s3\_encryption\_customer\_algorithm</a>: Customer encryption algorithm used encrypting data. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a25c46b801c402251cfaaafd65a798955">alter\_datasink\_s3\_encryption\_customer\_key</a>: Customer encryption key to encrypt or decrypt data. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a17b6839e447e0153fcb835a03f079a4e">alter\_datasink\_s3\_encryption\_type</a>: Server side encryption type. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a3b645c8952af2ec7f0be514075b858a0">alter\_datasink\_s3\_kms\_key\_id</a>: KMS key. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a4565916d715519b80e8918e06ab4d373">alter\_datasink\_hdfs\_kerberos\_keytab</a>: Kerberos keytab file location for the given HDFS user. This may be a KIFS file. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a9f22437c6abe08f43700ae4b148cbebd">alter\_datasink\_hdfs\_delegation\_token</a>: Delegation token for the given HDFS user. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#ac7a8e19d121c1a415041107304ccac70">alter\_datasink\_hdfs\_use\_kerberos</a>: Use kerberos authentication for the given HDFS cluster. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6fc43867972e58f8ba547343cd9fac94">alter\_datasink\_azure\_storage\_account\_name</a>: Name of the Azure storage account to use as the data sink, this is valid only if tenant\_id is specified. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab0311625dc87be79ee115bf3971939e6">alter\_datasink\_azure\_container\_name</a>: Name of the Azure storage container to use as the data sink. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a66c75cbec45f62b2eca99ef4fad4dbb7">alter\_datasink\_azure\_tenant\_id</a>: Active Directory tenant ID (or directory ID). </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#abee3c93f7c05c0b61557988422b3d9f2">alter\_datasink\_azure\_sas\_token</a>: Shared access signature token for Azure storage account to use as the data sink. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a12cee8b842b07e7805c3dbc9a0fdd89f">alter\_datasink\_azure\_oauth\_token</a>: OAuth token to access given storage container. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#ab443a3dc0af9f6fa60053afe22d1ac91">alter\_datasink\_azure\_use\_virtual\_addressing</a>: Whether to use virtual addressing when referencing the Azure source. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>: The requests URI should be specified in virtual-hosted-style format where the bucket name is part of the domain name in the URL. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>: Use path-style URI for requests. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#adbac9d3d999f61393b3cfe6671c00a9b">alter\_datasink\_gcs\_bucket\_name</a>: Name of the Google Cloud Storage bucket to use as the data sink. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#aea3fe0340868c921a707b8e38cae696e">alter\_datasink\_gcs\_project\_id</a>: Name of the Google Cloud project to use as the data sink. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac804cc8c2ff3ff5510482e68db86c6ab">alter\_datasink\_gcs\_service\_account\_keys</a>: Google Cloud service account keys to use for authenticating the data sink. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a99bc70e8ab904940587d65c009c3346c">alter\_datasink\_jdbc\_driver\_jar\_path</a>: JDBC driver jar file location. This may be a KIFS file. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#afffd05e87de3f0f5c3a1e733d251a70f">alter\_datasink\_jdbc\_driver\_class\_name</a>: Name of the JDBC driver class. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a952726ddeca5a96def745416a2e0696f">alter\_datasink\_kafka\_url</a>: The publicly-accessible full path URL to the kafka broker, e.g., '<a href="http://172.123.45.67:9300'">[http://172.123.45.67:9300](http://172.123.45.67:9300)'</a>. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad9c0af60634ffc3e998b04a9a0b03f74">alter\_datasink\_kafka\_topic\_name</a>: Name of the Kafka topic to use for this data sink, if it references a Kafka broker. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a91c2f8678b82b9bd3e44597a7f602d12">alter\_datasink\_anonymous</a>: Create an anonymous connection to the storage provider–DEPRECATED: this is now the default. Specify use\_managed\_credentials for non-anonymous connection. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#aa928649c126abfc1a446e0a8a426dead">alter\_datasink\_use\_managed\_credentials</a>: When no credentials are supplied, we use anonymous access by default. If this is set, we will use cloud provider user settings. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a92c588a54be469b8969e0e52568c6839">alter\_datasink\_use\_https</a>: Use HTTPS to connect to datasink if true, otherwise use HTTP. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ad6145d07105197fae52c8fc87bc8f1b4">alter\_datasink\_max\_batch\_size</a>: Maximum number of records per notification message. The default value is '1'. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a529332811f765c8339ede1f81d360b27">alter\_datasink\_max\_message\_size</a>: Maximum size in bytes of each notification message. The default value is '1000000'. </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a86f0b3cd992b783cf34fa1998d4ffe18">alter\_datasink\_json\_format</a>: The desired format of JSON encoded notifications message. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6a7dee0a0304a051b5626c46aee04dfc">alter\_datasink\_flat</a>: A single record is returned per message. </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa1bf7eaedcaa8ed4f98abd100afd30e1">alter\_datasink\_nested</a>: Records are returned as an array per message. </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6a7dee0a0304a051b5626c46aee04dfc">alter\_datasink\_flat</a>.
          </li>

          <li>
            <a className="el" href="/content/api/cpp/namespacegpudb#a8d331eabb1eaa0d017e2dc8c7a61764f">alter\_datasink\_skip\_validation</a>: Bypass validation of connection to this data sink. Supported values:

            <ul>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#aa5cf0f71ea6d896d2d85adae7bba2487">alter\_datasink\_true</a> </li>
              <li> <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a> </li>
            </ul>

            The default value is <a className="el" href="/content/api/cpp/namespacegpudb#a6aeccac0ebf48fc56991c2a65a3b2272">alter\_datasink\_false</a>.
          </li>

          <li> <a className="el" href="/content/api/cpp/namespacegpudb#acd037aa58526d85bd5133adc55350362">alter\_datasink\_schema\_name</a>: Updates the schema name. If <a className="el" href="/content/api/cpp/namespacegpudb#acd037aa58526d85bd5133adc55350362">schema\_name</a> doesn't exist, an error will be thrown. If <a className="el" href="/content/api/cpp/namespacegpudb#acd037aa58526d85bd5133adc55350362">schema\_name</a> is empty, then the user's default schema will be used. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__datasink_8h_source#l00657">657</a> of file <a className="el" href="/content/api/cpp/alter__datasink_8h_source">alter\_datasink.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a76edfd0b6b519022eed5696ef0d1b3b6">◆ </a></span>name</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::string gpudb::AlterDatasinkRequest::name</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Name of the data sink to be altered. </p>
        <p>Must be an existing data sink. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__datasink_8h_source#l00432">432</a> of file <a className="el" href="/content/api/cpp/alter__datasink_8h_source">alter\_datasink.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#ae50f1c225dc02389bb267c771f95e609">◆ </a></span>options</h2>

    <div className="memitem">
      <div className="memproto">
        <table className="memname">
          <tr>
            <td className="memname">std::map\<std::string, std::string> gpudb::AlterDatasinkRequest::options</td>
          </tr>
        </table>
      </div>

      <div className="memdoc">
        <p>Optional parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__datasink_8h_source#l00662">662</a> of file <a className="el" href="/content/api/cpp/alter__datasink_8h_source">alter\_datasink.h</a>.</p>
      </div>
    </div>

    <hr />

    The documentation for this struct was generated from the following file:

    <ul>
      <li>gpudb/protocol/<a className="el" href="/content/api/cpp/alter__datasink_8h_source">alter\_datasink.h</a></li>
    </ul>
  </div>
</div>