# ExecutionOptions

<div class="jsdoc-content"><header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>ExecutionOptions<span class="signature">()</span><span class="type-signature"></span></h2>
        
            <div class="class-description"><p>A base class that represents a wrapper around the user provided query options with getter methods and proper
default values.</p>
<p>Note that getter methods might return <code>undefined</code> when not set on the query options or default
<a href="Client.html">Client</a> options.</p></div>
        
    
</header>


    
        

    
    </div>

## Constructor

<div class="jsdoc-content">
    

    
    <h4 class="name" id="ExecutionOptions"><span class="type-signature"></span>new ExecutionOptions<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Creates a new instance of <a href="ExecutionOptions.html">ExecutionOptions</a>.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L27" target="_blank" rel="noopener">execution-options.ts, line 27</a></p></div>




















    
    

    

    

    

    

    

    

    

    
        </div>

## Methods

<div class="jsdoc-content">

        
            

    

    
    <h4 class="name" id="getCaptureStackTrace"><span class="type-signature">(abstract) </span>getCaptureStackTrace<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Determines if the stack trace before the query execution should be maintained.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L71" target="_blank" rel="noopener">execution-options.ts, line 71</a></p></div>




















        
            

    

    
    <h4 class="name" id="getConsistency"><span class="type-signature">(abstract) </span>getConsistency<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the <a href="types/index.html#~consistencies">Consistency level</a> to be used for the execution.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L79" target="_blank" rel="noopener">execution-options.ts, line 79</a></p></div>




















        
            

    

    
    <h4 class="name" id="getCustomPayload"><span class="type-signature">(abstract) </span>getCustomPayload<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Key-value payload to be passed to the server. On the server side, implementations of QueryHandler can use
this data.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L88" target="_blank" rel="noopener">execution-options.ts, line 88</a></p></div>




















        
            

    

    
    <h4 class="name" id="getFetchSize"><span class="type-signature">(abstract) </span>getFetchSize<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the amount of rows to retrieve per page.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L96" target="_blank" rel="noopener">execution-options.ts, line 96</a></p></div>




















        
            

    

    
    <h4 class="name" id="getFixedHost"><span class="type-signature"></span>getFixedHost<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>When a fixed host is set on the query options and the query plan for the load-balancing policy is not used, it
gets the host that should handle the query.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L104" target="_blank" rel="noopener">execution-options.ts, line 104</a></p></div>




















        
            

    

    
    <h4 class="name" id="getHints"><span class="type-signature">(abstract) </span>getHints<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the type hints for parameters given in the query, ordered as for the parameters.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L112" target="_blank" rel="noopener">execution-options.ts, line 112</a></p></div>




















        
            

    

    
    <h4 class="name" id="getKeyspace"><span class="type-signature">(abstract) </span>getKeyspace<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the keyspace for the query when set at query options level.</p>
<p>Note that this method will return <code>undefined</code> when the keyspace is not set at query options level.
It will only return the keyspace name when the user provided a different keyspace than the current
<a href="Client.html">Client</a> keyspace.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L177" target="_blank" rel="noopener">execution-options.ts, line 177</a></p></div>




















        
            

    

    
    <h4 class="name" id="getLoadBalancingPolicy"><span class="type-signature"></span>getLoadBalancingPolicy<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the load balancing policy used for this execution.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L184" target="_blank" rel="noopener">execution-options.ts, line 184</a></p></div>




















        
            

    

    
    <h4 class="name" id="getPageState"><span class="type-signature">(abstract) </span>getPageState<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the Buffer representing the paging state.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L202" target="_blank" rel="noopener">execution-options.ts, line 202</a></p></div>




















        
            

    

    
    <h4 class="name" id="getRawQueryOptions"><span class="type-signature"></span>getRawQueryOptions<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the query options as provided to the execution method without setting the default values.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L219" target="_blank" rel="noopener">execution-options.ts, line 219</a></p></div>




















        
            

    

    
    <h4 class="name" id="getReadTimeout"><span class="type-signature"></span>getReadTimeout<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the legacy per-attempt read timeout setting. This setting is unsupported
