> ## 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::AlterEnvironmentRequest

> gpudb::AlterEnvironmentRequest — 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#a7ad22467beee2568754047af78a7bf90">GPUdb::alterEnvironment</a>. <a href="#details">More...</a></p>
    <p><code>#include \<<a className="el" href="/content/api/cpp/alter__environment_8h_source">gpudb/protocol/alter\_environment.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:a7e2444f2cccf65cf93b95e1a0c627b34" id="r_a7e2444f2cccf65cf93b95e1a0c627b34">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a7e2444f2cccf65cf93b95e1a0c627b34">AlterEnvironmentRequest</a> ()</td>
      </tr>

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

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

      <tr className="memitem:a1348a45dbb9195a97b8fbc738f1361e3" id="r_a1348a45dbb9195a97b8fbc738f1361e3">
        <td className="memItemLeft" align="right" valign="top"> </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#a1348a45dbb9195a97b8fbc738f1361e3">AlterEnvironmentRequest</a> (const std::string \&environmentName\_, const std::string \&action\_, const std::string \&value\_, const std::map\< std::string, std::string > \&options\_)</td>
      </tr>

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

      <tr className="separator:a1348a45dbb9195a97b8fbc738f1361e3">
        <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:aeafb0c1c0d6daae81f8198a420c703fb" id="r_aeafb0c1c0d6daae81f8198a420c703fb">
        <td className="memItemLeft" align="right" valign="top">std::string </td>
        <td className="memItemRight" valign="bottom"><a className="el" href="#aeafb0c1c0d6daae81f8198a420c703fb">environmentName</a></td>
      </tr>

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

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

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

      <tr className="memdesc:a479da77d76edda2eded985fa343fa494">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">Modification operation to be applied. <br /></td>
      </tr>

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

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

      <tr className="memdesc:adc987f0ea66071525871c5642dd7f957">
        <td className="mdescLeft"> </td>
        <td className="mdescRight">The value of the modification, depending on <a className="el" href="#a479da77d76edda2eded985fa343fa494">action</a>. <br /></td>
      </tr>

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

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

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

      <tr className="separator:a9010ffea15501b665119e8a160178e1f">
        <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#a7ad22467beee2568754047af78a7bf90">GPUdb::alterEnvironment</a>. </p>
      <p>Alters an existing environment which can be referenced by a <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF). </p>
      <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__environment_8h_source#l00020">20</a> of file <a className="el" href="/content/api/cpp/alter__environment_8h_source">alter\_environment.h</a>.</p>
    </div>

    <h2 className="groupheader">Constructor & Destructor Documentation</h2>
    <h2 className="memtitle"><span className="permalink"><a href="#a7e2444f2cccf65cf93b95e1a0c627b34">◆ </a></span>AlterEnvironmentRequest() <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::AlterEnvironmentRequest::AlterEnvironmentRequest </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_1AlterEnvironmentRequest" title="A set of parameters for GPUdb::alterEnvironment.">AlterEnvironmentRequest</a> object with default parameters. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__environment_8h_source#l00026">26</a> of file <a className="el" href="/content/api/cpp/alter__environment_8h_source">alter\_environment.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#a1348a45dbb9195a97b8fbc738f1361e3">◆ </a></span>AlterEnvironmentRequest() <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::AlterEnvironmentRequest::AlterEnvironmentRequest </td>
                  <td>(</td>
                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">environmentName\_</span></span>, </td>
                </tr>

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

                  <td />

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

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

                  <td />

                  <td className="paramtype">const std::string &</td>
                  <td className="paramname"><span className="paramname"><span className="em">value\_</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_1AlterEnvironmentRequest" title="A set of parameters for GPUdb::alterEnvironment.">AlterEnvironmentRequest</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">environmentName\_</td>
                <td>Name of the environment to be altered. </td>
              </tr>

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

                <td>
                  Modification operation to be applied. Supported values:

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab0796383a257147cadaef815fc59da5c">alter\_environment\_install\_package</a>: Install a python package from PyPI, an external data source or KiFS. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#a87496b3c47fbc0c828b37f727bc2197c">alter\_environment\_install\_requirements</a>: Install packages from a requirements file. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac46962a17b1b9340f6a8d39e79c04544">alter\_environment\_uninstall\_package</a>: Uninstall a python package. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#adf6ca34b954ccde01c5fbbccf6c30678">alter\_environment\_uninstall\_requirements</a>: Uninstall packages from a requirements file. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac99f67abc4aadaf8b73ffff173a6c5b1">alter\_environment\_reset</a>: Uninstalls all packages in the environment and resets it to the original state at time of creation. </li>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#afe2895fb56b140a32ce6660f3c6108a6">alter\_environment\_rebuild</a>: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies. </li>
                  </ul>
                </td>
              </tr>

              <tr>
                <td className="paramdir">\[in]</td>
                <td className="paramname">value\_</td>
                <td>The value of the modification, depending on <span className="em arg">action\_</span>. For example, if <span className="em arg">action\_</span> is <a className="el" href="/content/api/cpp/namespacegpudb#ab0796383a257147cadaef815fc59da5c">install\_package</a>, this would be the python package name. If <span className="em arg">action\_</span> is <a className="el" href="/content/api/cpp/namespacegpudb#a87496b3c47fbc0c828b37f727bc2197c">install\_requirements</a>, this would be the path of a requirements file from which to install packages. If an external data source is specified in <a className="el" href="/content/api/cpp/namespacegpudb#aac83bd2736cec62f9efbbea87fdfbe86">datasource\_name</a>, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in <a href="/content/tools/kifs/" target="_top">KiFS</a>. </td>
              </tr>

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

                <td>
                  Optional parameters.

                  <ul>
                    <li> <a className="el" href="/content/api/cpp/namespacegpudb#aac83bd2736cec62f9efbbea87fdfbe86">alter\_environment\_datasource\_name</a>: Name of an existing external data source from which packages specified in <span className="em arg">value\_</span> can be loaded. </li>
                  </ul>

                  The default value is an empty map.
                </td>
              </tr>
            </table>
          </div>
        </div>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__environment_8h_source#l00100">100</a> of file <a className="el" href="/content/api/cpp/alter__environment_8h_source">alter\_environment.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Modification operation to be applied. </p>
        <p>Supported values: </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ab0796383a257147cadaef815fc59da5c">alter\_environment\_install\_package</a>: Install a python package from PyPI, an external data source or KiFS. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#a87496b3c47fbc0c828b37f727bc2197c">alter\_environment\_install\_requirements</a>: Install packages from a requirements file. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac46962a17b1b9340f6a8d39e79c04544">alter\_environment\_uninstall\_package</a>: Uninstall a python package. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#adf6ca34b954ccde01c5fbbccf6c30678">alter\_environment\_uninstall\_requirements</a>: Uninstall packages from a requirements file. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#ac99f67abc4aadaf8b73ffff173a6c5b1">alter\_environment\_reset</a>: Uninstalls all packages in the environment and resets it to the original state at time of creation. </li>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#afe2895fb56b140a32ce6660f3c6108a6">alter\_environment\_rebuild</a>: Recreates the environment and re-installs all packages, upgrades the packages if necessary based on dependencies. </li>
        </ul>

        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__environment_8h_source#l00139">139</a> of file <a className="el" href="/content/api/cpp/alter__environment_8h_source">alter\_environment.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#aeafb0c1c0d6daae81f8198a420c703fb">◆ </a></span>environmentName</h2>

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

      <div className="memdoc">
        <p>Name of the environment to be altered. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__environment_8h_source#l00111">111</a> of file <a className="el" href="/content/api/cpp/alter__environment_8h_source">alter\_environment.h</a>.</p>
      </div>
    </div>

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

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

      <div className="memdoc">
        <p>Optional parameters. </p>

        <ul>
          <li> <a className="el" href="/content/api/cpp/namespacegpudb#aac83bd2736cec62f9efbbea87fdfbe86">alter\_environment\_datasource\_name</a>: Name of an existing external data source from which packages specified in <a className="el" href="#adc987f0ea66071525871c5642dd7f957">value</a> can be loaded. </li>
        </ul>

        <p>The default value is an empty map. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__environment_8h_source#l00170">170</a> of file <a className="el" href="/content/api/cpp/alter__environment_8h_source">alter\_environment.h</a>.</p>
      </div>
    </div>

    <h2 className="memtitle"><span className="permalink"><a href="#adc987f0ea66071525871c5642dd7f957">◆ </a></span>value</h2>

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

      <div className="memdoc">
        <p>The value of the modification, depending on <a className="el" href="#a479da77d76edda2eded985fa343fa494">action</a>. </p>
        <p>For example, if <a className="el" href="#a479da77d76edda2eded985fa343fa494">action</a> is <a className="el" href="/content/api/cpp/namespacegpudb#ab0796383a257147cadaef815fc59da5c">install\_package</a>, this would be the python package name.</p>
        <p>If <a className="el" href="#a479da77d76edda2eded985fa343fa494">action</a> is <a className="el" href="/content/api/cpp/namespacegpudb#a87496b3c47fbc0c828b37f727bc2197c">install\_requirements</a>, this would be the path of a requirements file from which to install packages.</p>
        <p>If an external data source is specified in <a className="el" href="/content/api/cpp/namespacegpudb#aac83bd2736cec62f9efbbea87fdfbe86">datasource\_name</a>, this can be the path to a wheel file or source archive. Alternatively, if installing from a file (wheel or source archive), the value may be a reference to a file in <a href="/content/tools/kifs/" target="_top">KiFS</a>. </p>
        <p className="definition">Definition at line <a className="el" href="/content/api/cpp/alter__environment_8h_source#l00158">158</a> of file <a className="el" href="/content/api/cpp/alter__environment_8h_source">alter\_environment.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__environment_8h_source">alter\_environment.h</a></li>
    </ul>
  </div>
</div>