# 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.6.1/lib/execution-options.js#L19" target="_blank" rel="noopener">execution-options.js, line 19</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"> &rarr; {Boolean}</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.6.1/lib/execution-options.js#L67" target="_blank" rel="noopener">execution-options.js, line 67</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getConsistency"><span class="type-signature">(abstract) </span>getConsistency<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</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.6.1/lib/execution-options.js#L74" target="_blank" rel="noopener">execution-options.js, line 74</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getCustomPayload"><span class="type-signature">(abstract) </span>getCustomPayload<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</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.6.1/lib/execution-options.js#L82" target="_blank" rel="noopener">execution-options.js, line 82</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Object</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getFetchSize"><span class="type-signature">(abstract) </span>getFetchSize<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</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.6.1/lib/execution-options.js#L89" target="_blank" rel="noopener">execution-options.js, line 89</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getFixedHost"><span class="type-signature"></span>getFixedHost<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="Host.html">Host</a>}</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.6.1/lib/execution-options.js#L96" target="_blank" rel="noopener">execution-options.js, line 96</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="Host.html">Host</a></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getHints"><span class="type-signature">(abstract) </span>getHints<span class="signature">()</span><span class="type-signature"> &rarr; {Array&lt;<a href="ColumnInfo.html">ColumnInfo</a>>|Array&lt;Array&lt;<a href="ColumnInfo.html">ColumnInfo</a>>>|undefined}</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.6.1/lib/execution-options.js#L103" target="_blank" rel="noopener">execution-options.js, line 103</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Array&lt;<a href="ColumnInfo.html">ColumnInfo</a>></span>
|

<span class="param-type">Array&lt;Array&lt;<a href="ColumnInfo.html">ColumnInfo</a>>></span>
|

<span class="param-type">undefined</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getKeyspace"><span class="type-signature">(abstract) </span>getKeyspace<span class="signature">()</span><span class="type-signature"> &rarr; {String}</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.6.1/lib/execution-options.js#L161" target="_blank" rel="noopener">execution-options.js, line 161</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getLoadBalancingPolicy"><span class="type-signature"></span>getLoadBalancingPolicy<span class="signature">()</span><span class="type-signature"> &rarr; {LoadBalancingPolicy}</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.6.1/lib/execution-options.js#L167" target="_blank" rel="noopener">execution-options.js, line 167</a></p></div>















<h5>Returns:</h5>

        
<div class="param-desc">
    <p>A <code>LoadBalancingPolicy</code> instance, it can't be <code>undefined</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">LoadBalancingPolicy</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getPageState"><span class="type-signature">(abstract) </span>getPageState<span class="signature">()</span><span class="type-signature"> &rarr; {Buffer}</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.6.1/lib/execution-options.js#L181" target="_blank" rel="noopener">execution-options.js, line 181</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Buffer</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getRawQueryOptions"><span class="type-signature"></span>getRawQueryOptions<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="globals.html#QueryOptions">QueryOptions</a>}</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.6.1/lib/execution-options.js#L194" target="_blank" rel="noopener">execution-options.js, line 194</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type"><a href="globals.html#QueryOptions">QueryOptions</a></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getReadTimeout"><span class="type-signature">(abstract) </span>getReadTimeout<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</span></h4>
    

    



<div class="description">
    <p>Gets the timeout in milliseconds to be used for the execution per coordinator.</p>
<p>A value of <code>0</code> disables client side read timeout 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.6.1/lib/execution-options.js#L203" target="_blank" rel="noopener">execution-options.js, line 203</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getRetryPolicy"><span class="type-signature">(abstract) </span>getRetryPolicy<span class="signature">()</span><span class="type-signature"> &rarr; {RetryPolicy}</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.6.1/lib/execution-options.js#L210" target="_blank" rel="noopener">execution-options.js, line 210</a></p></div>















<h5>Returns:</h5>

        
<div class="param-desc">
    <p>A <code>RetryPolicy</code> instance, it can't be <code>undefined</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">RetryPolicy</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getRoutingKey"><span class="type-signature">(abstract) </span>getRoutingKey<span class="signature">()</span><span class="type-signature"> &rarr; {Buffer|Array&lt;Buffer>}</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.6.1/lib/execution-options.js#L239" target="_blank" rel="noopener">execution-options.js, line 239</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Buffer</span>
|

<span class="param-type">Array&lt;Buffer></span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getSerialConsistency"><span class="type-signature">(abstract) </span>getSerialConsistency<span class="signature">()</span><span class="type-signature"> &rarr; {Number}</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.6.1/lib/execution-options.js#L254" target="_blank" rel="noopener">execution-options.js, line 254</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="getTimestamp"><span class="type-signature">(abstract) </span>getTimestamp<span class="signature">()</span><span class="type-signature"> &rarr; {Number|Long|undefined|null}</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.6.1/lib/execution-options.js#L263" target="_blank" rel="noopener">execution-options.js, line 263</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Number</span>
|

<span class="param-type">Long</span>
|

<span class="param-type">undefined</span>
|

<span class="param-type">null</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="isAutoPage"><span class="type-signature">(abstract) </span>isAutoPage<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</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.6.1/lib/execution-options.js#L112" target="_blank" rel="noopener">execution-options.js, line 112</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="isBatchCounter"><span class="type-signature">(abstract) </span>isBatchCounter<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</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.6.1/lib/execution-options.js#L120" target="_blank" rel="noopener">execution-options.js, line 120</a></p></div>















<h5>Returns:</h5>

        
<div class="param-desc">
    <p>A <code>Boolean</code> value, it can't be <code>undefined</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="isBatchLogged"><span class="type-signature">(abstract) </span>isBatchLogged<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</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.6.1/lib/execution-options.js#L128" target="_blank" rel="noopener">execution-options.js, line 128</a></p></div>















<h5>Returns:</h5>

        
<div class="param-desc">
    <p>A <code>Boolean</code> value, it can't be <code>undefined</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="isIdempotent"><span class="type-signature">(abstract) </span>isIdempotent<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</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.6.1/lib/execution-options.js#L136" target="_blank" rel="noopener">execution-options.js, line 136</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="isPaged"><span class="type-signature">(abstract) </span>isPaged<span class="signature">()</span><span class="type-signature"> &rarr; {boolean}</span></h4>
    

    



<div class="description">
    <p>Determines if the query should be paged.</p>
</div>













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















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="isPrepared"><span class="type-signature">(abstract) </span>isPrepared<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</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.6.1/lib/execution-options.js#L143" target="_blank" rel="noopener">execution-options.js, line 143</a></p></div>















<h5>Returns:</h5>

        
<div class="param-desc">
    <p>A <code>Boolean</code> value, it can't be <code>undefined</code>.</p>
</div>



<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl>

    





        
            

    

    
    <h4 class="name" id="isQueryTracing"><span class="type-signature">(abstract) </span>isQueryTracing<span class="signature">()</span><span class="type-signature"> &rarr; {Boolean}</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.6.1/lib/execution-options.js#L150" target="_blank" rel="noopener">execution-options.js, line 150</a></p></div>















<h5>Returns:</h5>

        


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">Boolean</span>


    </dd>
</dl></div>