and does not affect native execution. Retained for API compatibility.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L239" target="_blank" rel="noopener">execution-options.ts, line 239</a></p></div>
<div class="admonition warning"><p class="admonition-title">Deprecated</p><p>Use <a href="ExecutionOptions.html#getRequestTimeout">ExecutionOptions#getRequestTimeout</a>.</p></div>




















        
            

    

    
    <h4 class="name" id="getRequestTimeout"><span class="type-signature">(abstract) </span>getRequestTimeout<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the client-side deadline in milliseconds for statement execution
(acquiring a single page of results).</p>
<p>A value of <code>0</code> disables the deadline for the execution. Default: <code>undefined</code>.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L230" target="_blank" rel="noopener">execution-options.ts, line 230</a></p></div>




















        
            

    

    
    <h4 class="name" id="getRetryPolicy"><span class="type-signature">(abstract) </span>getRetryPolicy<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the <a href="policies/retry/index.html">retry policy</a> to be used.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L247" target="_blank" rel="noopener">execution-options.ts, line 247</a></p></div>




















        
            

    

    
    <h4 class="name" id="getRoutingKey"><span class="type-signature">(abstract) </span>getRoutingKey<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the partition key(s) to determine which coordinator should be used for the query.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L284" target="_blank" rel="noopener">execution-options.ts, line 284</a></p></div>




















        
            

    

    
    <h4 class="name" id="getSerialConsistency"><span class="type-signature">(abstract) </span>getSerialConsistency<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the the consistency level to be used for the serial phase of conditional updates.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L303" target="_blank" rel="noopener">execution-options.ts, line 303</a></p></div>




















        
            

    

    
    <h4 class="name" id="getTimestamp"><span class="type-signature">(abstract) </span>getTimestamp<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Gets the provided timestamp for the execution in microseconds from the unix epoch (00:00:00, January 1st, 1970).</p>
<p>When a timestamp generator is used, this method returns <code>undefined</code>.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L313" target="_blank" rel="noopener">execution-options.ts, line 313</a></p></div>




















        
            

    

    
    <h4 class="name" id="isAutoPage"><span class="type-signature">(abstract) </span>isAutoPage<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Determines whether the driver must retrieve the following result pages automatically.</p>
<p>This setting is only considered by the <a href="Client.html#eachRow">Client#eachRow()</a> method.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L122" target="_blank" rel="noopener">execution-options.ts, line 122</a></p></div>




















        
            

    

    
    <h4 class="name" id="isBatchCounter"><span class="type-signature">(abstract) </span>isBatchCounter<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Determines whether its a counter batch. Only valid for <a href="Client.html#batch">Client#batch()</a>, it will be ignored by
other methods.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L131" target="_blank" rel="noopener">execution-options.ts, line 131</a></p></div>




















        
            

    

    
    <h4 class="name" id="isBatchLogged"><span class="type-signature">(abstract) </span>isBatchLogged<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Determines whether the batch should be written to the batchlog. Only valid for
<a href="Client.html#batch">Client#batch()</a>, it will be ignored by other methods.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L140" target="_blank" rel="noopener">execution-options.ts, line 140</a></p></div>




















        
            

    

    
    <h4 class="name" id="isIdempotent"><span class="type-signature">(abstract) </span>isIdempotent<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Determines whether the query can be applied multiple times without changing the result beyond the initial
application.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L149" target="_blank" rel="noopener">execution-options.ts, line 149</a></p></div>




















        
            

    

    
    <h4 class="name" id="isPrepared"><span class="type-signature">(abstract) </span>isPrepared<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Determines whether the query must be prepared beforehand.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L157" target="_blank" rel="noopener">execution-options.ts, line 157</a></p></div>




















        
            

    

    
    <h4 class="name" id="isQueryTracing"><span class="type-signature">(abstract) </span>isQueryTracing<span class="signature">()</span><span class="type-signature"></span></h4>
    

    



<div class="description">
    <p>Determines whether query tracing is enabled for the execution.</p>
</div>













<div class="admonition note"><p class="admonition-title">Source</p><p><a href="https://github.com/scylladb/nodejs-rs-driver/blob/v0.7.1/lib/execution-options.ts#L165" target="_blank" rel="noopener">execution-options.ts, line 165</a></p></div></div>
