<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>A callback from the table building <code>Knex.schemaBuilder</code> calls.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">callback</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">callback</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Determine if the blueprint has a create command.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">creating</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">()</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Sets the engine to use when creating the table in MySql</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">engine</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">name</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="k">if</span><spanclass="p">(</span><spanclass="o">!</span><spanclass="k">this</span><spanclass="p">.</span><spanclass="nx">creating</span><spanclass="p">())</span><spanclass="k">throw</span><spanclass="k">new</span><spanclass="nb">Error</span><spanclass="p">(</span><spanclass="s1">'The `engine` modifier may only be used while creating a table.'</span><spanclass="p">);</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Sets the character set for the table in MySql</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">charset</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">charset</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="k">if</span><spanclass="p">(</span><spanclass="o">!</span><spanclass="k">this</span><spanclass="p">.</span><spanclass="nx">creating</span><spanclass="p">())</span><spanclass="k">throw</span><spanclass="k">new</span><spanclass="nb">Error</span><spanclass="p">(</span><spanclass="s1">'The `engine` modifier may only be used while creating a table.'</span><spanclass="p">);</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Sets the collation for the table in MySql</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">collate</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">collation</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="k">if</span><spanclass="p">(</span><spanclass="o">!</span><spanclass="k">this</span><spanclass="p">.</span><spanclass="nx">creating</span><spanclass="p">())</span><spanclass="k">throw</span><spanclass="k">new</span><spanclass="nb">Error</span><spanclass="p">(</span><spanclass="s1">'The `engine` modifier may only be used while creating a table.'</span><spanclass="p">);</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Adds a comment to the current table being created.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">comment</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">comment</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Indicate that the given columns should be dropped.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">dropColumn</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">columns</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Indicate that the given columns should be dropped.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">dropColumns</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">()</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Indicate that the given primary key should be dropped.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">dropPrimary</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">index</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Indicate that the given unique key should be dropped.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">dropUnique</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">index</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Indicate that the given index should be dropped.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">dropIndex</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">index</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Indicate that the given foreign key should be dropped.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">dropForeign</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">index</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Specify the primary key(s) for the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">primary</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">columns</span><spanclass="p">,</span><spanclass="nx">name</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Specify a unique index for the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">unique</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">columns</span><spanclass="p">,</span><spanclass="nx">name</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Specify an index for the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">index</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">columns</span><spanclass="p">,</span><spanclass="nx">name</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Rename a column from one value to another value.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">renameColumn</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">from</span><spanclass="p">,</span><spanclass="nx">to</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Specify a foreign key for the table, also getting any
relevant info from the chain during column.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">foreign</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">,</span><spanclass="nx">name</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new auto-incrementing column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">increments</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new auto-incrementing big-int on the table</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">bigIncrements</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new string column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">string</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">,</span><spanclass="nx">length</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Alias varchar to string</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">varchar</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">,</span><spanclass="nx">length</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new text column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">text</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">,</span><spanclass="nx">length</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new integer column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">integer</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">,</span><spanclass="nx">length</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new biginteger column on the table</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">bigInteger</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new tinyinteger column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">tinyInteger</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Alias for tinyinteger column.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">tinyint</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new float column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="kr">float</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">,</span><spanclass="nx">precision</span><spanclass="p">,</span><spanclass="nx">scale</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new decimal column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">decimal</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">,</span><spanclass="nx">precision</span><spanclass="p">,</span><spanclass="nx">scale</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Alias to "bool"</p></div></div><divclass="code"><divclass="wrapper"><spanclass="kr">boolean</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new boolean column on the table</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">bool</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new date column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">date</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new date-time column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">dateTime</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new time column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">time</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new timestamp column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">timestamp</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Add creation and update dateTime's to the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">timestamps</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">()</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Alias to enum.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="s2">"enum"</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">,</span><spanclass="nx">allowed</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new enum column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">enu</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">,</span><spanclass="nx">allowed</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new bit column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">bit</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">,</span><spanclass="nx">length</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new binary column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">binary</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new json column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">json</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new uuid column on the table.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">uuid</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><hr/></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Create a new drop index command on the blueprint.
to drop an index merely by specifying the columns involved.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">_dropIndexCommand</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">type</span><spanclass="p">,</span><spanclass="nx">index</span><spanclass="p">)</span><spanclass="p">{</span>
index type, such as primary or index, which makes the index unique.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">_indexCommand</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">type</span><spanclass="p">,</span><spanclass="nx">columns</span><spanclass="p">,</span><spanclass="nx">index</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Add a new column to the blueprint.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">_addColumn</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">type</span><spanclass="p">,</span><spanclass="nx">name</span><spanclass="p">,</span><spanclass="nx">parameters</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="k">if</span><spanclass="p">(</span><spanclass="o">!</span><spanclass="nx">name</span><spanclass="p">)</span><spanclass="k">throw</span><spanclass="k">new</span><spanclass="nb">Error</span><spanclass="p">(</span><spanclass="s1">'A `name` must be defined to add a column'</span><spanclass="p">);</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Add a new command to the blueprint.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">_addCommand</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">name</span><spanclass="p">,</span><spanclass="nx">parameters</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="kd">var</span><spanclass="nx">ForeignChainable</span><spanclass="o">=</span><spanclass="p">{</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Sets the "column" that the current column references
as the a foreign key</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">references</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">column</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Sets the "table" where the foreign key column is located.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">inTable</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">table</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>SQL command to run "onDelete"</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">onDelete</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">command</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>SQL command to run "onUpdate"</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">onUpdate</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">command</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="kd">var</span><spanclass="nx">ChainableColumn</span><spanclass="o">=</span><spanclass="nx">_</span><spanclass="p">.</span><spanclass="nx">extend</span><spanclass="p">({</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Sets the default value for a column.
to be used as default values.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">defaultTo</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">value</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Sets an integer as unsigned, is a no-op
if the column type is not an integer.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">unsigned</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">()</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Allows the column to contain null values.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">nullable</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">()</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Disallow the column from containing null values.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">notNull</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">()</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Disallow the column from containing null values.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">notNullable</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">()</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Adds an index on the specified column.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">index</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">name</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Sets this column as the primary key.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">primary</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">name</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Sets this column as unique.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">unique</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">name</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Sets the column to be inserted after another,
used in MySql alter tables.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">after</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">name</span><spanclass="p">)</span><spanclass="p">{</span>
<spanclass="p">},</span></div></div></div><divclass="segment"><divclass="comments"><divclass="wrapper"><p>Adds a comment to this column.</p></div></div><divclass="code"><divclass="wrapper"><spanclass="nx">comment</span><spanclass="o">:</span><spanclass="kd">function</span><spanclass="p">(</span><spanclass="nx">comment</span><spanclass="p">)</span><spanclass="p">{</span>
