<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>web2py.gluon.dal.Field</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="web2py.gluon-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package web2py ::
<a href="web2py.gluon-module.html">Package gluon</a> ::
<a href="web2py.gluon.dal-module.html">Module dal</a> ::
Class Field
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="web2py.gluon.dal.Field-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Field</h1><span class="codelink"><a href="web2py.gluon.dal-pysrc.html#Field">source code</a></span><br /><br />
<pre class="base-tree">
object --+
|
<a href="web2py.gluon.dal.Expression-class.html">Expression</a> --+
|
<strong class="uidshort">Field</strong>
</pre>
<hr />
<p>an instance of this class represents a database field</p>
example:
<pre class="literalblock">
a = Field(name, 'string', length=32, default=None, required=False,
requires=IS_NOT_EMPTY(), ondelete='CASCADE',
notnull=False, unique=False,
uploadfield=True, widget=None, label=None, comment=None,
uploadfield=True, # True means store on disk,
# 'a_field_name' means store in this field in db
# False means file content will be discarded.
writable=True, readable=True, update=None, authorize=None,
autodelete=False, represent=None, uploadfolder=None,
uploadseparate=False # upload to separate directories by uuid_keys
# first 2 character and tablename.fieldname
# False - old behavior
# True - put uploaded file in
# <uploaddir>/<tablename>.<fieldname>/uuid_key[:2]
# directory)
</pre>
<p>to be used as argument of DAL.define_table</p>
<p>allowed field types: string, boolean, integer, double, text, blob,
date, time, datetime, upload, password</p>
strings must have a length of Adapter.maxcharlength by default (512 or
255 for mysql) fields should have a default or they will be required in
SQLFORMs the requires argument is used to validate the field input in
SQLFORMs<br /><br />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="web2py.gluon.dal.Field-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">fieldname</span>,
<span class="summary-sig-arg">type</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">string</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">length</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">default</span>=<span class="summary-sig-default"><function <lambda> at 0xd1ec80></span>,
<span class="summary-sig-arg">required</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">requires</span>=<span class="summary-sig-default"><function <lambda> at 0xd1ec80></span>,
<span class="summary-sig-arg">ondelete</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">CASCADE</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">notnull</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">unique</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">uploadfield</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">widget</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">label</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">comment</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">writable</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">readable</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">update</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">authorize</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">autodelete</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">represent</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">uploadfolder</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">uploadseparate</span>=<span class="summary-sig-default">True</span>,
<span class="summary-sig-arg">compute</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">custom_store</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">custom_retrieve</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">custom_delete</span>=<span class="summary-sig-default">1</span>)</span><br />
x.__init__(...) initializes x; see x.__class__.__doc__ for
signature</td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.dal-pysrc.html#Field.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="store"></a><span class="summary-sig-name">store</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">file</span>,
<span class="summary-sig-arg">filename</span>=<span class="summary-sig-default">1</span>,
<span class="summary-sig-arg">path</span>=<span class="summary-sig-default">1</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.dal-pysrc.html#Field.store">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="retrieve"></a><span class="summary-sig-name">retrieve</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>,
<span class="summary-sig-arg">path</span>=<span class="summary-sig-default">1</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.dal-pysrc.html#Field.retrieve">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="formatter"></a><span class="summary-sig-name">formatter</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.dal-pysrc.html#Field.formatter">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="validate"></a><span class="summary-sig-name">validate</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">value</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.dal-pysrc.html#Field.validate">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="count"></a><span class="summary-sig-name">count</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.dal-pysrc.html#Field.count">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__nonzero__"></a><span class="summary-sig-name">__nonzero__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.dal-pysrc.html#Field.__nonzero__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="web2py.gluon.dal.Field-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
str(x)</td>
<td align="right" valign="top">
<span class="codelink"><a href="web2py.gluon.dal-pysrc.html#Field.__str__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="web2py.gluon.dal.Expression-class.html">Expression</a></code></b>:
<code><a href="web2py.gluon.dal.Expression-class.html#__add__">__add__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__div__">__div__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__eq__">__eq__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__ge__">__ge__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__getitem__">__getitem__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__getslice__">__getslice__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__gt__">__gt__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__invert__">__invert__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__le__">__le__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__lt__">__lt__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__mod__">__mod__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__mul__">__mul__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__ne__">__ne__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__or__">__or__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#__sub__">__sub__</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#belongs">belongs</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#coalesce_zero">coalesce_zero</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#contains">contains</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#day">day</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#endswith">endswith</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#hour">hour</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#len">len</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#like">like</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#lower">lower</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#max">max</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#min">min</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#minutes">minutes</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#month">month</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#seconds">seconds</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#startswith">startswith</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#sum">sum</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#upper">upper</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#with_alias">with_alias</a></code>,
<code><a href="web2py.gluon.dal.Expression-class.html#year">year</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">fieldname</span>,
<span class="sig-arg">type</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">string</code><code class="variable-quote">'</code></span>,
<span class="sig-arg">length</span>=<span class="sig-default">1</span>,
<span class="sig-arg">default</span>=<span class="sig-default"><function <lambda> at 0xd1ec80></span>,
<span class="sig-arg">required</span>=<span class="sig-default">True</span>,
<span class="sig-arg">requires</span>=<span class="sig-default"><function <lambda> at 0xd1ec80></span>,
<span class="sig-arg">ondelete</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">CASCADE</code><code class="variable-quote">'</code></span>,
<span class="sig-arg">notnull</span>=<span class="sig-default">True</span>,
<span class="sig-arg">unique</span>=<span class="sig-default">True</span>,
<span class="sig-arg">uploadfield</span>=<span class="sig-default">True</span>,
<span class="sig-arg">widget</span>=<span class="sig-default">1</span>,
<span class="sig-arg">label</span>=<span class="sig-default">1</span>,
<span class="sig-arg">comment</span>=<span class="sig-default">1</span>,
<span class="sig-arg">writable</span>=<span class="sig-default">True</span>,
<span class="sig-arg">readable</span>=<span class="sig-default">True</span>,
<span class="sig-arg">update</span>=<span class="sig-default">1</span>,
<span class="sig-arg">authorize</span>=<span class="sig-default">1</span>,
<span class="sig-arg">autodelete</span>=<span class="sig-default">True</span>,
<span class="sig-arg">represent</span>=<span class="sig-default">1</span>,
<span class="sig-arg">uploadfolder</span>=<span class="sig-default">1</span>,
<span class="sig-arg">uploadseparate</span>=<span class="sig-default">True</span>,
<span class="sig-arg">compute</span>=<span class="sig-default">1</span>,
<span class="sig-arg">custom_store</span>=<span class="sig-default">1</span>,
<span class="sig-arg">custom_retrieve</span>=<span class="sig-default">1</span>,
<span class="sig-arg">custom_delete</span>=<span class="sig-default">1</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="web2py.gluon.dal-pysrc.html#Field.__init__">source code</a></span>
</td>
</table>
x.__init__(...) initializes x; see x.__class__.__doc__ for
signature
<dl class="fields">
<dt>Overrides:
<a href="web2py.gluon.dal.Expression-class.html#__init__">Expression.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="__str__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
<br /><em class="fname">(Informal representation operator)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="web2py.gluon.dal-pysrc.html#Field.__str__">source code</a></span>
</td>
</table>
str(x)
<dl class="fields">
<dt>Overrides:
<a href="web2py.gluon.dal.Expression-class.html#__str__">Expression.__str__</a>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="web2py.gluon-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.web2py.com">web2py Web Framework</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Thu Aug 4 00:47:00 2011
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>