# mapping

<div class="jsdoc-content"><header>
    
        
            
        
    
</header>


    
        
            <div class="description"><p>Module containing classes and fields related to the Mapper.</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/mapping/index.js#L3" target="_blank" rel="noopener">mapping/index.js, line 3</a></p></div>




















        
    
    

    

    

    
        </div>

## Classes

<div class="jsdoc-content">

        <dl>
            <dt><a href="DefaultTableMappings.html">DefaultTableMappings</a></dt>
            <dd></dd>
        
            <dt><a href="Mapper.html">Mapper</a></dt>
            <dd></dd>
        
            <dt><a href="ModelBatchItem.html">ModelBatchItem</a></dt>
            <dd></dd>
        
            <dt><a href="ModelMapper.html">ModelMapper</a></dt>
            <dd></dd>
        
            <dt><a href="Result.html">Result</a></dt>
            <dd></dd>
        
            <dt><a href="UnderscoreCqlToCamelCaseMappings.html">UnderscoreCqlToCamelCaseMappings</a></dt>
            <dd></dd>
        </dl>
    

    
        </div>

## Interfaces

<div class="jsdoc-content">

        <dl>
            <dt><a href="TableMappings.html">TableMappings</a></dt>
            <dd></dd>
        </dl>
    

    

    

    
        </div>

## Members

<div class="jsdoc-content">

        
            
<h3 class="name" id="~q"><span class="type-signature">(inner, constant) </span>q<span class="type-signature"> :Object</span></h3>




<div class="description">
    <p>Contains functions that represents operators in a query.</p>
</div>



    <h4>Type:</h4>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h4 class="subsection-title">Properties:</h4>

    

<table class="props docutils align-default">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>in_</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>Represents the CQL operator &quot;IN&quot;.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>gt</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>Represents the CQL operator greater than &quot;&gt;&quot;.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>gte</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>Represents the CQL operator greater than or equals to &quot;&gt;=&quot; .</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lt</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>Represents the CQL operator less than &quot;&lt;&quot; .</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>lte</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>Represents the CQL operator less than or equals to &quot;&lt;=&quot; .</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>notEq</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>Represents the CQL operator not equals to &quot;!=&quot; .</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>and</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>When applied to a property, it represents two CQL conditions on the same column separated
by the logical AND operator, e.g: &quot;col1 &gt;= x col &lt; y&quot;</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>incr</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>Represents the CQL increment assignment used for counters, e.g: &quot;col = col + x&quot;</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>decr</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>Represents the CQL decrement assignment used for counters, e.g: &quot;col = col - x&quot;</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>append</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>Represents the CQL append assignment used for collections, e.g: &quot;col = col + x&quot;</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>prepend</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>Represents the CQL prepend assignment used for lists, e.g: &quot;col = x + col&quot;</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>remove</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            
            </td>

            

            

            <td class="description last"><p>Represents the CQL remove assignment used for collections, e.g: &quot;col = col - x&quot;</p></td>
        </tr>

    
    </tbody>
</table>




<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/mapping/q.js#L84" target="_blank" rel="noopener">mapping/q.js, line 84</a></p></div>






        
    

    

    
        </div>

## Type Definitions

<div class="jsdoc-content">

        
                
<h3 class="name" id="~MappingOptions">MappingOptions</h3>




<div class="description">
    <p>Represents the mapping options.</p>
</div>



    <h4>Type:</h4>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h4 class="subsection-title">Properties:</h4>

    

<table class="props docutils align-default">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>models</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object&lt;String, ModelOptions></span>


            
            </td>

            

            

            <td class="description last"><p>An associative array containing the
name of the model as key and the table and column information as value.</p></td>
        </tr>

    
    </tbody>
</table>




<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/mapping/mapper.js#L196" target="_blank" rel="noopener">mapping/mapper.js, line 196</a></p></div>






            
                
<h3 class="name" id="~ModelOptions">ModelOptions</h3>




<div class="description">
    <p>Represents a set of options that applies to a certain model.</p>
</div>



    <h4>Type:</h4>
    <ul>
        <li>
            
<span class="param-type">Object</span>


        </li>
    </ul>





    <h4 class="subsection-title">Properties:</h4>

    

<table class="props docutils align-default">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>tables</code></td>
            

            <td class="type">
            
                
<span class="param-type">Array&lt;String></span>
|

<span class="param-type">Array&lt;{name, isView}></span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last"><p>An Array containing the name of the tables or An Array
containing the name and isView property to describe the table.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>mappings</code></td>
            

            <td class="type">
            
                
<span class="param-type">TableMappings</span>


            
            </td>

            
                <td class="attributes">
                

                
                </td>
            

            

            <td class="description last"><p>The TableMappings implementation instance that is used to convert from column
names to property names and the other way around.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>columnNames</code></td>
            

            <td class="type">
            
                
<span class="param-type">Object&lt;String, String></span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"><p>An associative array containing the name of the columns and
properties that doesn't follow the convention defined in the <code>TableMappings</code>.</p></td>
        </tr>

    

        <tr>
            
                <td class="name"><code>keyspace</code></td>
            

            <td class="type">
            
                
<span class="param-type">String</span>


            
            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                
                </td>
            

            

            <td class="description last"><p>The name of the keyspace. Only mandatory when the Client is not using a keyspace.</p></td>
        </tr>

    
    </tbody>
</table>




<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/mapping/mapper.js#L203" target="_blank" rel="noopener">mapping/mapper.js, line 203</a></p></div></div>
