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

# lockTable

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

  <h2 className="memtitle"><span className="permalink"><a href="#a2d10c6b72e3bb1cb519c7e0e8daa5034">◆ </a></span>lockTable() <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_1LockTableResponse">LockTableResponse</a> kinetica.Kinetica.lockTable </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1LockTableRequest">LockTableRequest</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>Manages global access to a table's data. </p>
      <p>By default a table has a <a className="el" href="/content/api/cs/classkinetica_1_1LockTableRequest#ad1ecf792297192d10168b78238710b24">lock\_type</a> of <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a0856f08f9fee2f790876e8bc2c38c091">READ\_WRITE</a>, indicating all operations are permitted. A user may request a <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aabaf77699bd07a3fe1ed59cd474f8965">READ\_ONLY</a> or a <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a33b6dc476c65800190356884a0288eaf">WRITE\_ONLY</a> lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When <a className="el" href="/content/api/cs/classkinetica_1_1LockTableRequest#ad1ecf792297192d10168b78238710b24">lock\_type</a> is <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aaaa2abf27f8362c0e95c97cb46ed88a7">NO\_ACCESS</a> then no operations are permitted on the table. The lock status can be queried by setting <a className="el" href="/content/api/cs/classkinetica_1_1LockTableRequest#ad1ecf792297192d10168b78238710b24">lock\_type</a> to <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">STATUS</a>.</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#L53261">53261</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="acf878d9da570c78a0141baee1fe12461" />

  <h2 className="memtitle"><span className="permalink"><a href="#acf878d9da570c78a0141baee1fe12461">◆ </a></span>lockTable() <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_1LockTableResponse">LockTableResponse</a> kinetica.Kinetica.lockTable </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">table\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">lock\_type</span></span><span className="paramdefsep"> = </span><span className="paramdefval"><a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">LockTableRequest::LockType::STATUS</a></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>Manages global access to a table's data. </p>
      <p>By default a table has a <span className="em">lock\_type</span> of <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a0856f08f9fee2f790876e8bc2c38c091">READ\_WRITE</a>, indicating all operations are permitted. A user may request a <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aabaf77699bd07a3fe1ed59cd474f8965">READ\_ONLY</a> or a <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a33b6dc476c65800190356884a0288eaf">WRITE\_ONLY</a> lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When <span className="em">lock\_type</span> is <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aaaa2abf27f8362c0e95c97cb46ed88a7">NO\_ACCESS</a> then no operations are permitted on the table. The lock status can be queried by setting <span className="em">lock\_type</span> to <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">STATUS</a>.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">table\_name</td>
              <td>Name of the table to be locked, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. It must be a currently existing table or view.</td>
            </tr>

            <tr>
              <td className="paramname">lock\_type</td>

              <td>
                The type of lock being applied to the table. Setting it to <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">STATUS</a> will return the current lock status of the table without changing it. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">STATUS</a>: Show locked status. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aaaa2abf27f8362c0e95c97cb46ed88a7">NO\_ACCESS</a>: Allow no read/write operations. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aabaf77699bd07a3fe1ed59cd474f8965">READ\_ONLY</a>: Allow only read operations. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a33b6dc476c65800190356884a0288eaf">WRITE\_ONLY</a>: Allow only write operations. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a0856f08f9fee2f790876e8bc2c38c091">READ\_WRITE</a>: Allow all read/write operations. </li>
                </ul>

                The default value is <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">STATUS</a>.
              </td>
            </tr>

            <tr>
              <td className="paramname">options</td>
              <td>Optional parameters. 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#L53358">53358</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="a3253000d19cded5f62088c305cde9e0d" />

  <h2 className="memtitle"><span className="permalink"><a href="#a3253000d19cded5f62088c305cde9e0d">◆ </a></span>LockTableAsync() <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_1LockTableResponse">LockTableResponse</a> > kinetica.Kinetica.LockTableAsync </td>
                <td>(</td>
                <td className="paramtype"><a className="el" href="/content/api/cs/classkinetica_1_1LockTableRequest">LockTableRequest</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>Manages global access to a table's data. </p>
      <p>(async) </p>
      <p>By default a table has a <a className="el" href="/content/api/cs/classkinetica_1_1LockTableRequest#ad1ecf792297192d10168b78238710b24">lock\_type</a> of <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a0856f08f9fee2f790876e8bc2c38c091">READ\_WRITE</a>, indicating all operations are permitted. A user may request a <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aabaf77699bd07a3fe1ed59cd474f8965">READ\_ONLY</a> or a <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a33b6dc476c65800190356884a0288eaf">WRITE\_ONLY</a> lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When <a className="el" href="/content/api/cs/classkinetica_1_1LockTableRequest#ad1ecf792297192d10168b78238710b24">lock\_type</a> is <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aaaa2abf27f8362c0e95c97cb46ed88a7">NO\_ACCESS</a> then no operations are permitted on the table. The lock status can be queried by setting <a className="el" href="/content/api/cs/classkinetica_1_1LockTableRequest#ad1ecf792297192d10168b78238710b24">lock\_type</a> to <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">STATUS</a>.</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#L53290">53290</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="a6540de220ef565720fe629effe843f34" />

  <h2 className="memtitle"><span className="permalink"><a href="#a6540de220ef565720fe629effe843f34">◆ </a></span>LockTableAsync() <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_1LockTableResponse">LockTableResponse</a> > kinetica.Kinetica.LockTableAsync </td>
                <td>(</td>
                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">table\_name</span></span>, </td>
              </tr>

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

                <td />

                <td className="paramtype">string</td>
                <td className="paramname"><span className="paramname"><span className="em">lock\_type</span></span><span className="paramdefsep"> = </span><span className="paramdefval"><a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">LockTableRequest::LockType::STATUS</a></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>Manages global access to a table's data. </p>
      <p>(async) </p>
      <p>By default a table has a <span className="em">lock\_type</span> of <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a0856f08f9fee2f790876e8bc2c38c091">READ\_WRITE</a>, indicating all operations are permitted. A user may request a <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aabaf77699bd07a3fe1ed59cd474f8965">READ\_ONLY</a> or a <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a33b6dc476c65800190356884a0288eaf">WRITE\_ONLY</a> lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When <span className="em">lock\_type</span> is <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aaaa2abf27f8362c0e95c97cb46ed88a7">NO\_ACCESS</a> then no operations are permitted on the table. The lock status can be queried by setting <span className="em">lock\_type</span> to <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">STATUS</a>.</p>

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

        <div className="dd">
          <table className="params">
            <tr>
              <td className="paramname">table\_name</td>
              <td>Name of the table to be locked, in \[schema\_name.]table\_name format, using standard <a href="/content/concepts/tables/#table-name-resolution" target="_top">name resolution rules</a>. It must be a currently existing table or view.</td>
            </tr>

            <tr>
              <td className="paramname">lock\_type</td>

              <td>
                The type of lock being applied to the table. Setting it to <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">STATUS</a> will return the current lock status of the table without changing it. Supported values:

                <ul>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">STATUS</a>: Show locked status. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aaaa2abf27f8362c0e95c97cb46ed88a7">NO\_ACCESS</a>: Allow no read/write operations. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#aabaf77699bd07a3fe1ed59cd474f8965">READ\_ONLY</a>: Allow only read operations. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a33b6dc476c65800190356884a0288eaf">WRITE\_ONLY</a>: Allow only write operations. </li>
                  <li> <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a0856f08f9fee2f790876e8bc2c38c091">READ\_WRITE</a>: Allow all read/write operations. </li>
                </ul>

                The default value is <a className="el" href="/content/api/cs/structkinetica_1_1LockTableRequest_1_1LockType#a4c022f79f4fc07d842cb17b17fac4dc4">STATUS</a>.
              </td>
            </tr>

            <tr>
              <td className="paramname">options</td>
              <td>Optional parameters. 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#L53427">53427</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>