> ## 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.

# alterEnvironment

<div className="kinetica-doxygen">
  <div id="a147e011a41747d14c151f56deb8d866f" />

  <h2 className="memtitle"><span className="permalink"><a href="#a147e011a41747d14c151f56deb8d866f">◆ </a></span>alterEnvironment() <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"><a className="el" href="/content/api/cs/classkinetica_1_1AlterEnvironmentResponse">AlterEnvironmentResponse</a> kinetica.Kinetica.alterEnvironment </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AlterEnvironmentRequest">AlterEnvironmentRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></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>Alters an existing environment which can be referenced by a <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF). </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L10497">10497</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a89b4fbc8ea4788ee2f744609b69e3bb1" />

  <h2 className="memtitle"><span className="permalink"><a href="#a89b4fbc8ea4788ee2f744609b69e3bb1">◆ </a></span>alterEnvironment() <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"><a className="el" href="/content/api/cs/classkinetica_1_1AlterEnvironmentResponse">AlterEnvironmentResponse</a> kinetica.Kinetica.alterEnvironment </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">environment\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">action</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">\_value</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</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>Alters an existing environment which can be referenced by a <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF). </p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">environment\_name</td>
              <td>Name of the environment to be altered. </td>
            </tr>

            <tr>
              <td className="paramname">action</td>

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

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#aed8aa50e94b6c4135898fdd8f4919e0c">INSTALL\_PACKAGE</a>: Install a python package from PyPI, an external data source or KiFS. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a2dc17a748f10e3d962d740bf7ff38571">INSTALL\_REQUIREMENTS</a>: Install packages from a requirements file. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a113b841510108c1174e2a04fa986e288">UNINSTALL\_PACKAGE</a>: Uninstall a python package. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#aabb250d49046ab48bc0d162cff88474a">UNINSTALL\_REQUIREMENTS</a>: Uninstall packages from a requirements file. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#abab1c0f769205dd255dae898bc67f058">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/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a858a0a5cbc446bbd4845125506f8b423">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="paramname">\_value</td>
              <td>The value of the modification, depending on <span className="em">action</span> . For example, if <span className="em">action</span> is <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#aed8aa50e94b6c4135898fdd8f4919e0c">INSTALL\_PACKAGE</a>, this would be the python package name. If <span className="em">action</span> is <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a2dc17a748f10e3d962d740bf7ff38571">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/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options#a128c188dfbb202901fd2a1626b1f3207">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="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options#a128c188dfbb202901fd2a1626b1f3207">DATASOURCE\_NAME</a>: Name of an existing external data source from which packages specified in <span className="em">\_value</span> can be loaded. </li>
                </ul>

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

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Response object containing the result of the operation. </div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L10603">10603</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="a3cac1191cf726c92a47e2842c1c9be3f" />

  <h2 className="memtitle"><span className="permalink"><a href="#a3cac1191cf726c92a47e2842c1c9be3f">◆ </a></span>AlterEnvironmentAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1AlterEnvironmentResponse">AlterEnvironmentResponse</a> > kinetica.Kinetica.AlterEnvironmentAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1AlterEnvironmentRequest">AlterEnvironmentRequest</a></td>
                <td className="paramname"><span className="paramname"><span className="em">request\_</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Alters an existing environment which can be referenced by a <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF). </p>
      <p>(async)</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">request\_</td>
              <td>Request object containing the parameters for the operation.</td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L10514">10514</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>

  <div id="af6fd16577ac89bb216cc951ea1e079d6" />

  <h2 className="memtitle"><span className="permalink"><a href="#af6fd16577ac89bb216cc951ea1e079d6">◆ </a></span>AlterEnvironmentAsync() <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">async System.Threading.Tasks.Task\< <a className="el" href="/content/api/cs/classkinetica_1_1AlterEnvironmentResponse">AlterEnvironmentResponse</a> > kinetica.Kinetica.AlterEnvironmentAsync </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">environment\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">action</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">\_value</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">IDictionary\< string, string ></td>
                <td className="paramname"><span className="paramname"><span className="em">options</span></span><span className="paramdefsep"> = </span><span className="paramdefval">null</span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">System.Threading.CancellationToken</td>
                <td className="paramname"><span className="paramname"><span className="em">cancellationToken</span></span><span className="paramdefsep"> = </span><span className="paramdefval">default</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>Alters an existing environment which can be referenced by a <a href="/content/concepts/udf/" target="_top">user-defined function</a> (UDF). </p>
      <p>(async)</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">environment\_name</td>
              <td>Name of the environment to be altered. </td>
            </tr>

            <tr>
              <td className="paramname">action</td>

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

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#aed8aa50e94b6c4135898fdd8f4919e0c">INSTALL\_PACKAGE</a>: Install a python package from PyPI, an external data source or KiFS. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a2dc17a748f10e3d962d740bf7ff38571">INSTALL\_REQUIREMENTS</a>: Install packages from a requirements file. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a113b841510108c1174e2a04fa986e288">UNINSTALL\_PACKAGE</a>: Uninstall a python package. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#aabb250d49046ab48bc0d162cff88474a">UNINSTALL\_REQUIREMENTS</a>: Uninstall packages from a requirements file. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#abab1c0f769205dd255dae898bc67f058">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/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a858a0a5cbc446bbd4845125506f8b423">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="paramname">\_value</td>
              <td>The value of the modification, depending on <span className="em">action</span> . For example, if <span className="em">action</span> is <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#aed8aa50e94b6c4135898fdd8f4919e0c">INSTALL\_PACKAGE</a>, this would be the python package name. If <span className="em">action</span> is <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Action#a2dc17a748f10e3d962d740bf7ff38571">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/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options#a128c188dfbb202901fd2a1626b1f3207">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="paramname">options</td>

              <td>
                Optional parameters.

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1AlterEnvironmentRequest_1_1Options#a128c188dfbb202901fd2a1626b1f3207">DATASOURCE\_NAME</a>: Name of an existing external data source from which packages specified in <span className="em">\_value</span> can be loaded. </li>
                </ul>

                The default value is an empty Dictionary.
              </td>
            </tr>

            <tr>
              <td className="paramname">cancellationToken</td>
              <td>Cancellation token to cancel the operation.</td>
            </tr>
          </table>
        </div>
      </div>

      <div className="dl section return">
        <div className="dt">Returns</div>
        <div className="dd">Task that returns the response object containing the result of the operation.</div>
      </div>

      <p className="definition">Definition at line <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs#L10695">10695</a> of file <a className="el" href="https://github.com/kineticadb/kinetica-api-cs/blob/master/Kinetica/KineticaFunctions.cs">KineticaFunctions.cs</a>.</p>
    </div>
  </div>
</div>