anoopmb
/
frappe
1
0
複製 0
程式碼 問題管理 0 合併請求 0 版本發佈 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
314 Commit
1 分支
314 MiB
 
 
 
 
 
 
目錄樹: f97604bd61
分支列表 標籤列表
${ item.name }
Create branch ${ searchTerm }
from 'f97604bd61'
${ noResults }
frappe/docs/_build/html/webnotes.model.html

846 line
66 KiB
原始文件 Blame 文件歷史 

  1. 

  2. 

  3. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

  4.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

  5. 

  6. <html xmlns="http://www.w3.org/1999/xhtml">

  7.   <head>

  8.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  9.     

  10.     <title>model Package &mdash; WNFramework v1.8 documentation</title>

  11.     <link rel="stylesheet" href="_static/default.css" type="text/css" />

  12.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />

  13.     <script type="text/javascript">

  14.       var DOCUMENTATION_OPTIONS = {

  15.         URL_ROOT:    '',

  16.         VERSION:     '1.8',

  17.         COLLAPSE_INDEX: false,

  18.         FILE_SUFFIX: '.html',

  19.         HAS_SOURCE:  true

  20.       };

  21.     </script>

  22.     <script type="text/javascript" src="_static/jquery.js"></script>

  23.     <script type="text/javascript" src="_static/underscore.js"></script>

  24.     <script type="text/javascript" src="_static/doctools.js"></script>

  25.     <link rel="top" title="WNFramework v1.8 documentation" href="index.html" /> 

  26.   </head>

  27.   <body>

  28.     <div class="related">

  29.       <h3>Navigation</h3>

  30.       <ul>

  31.         <li class="right" style="margin-right: 10px">

  32.           <a href="genindex.html" title="General Index"

  33.              accesskey="I">index</a></li>

  34.         <li class="right" >

  35.           <a href="py-modindex.html" title="Python Module Index"

  36.              >modules</a> |</li>

  37.         <li><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li> 

  38.       </ul>

  39.     </div>  

  40. 

  41.     <div class="document">

  42.       <div class="documentwrapper">

  43.         <div class="bodywrapper">

  44.           <div class="body">

  45.             

  46.   <div class="section" id="model-package">

  47. <h1>model Package<a class="headerlink" href="#model-package" title="Permalink to this headline">¶</a></h1>

  48. <div class="section" id="id1">

  49. <h2><tt class="xref py py-mod docutils literal"><span class="pre">model</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>

  50. <span class="target" id="module-webnotes.model"></span><dl class="function">

  51. <dt id="webnotes.model.check_if_doc_is_linked">

  52. <tt class="descclassname">webnotes.model.</tt><tt class="descname">check_if_doc_is_linked</tt><big>(</big><em>dt</em>, <em>dn</em><big>)</big><a class="reference internal" href="_modules/webnotes/model.html#check_if_doc_is_linked"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.check_if_doc_is_linked" title="Permalink to this definition">¶</a></dt>

  53. <dd><p>Raises excption if the given doc(dt, dn) is linked in another record.</p>

  54. </dd></dl>

  55. 

  56. <dl class="function">

  57. <dt id="webnotes.model.clear_recycle_bin">

  58. <tt class="descclassname">webnotes.model.</tt><tt class="descname">clear_recycle_bin</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model.html#clear_recycle_bin"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.clear_recycle_bin" title="Permalink to this definition">¶</a></dt>

  59. <dd><p>Clears temporary records that have been deleted</p>

  60. </dd></dl>

  61. 

  62. <dl class="function">

  63. <dt id="webnotes.model.copytables">

  64. <tt class="descclassname">webnotes.model.</tt><tt class="descname">copytables</tt><big>(</big><em>srctype</em>, <em>src</em>, <em>srcfield</em>, <em>tartype</em>, <em>tar</em>, <em>tarfield</em>, <em>srcfields</em>, <em>tarfields=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/webnotes/model.html#copytables"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.copytables" title="Permalink to this definition">¶</a></dt>

  65. <dd></dd></dl>

  66. 

  67. <dl class="function">

  68. <dt id="webnotes.model.db_exists">

  69. <tt class="descclassname">webnotes.model.</tt><tt class="descname">db_exists</tt><big>(</big><em>dt</em>, <em>dn</em><big>)</big><a class="reference internal" href="_modules/webnotes/model.html#db_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_exists" title="Permalink to this definition">¶</a></dt>

  70. <dd></dd></dl>

  71. 

  72. <dl class="function">

  73. <dt id="webnotes.model.delete_doc">

  74. <tt class="descclassname">webnotes.model.</tt><tt class="descname">delete_doc</tt><big>(</big><em>doctype=None</em>, <em>name=None</em>, <em>doclist=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/model.html#delete_doc"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.delete_doc" title="Permalink to this definition">¶</a></dt>

  75. <dd><p>Deletes a doc(dt, dn) and validates if it is not submitted and not linked in a live record</p>

  76. </dd></dl>

  77. 

  78. <dl class="function">

  79. <dt id="webnotes.model.get_dt_labels">

  80. <tt class="descclassname">webnotes.model.</tt><tt class="descname">get_dt_labels</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model.html#get_dt_labels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.get_dt_labels" title="Permalink to this definition">¶</a></dt>

  81. <dd></dd></dl>

  82. 

  83. <dl class="function">

  84. <dt id="webnotes.model.get_link_fields">

  85. <tt class="descclassname">webnotes.model.</tt><tt class="descname">get_link_fields</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/model.html#get_link_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.get_link_fields" title="Permalink to this definition">¶</a></dt>

  86. <dd><p>Returns linked fields for dt as a tuple of (linked_doctype, linked_field)</p>

  87. </dd></dl>

  88. 

  89. <dl class="function">

  90. <dt id="webnotes.model.get_search_criteria">

  91. <tt class="descclassname">webnotes.model.</tt><tt class="descname">get_search_criteria</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/model.html#get_search_criteria"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.get_search_criteria" title="Permalink to this definition">¶</a></dt>

  92. <dd></dd></dl>

  93. 

  94. <dl class="function">

  95. <dt id="webnotes.model.rename">

  96. <tt class="descclassname">webnotes.model.</tt><tt class="descname">rename</tt><big>(</big><em>dt</em>, <em>old</em>, <em>new</em>, <em>is_doctype=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/model.html#rename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.rename" title="Permalink to this definition">¶</a></dt>

  97. <dd><p>Renames a doc(dt, old) to doc(dt, new) and updates all linked fields of type &#8220;Link&#8221; or &#8220;Select&#8221; with &#8220;link:&#8221;</p>

  98. </dd></dl>

  99. 

  100. </div>

  101. <div class="section" id="module-webnotes.model.code">

  102. <span id="code-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">code</span></tt> Module<a class="headerlink" href="#module-webnotes.model.code" title="Permalink to this headline">¶</a></h2>

  103. <p>This is where all the plug-in code is executed. The standard method for DocTypes is declaration of a 

  104. standardized <cite>DocType</cite> class that has the methods of any DocType. When an object is instantiated using the

  105. <cite>get_obj</cite> method, it creates an instance of the <cite>DocType</cite> class of that particular DocType and sets the 

  106. <cite>doc</cite> and <cite>doclist</cite> attributes that represent the fields (properties) of that record.</p>

  107. <p>methods in following modules are imported for backward compatibility</p>

  108. <blockquote>

  109. <div><ul class="simple">

  110. <li>webnotes.*</li>

  111. <li>webnotes.utils.*</li>

  112. <li>webnotes.model.doc.*</li>

  113. <li>webnotes.model.doclist.*</li>

  114. </ul>

  115. </div></blockquote>

  116. <dl class="function">

  117. <dt id="webnotes.model.code.check_syntax">

  118. <tt class="descclassname">webnotes.model.code.</tt><tt class="descname">check_syntax</tt><big>(</big><em>code</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/code.html#check_syntax"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.code.check_syntax" title="Permalink to this definition">¶</a></dt>

  119. <dd></dd></dl>

  120. 

  121. <dl class="function">

  122. <dt id="webnotes.model.code.execute">

  123. <tt class="descclassname">webnotes.model.code.</tt><tt class="descname">execute</tt><big>(</big><em>code</em>, <em>doc=None</em>, <em>doclist=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/webnotes/model/code.html#execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.code.execute" title="Permalink to this definition">¶</a></dt>

  124. <dd><p>Execute the code, if doc is given, then return the instance of the <cite>DocType</cite> class created</p>

  125. </dd></dl>

  126. 

  127. <dl class="function">

  128. <dt id="webnotes.model.code.get_code">

  129. <tt class="descclassname">webnotes.model.code.</tt><tt class="descname">get_code</tt><big>(</big><em>module</em>, <em>dt</em>, <em>dn</em>, <em>extn</em>, <em>is_static=None</em>, <em>fieldname=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/code.html#get_code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.code.get_code" title="Permalink to this definition">¶</a></dt>

  130. <dd></dd></dl>

  131. 

  132. <dl class="function">

  133. <dt id="webnotes.model.code.get_custom_script">

  134. <tt class="descclassname">webnotes.model.code.</tt><tt class="descname">get_custom_script</tt><big>(</big><em>doctype</em>, <em>script_type</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/code.html#get_custom_script"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.code.get_custom_script" title="Permalink to this definition">¶</a></dt>

  135. <dd><p>Returns custom script if set in doctype <cite>Custom Script</cite></p>

  136. </dd></dl>

  137. 

  138. <dl class="function">

  139. <dt id="webnotes.model.code.get_obj">

  140. <tt class="descclassname">webnotes.model.code.</tt><tt class="descname">get_obj</tt><big>(</big><em>dt=None</em>, <em>dn=None</em>, <em>doc=None</em>, <em>doclist=</em><span class="optional">[</span><span class="optional">]</span>, <em>with_children=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/code.html#get_obj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.code.get_obj" title="Permalink to this definition">¶</a></dt>

  141. <dd><p>Returns the instantiated <cite>DocType</cite> object. Here you can pass the DocType and name (ID) to get the object.

  142. If with_children is true, then all child records will be laoded and added in the doclist.</p>

  143. </dd></dl>

  144. 

  145. <dl class="function">

  146. <dt id="webnotes.model.code.get_server_obj">

  147. <tt class="descclassname">webnotes.model.code.</tt><tt class="descname">get_server_obj</tt><big>(</big><em>doc</em>, <em>doclist=</em><span class="optional">[</span><span class="optional">]</span>, <em>basedoctype=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/code.html#get_server_obj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.code.get_server_obj" title="Permalink to this definition">¶</a></dt>

  148. <dd><p>Returns the instantiated <cite>DocType</cite> object. Will also manage caching &amp; compiling</p>

  149. </dd></dl>

  150. 

  151. <dl class="function">

  152. <dt id="webnotes.model.code.run_server_obj">

  153. <tt class="descclassname">webnotes.model.code.</tt><tt class="descname">run_server_obj</tt><big>(</big><em>server_obj</em>, <em>method_name</em>, <em>arg=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/code.html#run_server_obj"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.code.run_server_obj" title="Permalink to this definition">¶</a></dt>

  154. <dd><p>Executes a method (<cite>method_name</cite>) from the given object (<cite>server_obj</cite>)</p>

  155. </dd></dl>

  156. 

  157. <dl class="function">

  158. <dt id="webnotes.model.code.updatedb">

  159. <tt class="descclassname">webnotes.model.code.</tt><tt class="descname">updatedb</tt><big>(</big><em>doctype</em>, <em>userfields=</em><span class="optional">[</span><span class="optional">]</span>, <em>args={}</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/code.html#updatedb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.code.updatedb" title="Permalink to this definition">¶</a></dt>

  160. <dd></dd></dl>

  161. 

  162. </div>

  163. <div class="section" id="module-webnotes.model.db_schema">

  164. <span id="db-schema-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">db_schema</span></tt> Module<a class="headerlink" href="#module-webnotes.model.db_schema" title="Permalink to this headline">¶</a></h2>

  165. <p>Syncs a database table to the <cite>DocType</cite> (metadata)</p>

  166. <div class="admonition note">

  167. <p class="first admonition-title">Note</p>

  168. <p class="last">This module is only used internally</p>

  169. </div>

  170. <dl class="class">

  171. <dt id="webnotes.model.db_schema.DbColumn">

  172. <em class="property">class </em><tt class="descclassname">webnotes.model.db_schema.</tt><tt class="descname">DbColumn</tt><big>(</big><em>table</em>, <em>fieldname</em>, <em>fieldtype</em>, <em>length</em>, <em>default</em>, <em>set_index</em>, <em>options</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbColumn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbColumn" title="Permalink to this definition">¶</a></dt>

  173. <dd><dl class="method">

  174. <dt id="webnotes.model.db_schema.DbColumn.check">

  175. <tt class="descname">check</tt><big>(</big><em>current_def</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbColumn.check"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbColumn.check" title="Permalink to this definition">¶</a></dt>

  176. <dd></dd></dl>

  177. 

  178. <dl class="method">

  179. <dt id="webnotes.model.db_schema.DbColumn.get_definition">

  180. <tt class="descname">get_definition</tt><big>(</big><em>with_default=1</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbColumn.get_definition"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbColumn.get_definition" title="Permalink to this definition">¶</a></dt>

  181. <dd></dd></dl>

  182. 

  183. </dd></dl>

  184. 

  185. <dl class="class">

  186. <dt id="webnotes.model.db_schema.DbManager">

  187. <em class="property">class </em><tt class="descclassname">webnotes.model.db_schema.</tt><tt class="descname">DbManager</tt><big>(</big><em>conn</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager" title="Permalink to this definition">¶</a></dt>

  188. <dd><p>Basically, a wrapper for oft-used mysql commands. like show tables,databases, variables etc...</p>

  189. <dl class="docutils">

  190. <dt>#TODO:</dt>

  191. <dd>0.  Simplify / create settings for the restore database source folder 

  192. 0a. Merge restore database and extract_sql(from webnotes_server_tools).

  193. 1. Setter and getter for different mysql variables.

  194. 2. Setter and getter for mysql variables at global level??</dd>

  195. </dl>

  196. <dl class="method">

  197. <dt id="webnotes.model.db_schema.DbManager.create_database">

  198. <tt class="descname">create_database</tt><big>(</big><em>target</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.create_database"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.create_database" title="Permalink to this definition">¶</a></dt>

  199. <dd></dd></dl>

  200. 

  201. <dl class="method">

  202. <dt id="webnotes.model.db_schema.DbManager.create_user">

  203. <tt class="descname">create_user</tt><big>(</big><em>user</em>, <em>password</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.create_user"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.create_user" title="Permalink to this definition">¶</a></dt>

  204. <dd></dd></dl>

  205. 

  206. <dl class="method">

  207. <dt id="webnotes.model.db_schema.DbManager.delete_user">

  208. <tt class="descname">delete_user</tt><big>(</big><em>target</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.delete_user"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.delete_user" title="Permalink to this definition">¶</a></dt>

  209. <dd></dd></dl>

  210. 

  211. <dl class="method">

  212. <dt id="webnotes.model.db_schema.DbManager.drop_all_databases">

  213. <tt class="descname">drop_all_databases</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.drop_all_databases"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.drop_all_databases" title="Permalink to this definition">¶</a></dt>

  214. <dd><p>Danger: will delete all databases except test,mysql.</p>

  215. </dd></dl>

  216. 

  217. <dl class="method">

  218. <dt id="webnotes.model.db_schema.DbManager.drop_database">

  219. <tt class="descname">drop_database</tt><big>(</big><em>target</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.drop_database"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.drop_database" title="Permalink to this definition">¶</a></dt>

  220. <dd></dd></dl>

  221. 

  222. <dl class="method">

  223. <dt id="webnotes.model.db_schema.DbManager.drop_table">

  224. <tt class="descname">drop_table</tt><big>(</big><em>table_name</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.drop_table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.drop_table" title="Permalink to this definition">¶</a></dt>

  225. <dd></dd></dl>

  226. 

  227. <dl class="method">

  228. <dt id="webnotes.model.db_schema.DbManager.flush_privileges">

  229. <tt class="descname">flush_privileges</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.flush_privileges"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.flush_privileges" title="Permalink to this definition">¶</a></dt>

  230. <dd></dd></dl>

  231. 

  232. <dl class="method">

  233. <dt id="webnotes.model.db_schema.DbManager.get_database_list">

  234. <tt class="descname">get_database_list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.get_database_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.get_database_list" title="Permalink to this definition">¶</a></dt>

  235. <dd></dd></dl>

  236. 

  237. <dl class="method">

  238. <dt id="webnotes.model.db_schema.DbManager.get_table_schema">

  239. <tt class="descname">get_table_schema</tt><big>(</big><em>table</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.get_table_schema"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.get_table_schema" title="Permalink to this definition">¶</a></dt>

  240. <dd><p>Just returns the output of Desc tables.</p>

  241. </dd></dl>

  242. 

  243. <dl class="method">

  244. <dt id="webnotes.model.db_schema.DbManager.get_tables_list">

  245. <tt class="descname">get_tables_list</tt><big>(</big><em>target</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.get_tables_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.get_tables_list" title="Permalink to this definition">¶</a></dt>

  246. <dd></dd></dl>

  247. 

  248. <dl class="method">

  249. <dt id="webnotes.model.db_schema.DbManager.get_variables">

  250. <tt class="descname">get_variables</tt><big>(</big><em>regex</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.get_variables"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.get_variables" title="Permalink to this definition">¶</a></dt>

  251. <dd><p>Get variables that match the passed pattern regex</p>

  252. </dd></dl>

  253. 

  254. <dl class="method">

  255. <dt id="webnotes.model.db_schema.DbManager.grant_all_privileges">

  256. <tt class="descname">grant_all_privileges</tt><big>(</big><em>target</em>, <em>user</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.grant_all_privileges"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.grant_all_privileges" title="Permalink to this definition">¶</a></dt>

  257. <dd></dd></dl>

  258. 

  259. <dl class="method">

  260. <dt id="webnotes.model.db_schema.DbManager.grant_select_privilges">

  261. <tt class="descname">grant_select_privilges</tt><big>(</big><em>db</em>, <em>table</em>, <em>user</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.grant_select_privilges"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.grant_select_privilges" title="Permalink to this definition">¶</a></dt>

  262. <dd></dd></dl>

  263. 

  264. <dl class="method">

  265. <dt id="webnotes.model.db_schema.DbManager.restore_database">

  266. <tt class="descname">restore_database</tt><big>(</big><em>target</em>, <em>source</em>, <em>root_password</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.restore_database"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.restore_database" title="Permalink to this definition">¶</a></dt>

  267. <dd></dd></dl>

  268. 

  269. <dl class="method">

  270. <dt id="webnotes.model.db_schema.DbManager.set_transaction_isolation_level">

  271. <tt class="descname">set_transaction_isolation_level</tt><big>(</big><em>scope='SESSION'</em>, <em>level='READ COMMITTED'</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbManager.set_transaction_isolation_level"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbManager.set_transaction_isolation_level" title="Permalink to this definition">¶</a></dt>

  272. <dd></dd></dl>

  273. 

  274. </dd></dl>

  275. 

  276. <dl class="class">

  277. <dt id="webnotes.model.db_schema.DbTable">

  278. <em class="property">class </em><tt class="descclassname">webnotes.model.db_schema.</tt><tt class="descname">DbTable</tt><big>(</big><em>doctype</em>, <em>prefix='tab'</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbTable"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbTable" title="Permalink to this definition">¶</a></dt>

  279. <dd><dl class="method">

  280. <dt id="webnotes.model.db_schema.DbTable.alter">

  281. <tt class="descname">alter</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbTable.alter"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbTable.alter" title="Permalink to this definition">¶</a></dt>

  282. <dd></dd></dl>

  283. 

  284. <dl class="method">

  285. <dt id="webnotes.model.db_schema.DbTable.create">

  286. <tt class="descname">create</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbTable.create"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbTable.create" title="Permalink to this definition">¶</a></dt>

  287. <dd></dd></dl>

  288. 

  289. <dl class="method">

  290. <dt id="webnotes.model.db_schema.DbTable.drop_foreign_keys">

  291. <tt class="descname">drop_foreign_keys</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbTable.drop_foreign_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbTable.drop_foreign_keys" title="Permalink to this definition">¶</a></dt>

  292. <dd></dd></dl>

  293. 

  294. <dl class="method">

  295. <dt id="webnotes.model.db_schema.DbTable.get_column_definitions">

  296. <tt class="descname">get_column_definitions</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbTable.get_column_definitions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbTable.get_column_definitions" title="Permalink to this definition">¶</a></dt>

  297. <dd></dd></dl>

  298. 

  299. <dl class="method">

  300. <dt id="webnotes.model.db_schema.DbTable.get_columns_from_db">

  301. <tt class="descname">get_columns_from_db</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbTable.get_columns_from_db"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbTable.get_columns_from_db" title="Permalink to this definition">¶</a></dt>

  302. <dd></dd></dl>

  303. 

  304. <dl class="method">

  305. <dt id="webnotes.model.db_schema.DbTable.get_columns_from_docfields">

  306. <tt class="descname">get_columns_from_docfields</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbTable.get_columns_from_docfields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbTable.get_columns_from_docfields" title="Permalink to this definition">¶</a></dt>

  307. <dd></dd></dl>

  308. 

  309. <dl class="method">

  310. <dt id="webnotes.model.db_schema.DbTable.get_foreign_keys">

  311. <tt class="descname">get_foreign_keys</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbTable.get_foreign_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbTable.get_foreign_keys" title="Permalink to this definition">¶</a></dt>

  312. <dd></dd></dl>

  313. 

  314. <dl class="method">

  315. <dt id="webnotes.model.db_schema.DbTable.get_index_definitions">

  316. <tt class="descname">get_index_definitions</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbTable.get_index_definitions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbTable.get_index_definitions" title="Permalink to this definition">¶</a></dt>

  317. <dd></dd></dl>

  318. 

  319. <dl class="method">

  320. <dt id="webnotes.model.db_schema.DbTable.sync">

  321. <tt class="descname">sync</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#DbTable.sync"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.DbTable.sync" title="Permalink to this definition">¶</a></dt>

  322. <dd></dd></dl>

  323. 

  324. </dd></dl>

  325. 

  326. <dl class="function">

  327. <dt id="webnotes.model.db_schema.remove_all_foreign_keys">

  328. <tt class="descclassname">webnotes.model.db_schema.</tt><tt class="descname">remove_all_foreign_keys</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#remove_all_foreign_keys"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.remove_all_foreign_keys" title="Permalink to this definition">¶</a></dt>

  329. <dd></dd></dl>

  330. 

  331. <dl class="function">

  332. <dt id="webnotes.model.db_schema.updatedb">

  333. <tt class="descclassname">webnotes.model.db_schema.</tt><tt class="descname">updatedb</tt><big>(</big><em>dt</em>, <em>archive=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#updatedb"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.updatedb" title="Permalink to this definition">¶</a></dt>

  334. <dd><dl class="docutils">

  335. <dt>Syncs a <cite>DocType</cite> to the table</dt>

  336. <dd><ul class="first last simple">

  337. <li>creates if required</li>

  338. <li>updates columns</li>

  339. <li>updates indices</li>

  340. </ul>

  341. </dd>

  342. </dl>

  343. </dd></dl>

  344. 

  345. <dl class="function">

  346. <dt id="webnotes.model.db_schema.validate_column_name">

  347. <tt class="descclassname">webnotes.model.db_schema.</tt><tt class="descname">validate_column_name</tt><big>(</big><em>n</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/db_schema.html#validate_column_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.db_schema.validate_column_name" title="Permalink to this definition">¶</a></dt>

  348. <dd></dd></dl>

  349. 

  350. </div>

  351. <div class="section" id="module-webnotes.model.doc">

  352. <span id="doc-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">doc</span></tt> Module<a class="headerlink" href="#module-webnotes.model.doc" title="Permalink to this headline">¶</a></h2>

  353. <p>Contains the Document class representing an object / record</p>

  354. <dl class="class">

  355. <dt id="webnotes.model.doc.Document">

  356. <em class="property">class </em><tt class="descclassname">webnotes.model.doc.</tt><tt class="descname">Document</tt><big>(</big><em>doctype=''</em>, <em>name=''</em>, <em>fielddata={}</em>, <em>prefix='tab'</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#Document"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.Document" title="Permalink to this definition">¶</a></dt>

  357. <dd><p>The wn(meta-data)framework equivalent of a Database Record.

  358. Stores,Retrieves,Updates the record in the corresponding table.

  359. Runs the triggers required.</p>

  360. <p>The <cite>Document</cite> class represents the basic Object-Relational Mapper (ORM). The object type is defined by

  361. <cite>DocType</cite> and the object ID is represented by <cite>name</cite>:</p>

  362. <div class="highlight-python"><pre>Please note the anamoly in the Web Notes Framework that `ID` is always called as `name`</pre>

  363. </div>

  364. <p>If both <cite>doctype</cite> and <cite>name</cite> are specified in the constructor, then the object is loaded from the database.

  365. If only <cite>doctype</cite> is given, then the object is not loaded

  366. If <cite>fielddata</cite> is specfied, then the object is created from the given dictionary.</p>

  367. <blockquote>

  368. <div><p><strong>Note 1:</strong></p>

  369. <blockquote>

  370. <div><p>The getter and setter of the object are overloaded to map to the fields of the object that

  371. are loaded when it is instantiated.</p>

  372. <p>For example: doc.name will be the <cite>name</cite> field and doc.owner will be the <cite>owner</cite> field</p>

  373. </div></blockquote>

  374. <p><strong>Note 2 - Standard Fields:</strong></p>

  375. <blockquote>

  376. <div><ul class="simple">

  377. <li><cite>name</cite>: ID / primary key</li>

  378. <li><cite>owner</cite>: creator of the record</li>

  379. <li><cite>creation</cite>: datetime of creation</li>

  380. <li><cite>modified</cite>: datetime of last modification</li>

  381. <li><cite>modified_by</cite> : last updating user</li>

  382. <li><cite>docstatus</cite> : Status 0 - Saved, 1 - Submitted, 2- Cancelled</li>

  383. <li><cite>parent</cite> : if child (table) record, this represents the parent record</li>

  384. <li><cite>parenttype</cite> : type of parent record (if any)</li>

  385. <li><cite>parentfield</cite> : table fieldname of parent record (if any)</li>

  386. <li><cite>idx</cite> : Index (sequence) of the child record</li>

  387. </ul>

  388. </div></blockquote>

  389. </div></blockquote>

  390. <dl class="method">

  391. <dt id="webnotes.model.doc.Document.addchild">

  392. <tt class="descname">addchild</tt><big>(</big><em>fieldname</em>, <em>childtype=''</em>, <em>local=0</em>, <em>doclist=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#Document.addchild"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.Document.addchild" title="Permalink to this definition">¶</a></dt>

  393. <dd><p>Returns a child record of the give <cite>childtype</cite>.</p>

  394. <ul class="simple">

  395. <li>if local is set, it does not save the record</li>

  396. <li>if doclist is passed, it append the record to the doclist</li>

  397. </ul>

  398. </dd></dl>

  399. 

  400. <dl class="method">

  401. <dt id="webnotes.model.doc.Document.check_perm">

  402. <tt class="descname">check_perm</tt><big>(</big><em>verbose=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#Document.check_perm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.Document.check_perm" title="Permalink to this definition">¶</a></dt>

  403. <dd></dd></dl>

  404. 

  405. <dl class="method">

  406. <dt id="webnotes.model.doc.Document.clear_table">

  407. <tt class="descname">clear_table</tt><big>(</big><em>doclist</em>, <em>tablefield</em>, <em>save=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#Document.clear_table"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.Document.clear_table" title="Permalink to this definition">¶</a></dt>

  408. <dd><p>Clears the child records from the given <cite>doclist</cite> for a particular <cite>tablefield</cite></p>

  409. </dd></dl>

  410. 

  411. <dl class="method">

  412. <dt id="webnotes.model.doc.Document.make_link_list">

  413. <tt class="descname">make_link_list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#Document.make_link_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.Document.make_link_list" title="Permalink to this definition">¶</a></dt>

  414. <dd></dd></dl>

  415. 

  416. <dl class="method">

  417. <dt id="webnotes.model.doc.Document.save">

  418. <tt class="descname">save</tt><big>(</big><em>new=0</em>, <em>check_links=1</em>, <em>ignore_fields=0</em>, <em>make_autoname=1</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#Document.save"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.Document.save" title="Permalink to this definition">¶</a></dt>

  419. <dd><p>Saves the current record in the database. If new = 1, creates a new instance of the record.

  420. Also clears temperory fields starting with <cite>__</cite></p>

  421. <ul class="simple">

  422. <li>if check_links is set, it validates all <cite>Link</cite> fields</li>

  423. <li>if ignore_fields is sets, it does not throw an exception for any field that does not exist in the 

  424. database table</li>

  425. </ul>

  426. </dd></dl>

  427. 

  428. <dl class="method">

  429. <dt id="webnotes.model.doc.Document.validate_links">

  430. <tt class="descname">validate_links</tt><big>(</big><em>link_list</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#Document.validate_links"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.Document.validate_links" title="Permalink to this definition">¶</a></dt>

  431. <dd></dd></dl>

  432. 

  433. </dd></dl>

  434. 

  435. <dl class="class">

  436. <dt id="webnotes.model.doc.SuperDocType">

  437. <em class="property">class </em><tt class="descclassname">webnotes.model.doc.</tt><tt class="descname">SuperDocType</tt><a class="reference internal" href="_modules/webnotes/model/doc.html#SuperDocType"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.SuperDocType" title="Permalink to this definition">¶</a></dt>

  438. <dd></dd></dl>

  439. 

  440. <dl class="function">

  441. <dt id="webnotes.model.doc.addchild">

  442. <tt class="descclassname">webnotes.model.doc.</tt><tt class="descname">addchild</tt><big>(</big><em>parent</em>, <em>fieldname</em>, <em>childtype=''</em>, <em>local=0</em>, <em>doclist=None</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#addchild"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.addchild" title="Permalink to this definition">¶</a></dt>

  443. <dd><p>Create a child record to the parent doc.</p>

  444. <p>Example:</p>

  445. <div class="highlight-python"><div class="highlight"><pre><span class="n">c</span> <span class="o">=</span> <span class="n">Document</span><span class="p">(</span><span class="s">&#39;Contact&#39;</span><span class="p">,</span><span class="s">&#39;ABC&#39;</span><span class="p">)</span>

  446. <span class="n">d</span> <span class="o">=</span> <span class="n">addchild</span><span class="p">(</span><span class="n">c</span><span class="p">,</span> <span class="s">&#39;contact_updates&#39;</span><span class="p">,</span> <span class="s">&#39;Contact Update&#39;</span><span class="p">,</span> <span class="n">local</span> <span class="o">=</span> <span class="mi">1</span><span class="p">)</span>

  447. <span class="n">d</span><span class="o">.</span><span class="n">last_updated</span> <span class="o">=</span> <span class="s">&#39;Phone call&#39;</span>

  448. <span class="n">d</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>

  449. </pre></div>

  450. </div>

  451. </dd></dl>

  452. 

  453. <dl class="function">

  454. <dt id="webnotes.model.doc.check_page_perm">

  455. <tt class="descclassname">webnotes.model.doc.</tt><tt class="descname">check_page_perm</tt><big>(</big><em>doc</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#check_page_perm"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.check_page_perm" title="Permalink to this definition">¶</a></dt>

  456. <dd></dd></dl>

  457. 

  458. <dl class="function">

  459. <dt id="webnotes.model.doc.get">

  460. <tt class="descclassname">webnotes.model.doc.</tt><tt class="descname">get</tt><big>(</big><em>dt</em>, <em>dn=''</em>, <em>with_children=1</em>, <em>from_get_obj=0</em>, <em>prefix='tab'</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.get" title="Permalink to this definition">¶</a></dt>

  461. <dd><p>Returns a doclist containing the main record and all child records</p>

  462. </dd></dl>

  463. 

  464. <dl class="function">

  465. <dt id="webnotes.model.doc.get_report_builder_code">

  466. <tt class="descclassname">webnotes.model.doc.</tt><tt class="descname">get_report_builder_code</tt><big>(</big><em>doc</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#get_report_builder_code"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.get_report_builder_code" title="Permalink to this definition">¶</a></dt>

  467. <dd></dd></dl>

  468. 

  469. <dl class="function">

  470. <dt id="webnotes.model.doc.getchildren">

  471. <tt class="descclassname">webnotes.model.doc.</tt><tt class="descname">getchildren</tt><big>(</big><em>name</em>, <em>childtype</em>, <em>field=''</em>, <em>parenttype=''</em>, <em>from_doctype=0</em>, <em>prefix='tab'</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#getchildren"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.getchildren" title="Permalink to this definition">¶</a></dt>

  472. <dd></dd></dl>

  473. 

  474. <dl class="function">

  475. <dt id="webnotes.model.doc.getseries">

  476. <tt class="descclassname">webnotes.model.doc.</tt><tt class="descname">getseries</tt><big>(</big><em>key</em>, <em>digits</em>, <em>doctype=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#getseries"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.getseries" title="Permalink to this definition">¶</a></dt>

  477. <dd></dd></dl>

  478. 

  479. <dl class="function">

  480. <dt id="webnotes.model.doc.make_autoname">

  481. <tt class="descclassname">webnotes.model.doc.</tt><tt class="descname">make_autoname</tt><big>(</big><em>key</em>, <em>doctype=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#make_autoname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.make_autoname" title="Permalink to this definition">¶</a></dt>

  482. <dd><p>Creates an autoname from the given key:</p>

  483. <p><strong>Autoname rules:</strong></p>

  484. <blockquote>

  485. <div><ul>

  486. <li><p class="first">The key is separated by &#8216;.&#8217;</p>

  487. </li>

  488. <li><dl class="first docutils">

  489. <dt>&#8216;####&#8217; represents a series. The string before this part becomes the prefix:</dt>

  490. <dd><p class="first last">Example: ABC.#### creates a series ABC0001, ABC0002 etc</p>

  491. </dd>

  492. </dl>

  493. </li>

  494. <li><p class="first">&#8216;MM&#8217; represents the current month</p>

  495. </li>

  496. <li><p class="first">&#8216;YY&#8217; and &#8216;YYYY&#8217; represent the current year</p>

  497. </li>

  498. </ul>

  499. </div></blockquote>

  500. <p><em>Example:</em></p>

  501. <blockquote>

  502. <div><ul class="simple">

  503. <li>DE/./.YY./.MM./.##### will create a series like

  504. DE/09/01/0001 where 09 is the year, 01 is the month and 0001 is the series</li>

  505. </ul>

  506. </div></blockquote>

  507. </dd></dl>

  508. 

  509. <dl class="function">

  510. <dt id="webnotes.model.doc.removechild">

  511. <tt class="descclassname">webnotes.model.doc.</tt><tt class="descname">removechild</tt><big>(</big><em>d</em>, <em>is_local=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doc.html#removechild"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doc.removechild" title="Permalink to this definition">¶</a></dt>

  512. <dd><p>Sets the docstatus of the object d to 2 (deleted) and appends an &#8216;old_parent:&#8217; to the parent name</p>

  513. </dd></dl>

  514. 

  515. </div>

  516. <div class="section" id="module-webnotes.model.doclist">

  517. <span id="doclist-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">doclist</span></tt> Module<a class="headerlink" href="#module-webnotes.model.doclist" title="Permalink to this headline">¶</a></h2>

  518. <dl class="function">

  519. <dt id="webnotes.model.doclist.compress">

  520. <tt class="descclassname">webnotes.model.doclist.</tt><tt class="descname">compress</tt><big>(</big><em>doclist</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doclist.html#compress"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doclist.compress" title="Permalink to this definition">¶</a></dt>

  521. <dd><p>Compress a doclist before sending it to the client side. (Internally used by the request handler)</p>

  522. </dd></dl>

  523. 

  524. <dl class="function">

  525. <dt id="webnotes.model.doclist.copy_doclist">

  526. <tt class="descclassname">webnotes.model.doclist.</tt><tt class="descname">copy_doclist</tt><big>(</big><em>doclist</em>, <em>no_copy=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/webnotes/model/doclist.html#copy_doclist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doclist.copy_doclist" title="Permalink to this definition">¶</a></dt>

  527. <dd><p>Save &amp; return a copy of the given doclist

  528. Pass fields that are not to be copied in <cite>no_copy</cite></p>

  529. </dd></dl>

  530. 

  531. <dl class="function">

  532. <dt id="webnotes.model.doclist.expand">

  533. <tt class="descclassname">webnotes.model.doclist.</tt><tt class="descname">expand</tt><big>(</big><em>docs</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doclist.html#expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doclist.expand" title="Permalink to this definition">¶</a></dt>

  534. <dd><p>Expand a doclist sent from the client side. (Internally used by the request handler)</p>

  535. </dd></dl>

  536. 

  537. <dl class="function">

  538. <dt id="webnotes.model.doclist.getlist">

  539. <tt class="descclassname">webnotes.model.doclist.</tt><tt class="descname">getlist</tt><big>(</big><em>doclist</em>, <em>field</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doclist.html#getlist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doclist.getlist" title="Permalink to this definition">¶</a></dt>

  540. <dd><p>Filter a list of records for a specific field from the full doclist</p>

  541. <p>Example:</p>

  542. <div class="highlight-python"><div class="highlight"><pre><span class="c"># find all phone call details     </span>

  543. <span class="n">dl</span> <span class="o">=</span> <span class="n">getlist</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">doclist</span><span class="p">,</span> <span class="s">&#39;contact_updates&#39;</span><span class="p">)</span>

  544. <span class="n">pl</span> <span class="o">=</span> <span class="p">[]</span>

  545. <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">dl</span><span class="p">:</span>

  546.   <span class="k">if</span> <span class="n">d</span><span class="o">.</span><span class="n">type</span><span class="o">==</span><span class="s">&#39;Phone&#39;</span><span class="p">:</span>

  547.     <span class="n">pl</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>

  548. </pre></div>

  549. </div>

  550. </dd></dl>

  551. 

  552. <dl class="function">

  553. <dt id="webnotes.model.doclist.getvaluelist">

  554. <tt class="descclassname">webnotes.model.doclist.</tt><tt class="descname">getvaluelist</tt><big>(</big><em>doclist</em>, <em>fieldname</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doclist.html#getvaluelist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doclist.getvaluelist" title="Permalink to this definition">¶</a></dt>

  555. <dd><p>Returns a list of values of a particualr fieldname from all Document object in a doclist</p>

  556. </dd></dl>

  557. 

  558. <dl class="function">

  559. <dt id="webnotes.model.doclist.to_html">

  560. <tt class="descclassname">webnotes.model.doclist.</tt><tt class="descname">to_html</tt><big>(</big><em>doclist</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doclist.html#to_html"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doclist.to_html" title="Permalink to this definition">¶</a></dt>

  561. <dd><p>Return a simple HTML format of the doclist</p>

  562. </dd></dl>

  563. 

  564. <dl class="function">

  565. <dt id="webnotes.model.doclist.validate_links_doclist">

  566. <tt class="descclassname">webnotes.model.doclist.</tt><tt class="descname">validate_links_doclist</tt><big>(</big><em>doclist</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doclist.html#validate_links_doclist"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doclist.validate_links_doclist" title="Permalink to this definition">¶</a></dt>

  567. <dd><p>Validate link fields and return link fields that are not correct.

  568. Calls the <cite>validate_links</cite> function on the Document object</p>

  569. </dd></dl>

  570. 

  571. <dl class="function">

  572. <dt id="webnotes.model.doclist.xzip">

  573. <tt class="descclassname">webnotes.model.doclist.</tt><tt class="descname">xzip</tt><big>(</big><em>a</em>, <em>b</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doclist.html#xzip"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doclist.xzip" title="Permalink to this definition">¶</a></dt>

  574. <dd></dd></dl>

  575. 

  576. </div>

  577. <div class="section" id="module-webnotes.model.doctype">

  578. <span id="doctype-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">doctype</span></tt> Module<a class="headerlink" href="#module-webnotes.model.doctype" title="Permalink to this headline">¶</a></h2>

  579. <div class="section" id="id2">

  580. <h3>DocType module<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3>

  581. <p>This module has the DocType class that represents a &#8220;DocType&#8221; as metadata.

  582. This is usually called by the form builder or report builder.</p>

  583. <dl class="docutils">

  584. <dt>Key functions:</dt>

  585. <dd><ul class="first last simple">

  586. <li>manage cache - read / write</li>

  587. <li>merge client-side scripts</li>

  588. <li>update properties from the modules .txt files</li>

  589. </ul>

  590. </dd>

  591. <dt>Cache management:</dt>

  592. <dd><ul class="first last simple">

  593. <li>Cache is stored in __DocTypeCache</li>

  594. </ul>

  595. </dd>

  596. </dl>

  597. <dl class="function">

  598. <dt id="webnotes.model.doctype.clear_cache">

  599. <tt class="descclassname">webnotes.model.doctype.</tt><tt class="descname">clear_cache</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/doctype.html#clear_cache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doctype.clear_cache" title="Permalink to this definition">¶</a></dt>

  600. <dd></dd></dl>

  601. 

  602. <dl class="function">

  603. <dt id="webnotes.model.doctype.get">

  604. <tt class="descclassname">webnotes.model.doctype.</tt><tt class="descname">get</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/doctype.html#get"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.doctype.get" title="Permalink to this definition">¶</a></dt>

  605. <dd><p>Load &#8220;DocType&#8221; - called by form builder, report buider and from code.py (when there is no cache)</p>

  606. </dd></dl>

  607. 

  608. </div>

  609. </div>

  610. <div class="section" id="module-webnotes.model.import_docs">

  611. <span id="import-docs-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">import_docs</span></tt> Module<a class="headerlink" href="#module-webnotes.model.import_docs" title="Permalink to this headline">¶</a></h2>

  612. <dl class="class">

  613. <dt id="webnotes.model.import_docs.CSVImport">

  614. <em class="property">class </em><tt class="descclassname">webnotes.model.import_docs.</tt><tt class="descname">CSVImport</tt><a class="reference internal" href="_modules/webnotes/model/import_docs.html#CSVImport"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.CSVImport" title="Permalink to this definition">¶</a></dt>

  615. <dd><dl class="method">

  616. <dt id="webnotes.model.import_docs.CSVImport.check_select_link_data">

  617. <tt class="descname">check_select_link_data</tt><big>(</big><em>r</em>, <em>c</em>, <em>f</em>, <em>d</em>, <em>s=''</em>, <em>l=''</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#CSVImport.check_select_link_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.CSVImport.check_select_link_data" title="Permalink to this definition">¶</a></dt>

  618. <dd></dd></dl>

  619. 

  620. <dl class="method">

  621. <dt id="webnotes.model.import_docs.CSVImport.convert_csv_data_into_list">

  622. <tt class="descname">convert_csv_data_into_list</tt><big>(</big><em>csv_data</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#CSVImport.convert_csv_data_into_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.CSVImport.convert_csv_data_into_list" title="Permalink to this definition">¶</a></dt>

  623. <dd></dd></dl>

  624. 

  625. <dl class="method">

  626. <dt id="webnotes.model.import_docs.CSVImport.get_field_type_list">

  627. <tt class="descname">get_field_type_list</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#CSVImport.get_field_type_list"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.CSVImport.get_field_type_list" title="Permalink to this definition">¶</a></dt>

  628. <dd></dd></dl>

  629. 

  630. <dl class="method">

  631. <dt id="webnotes.model.import_docs.CSVImport.import_csv">

  632. <tt class="descname">import_csv</tt><big>(</big><em>csv_data</em>, <em>import_date_format='yyyy-mm-dd'</em>, <em>overwrite=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#CSVImport.import_csv"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.CSVImport.import_csv" title="Permalink to this definition">¶</a></dt>

  633. <dd></dd></dl>

  634. 

  635. <dl class="method">

  636. <dt id="webnotes.model.import_docs.CSVImport.parse_date">

  637. <tt class="descname">parse_date</tt><big>(</big><em>r</em>, <em>c</em>, <em>d</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#CSVImport.parse_date"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.CSVImport.parse_date" title="Permalink to this definition">¶</a></dt>

  638. <dd></dd></dl>

  639. 

  640. <dl class="method">

  641. <dt id="webnotes.model.import_docs.CSVImport.update_data">

  642. <tt class="descname">update_data</tt><big>(</big><em>fd</em>, <em>row</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#CSVImport.update_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.CSVImport.update_data" title="Permalink to this definition">¶</a></dt>

  643. <dd></dd></dl>

  644. 

  645. <dl class="method">

  646. <dt id="webnotes.model.import_docs.CSVImport.validate_data">

  647. <tt class="descname">validate_data</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#CSVImport.validate_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.CSVImport.validate_data" title="Permalink to this definition">¶</a></dt>

  648. <dd></dd></dl>

  649. 

  650. <dl class="method">

  651. <dt id="webnotes.model.import_docs.CSVImport.validate_doctype">

  652. <tt class="descname">validate_doctype</tt><big>(</big><em>dt_list</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#CSVImport.validate_doctype"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.CSVImport.validate_doctype" title="Permalink to this definition">¶</a></dt>

  653. <dd></dd></dl>

  654. 

  655. <dl class="method">

  656. <dt id="webnotes.model.import_docs.CSVImport.validate_fields">

  657. <tt class="descname">validate_fields</tt><big>(</big><em>lb_list</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#CSVImport.validate_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.CSVImport.validate_fields" title="Permalink to this definition">¶</a></dt>

  658. <dd></dd></dl>

  659. 

  660. <dl class="method">

  661. <dt id="webnotes.model.import_docs.CSVImport.validate_headers">

  662. <tt class="descname">validate_headers</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#CSVImport.validate_headers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.CSVImport.validate_headers" title="Permalink to this definition">¶</a></dt>

  663. <dd></dd></dl>

  664. 

  665. </dd></dl>

  666. 

  667. <dl class="function">

  668. <dt id="webnotes.model.import_docs.get_template">

  669. <tt class="descclassname">webnotes.model.import_docs.</tt><tt class="descname">get_template</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#get_template"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.get_template" title="Permalink to this definition">¶</a></dt>

  670. <dd></dd></dl>

  671. 

  672. <dl class="function">

  673. <dt id="webnotes.model.import_docs.import_docs">

  674. <tt class="descclassname">webnotes.model.import_docs.</tt><tt class="descname">import_docs</tt><big>(</big><em>docs=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="reference internal" href="_modules/webnotes/model/import_docs.html#import_docs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.import_docs.import_docs" title="Permalink to this definition">¶</a></dt>

  675. <dd></dd></dl>

  676. 

  677. </div>

  678. <div class="section" id="module-webnotes.model.meta">

  679. <span id="meta-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">meta</span></tt> Module<a class="headerlink" href="#module-webnotes.model.meta" title="Permalink to this headline">¶</a></h2>

  680. <dl class="function">

  681. <dt id="webnotes.model.meta.get_dt_values">

  682. <tt class="descclassname">webnotes.model.meta.</tt><tt class="descname">get_dt_values</tt><big>(</big><em>doctype</em>, <em>fields</em>, <em>as_dict=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/meta.html#get_dt_values"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.meta.get_dt_values" title="Permalink to this definition">¶</a></dt>

  683. <dd></dd></dl>

  684. 

  685. <dl class="function">

  686. <dt id="webnotes.model.meta.get_link_fields">

  687. <tt class="descclassname">webnotes.model.meta.</tt><tt class="descname">get_link_fields</tt><big>(</big><em>doctype</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/meta.html#get_link_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.meta.get_link_fields" title="Permalink to this definition">¶</a></dt>

  688. <dd></dd></dl>

  689. 

  690. <dl class="function">

  691. <dt id="webnotes.model.meta.get_parent_dt">

  692. <tt class="descclassname">webnotes.model.meta.</tt><tt class="descname">get_parent_dt</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/meta.html#get_parent_dt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.meta.get_parent_dt" title="Permalink to this definition">¶</a></dt>

  693. <dd></dd></dl>

  694. 

  695. <dl class="function">

  696. <dt id="webnotes.model.meta.get_print_format_html">

  697. <tt class="descclassname">webnotes.model.meta.</tt><tt class="descname">get_print_format_html</tt><big>(</big><em>name</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/meta.html#get_print_format_html"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.meta.get_print_format_html" title="Permalink to this definition">¶</a></dt>

  698. <dd></dd></dl>

  699. 

  700. <dl class="function">

  701. <dt id="webnotes.model.meta.get_search_criteria">

  702. <tt class="descclassname">webnotes.model.meta.</tt><tt class="descname">get_search_criteria</tt><big>(</big><em>dt</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/meta.html#get_search_criteria"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.meta.get_search_criteria" title="Permalink to this definition">¶</a></dt>

  703. <dd></dd></dl>

  704. 

  705. <dl class="function">

  706. <dt id="webnotes.model.meta.get_table_fields">

  707. <tt class="descclassname">webnotes.model.meta.</tt><tt class="descname">get_table_fields</tt><big>(</big><em>doctype</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/meta.html#get_table_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.meta.get_table_fields" title="Permalink to this definition">¶</a></dt>

  708. <dd></dd></dl>

  709. 

  710. <dl class="function">

  711. <dt id="webnotes.model.meta.is_single">

  712. <tt class="descclassname">webnotes.model.meta.</tt><tt class="descname">is_single</tt><big>(</big><em>doctype</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/meta.html#is_single"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.meta.is_single" title="Permalink to this definition">¶</a></dt>

  713. <dd></dd></dl>

  714. 

  715. <dl class="function">

  716. <dt id="webnotes.model.meta.set_dt_value">

  717. <tt class="descclassname">webnotes.model.meta.</tt><tt class="descname">set_dt_value</tt><big>(</big><em>doctype</em>, <em>field</em>, <em>value</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/meta.html#set_dt_value"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.meta.set_dt_value" title="Permalink to this definition">¶</a></dt>

  718. <dd></dd></dl>

  719. 

  720. <dl class="function">

  721. <dt id="webnotes.model.meta.set_fieldname">

  722. <tt class="descclassname">webnotes.model.meta.</tt><tt class="descname">set_fieldname</tt><big>(</big><em>field_id</em>, <em>fieldname</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/meta.html#set_fieldname"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.meta.set_fieldname" title="Permalink to this definition">¶</a></dt>

  723. <dd></dd></dl>

  724. 

  725. </div>

  726. <div class="section" id="module-webnotes.model.modules">

  727. <span id="modules-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">modules</span></tt> Module<a class="headerlink" href="#module-webnotes.model.modules" title="Permalink to this headline">¶</a></h2>

  728. <dl class="function">

  729. <dt id="webnotes.model.modules.get_module_items">

  730. <tt class="descclassname">webnotes.model.modules.</tt><tt class="descname">get_module_items</tt><big>(</big><em>mod</em>, <em>only_dt=0</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/modules.html#get_module_items"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.modules.get_module_items" title="Permalink to this definition">¶</a></dt>

  731. <dd></dd></dl>

  732. 

  733. </div>

  734. <div class="section" id="module-webnotes.model.triggers">

  735. <span id="triggers-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">triggers</span></tt> Module<a class="headerlink" href="#module-webnotes.model.triggers" title="Permalink to this headline">¶</a></h2>

  736. <p>Add, manage, fire triggers (events / observers)

  737. Standard events called by the framework are &#8220;save, submit, cancel&#8221;</p>

  738. <dl class="function">

  739. <dt id="webnotes.model.triggers.add_trigger">

  740. <tt class="descclassname">webnotes.model.triggers.</tt><tt class="descname">add_trigger</tt><big>(</big><em>doctype</em>, <em>docname</em>, <em>event_name</em>, <em>method</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/triggers.html#add_trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.triggers.add_trigger" title="Permalink to this definition">¶</a></dt>

  741. <dd><p>Add a trigger to an event on a doctype, docname. The specified method will be called.

  742. Wild card &#8216;*&#8217; is allowed in doctype, docname and/or event_name</p>

  743. </dd></dl>

  744. 

  745. <dl class="function">

  746. <dt id="webnotes.model.triggers.fire_event">

  747. <tt class="descclassname">webnotes.model.triggers.</tt><tt class="descname">fire_event</tt><big>(</big><em>doc</em>, <em>event_name</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/triggers.html#fire_event"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.triggers.fire_event" title="Permalink to this definition">¶</a></dt>

  748. <dd><p>Fire all triggers on an event and passes the doc to the trigger</p>

  749. </dd></dl>

  750. 

  751. <dl class="function">

  752. <dt id="webnotes.model.triggers.insert_trigger">

  753. <tt class="descclassname">webnotes.model.triggers.</tt><tt class="descname">insert_trigger</tt><big>(</big><em>doctype</em>, <em>docname</em>, <em>event_name</em>, <em>method</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/triggers.html#insert_trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.triggers.insert_trigger" title="Permalink to this definition">¶</a></dt>

  754. <dd><p>inserts a new trigger record</p>

  755. </dd></dl>

  756. 

  757. <dl class="function">

  758. <dt id="webnotes.model.triggers.remove_trigger">

  759. <tt class="descclassname">webnotes.model.triggers.</tt><tt class="descname">remove_trigger</tt><big>(</big><em>doctype</em>, <em>docname</em>, <em>event_name</em>, <em>method</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/triggers.html#remove_trigger"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.triggers.remove_trigger" title="Permalink to this definition">¶</a></dt>

  760. <dd><p>Remove a trigger on an event</p>

  761. </dd></dl>

  762. 

  763. <dl class="function">

  764. <dt id="webnotes.model.triggers.setup">

  765. <tt class="descclassname">webnotes.model.triggers.</tt><tt class="descname">setup</tt><big>(</big><big>)</big><a class="reference internal" href="_modules/webnotes/model/triggers.html#setup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.triggers.setup" title="Permalink to this definition">¶</a></dt>

  766. <dd><p>creates the DocTrigger table from core</p>

  767. </dd></dl>

  768. 

  769. <dl class="function">

  770. <dt id="webnotes.model.triggers.trigger_exists">

  771. <tt class="descclassname">webnotes.model.triggers.</tt><tt class="descname">trigger_exists</tt><big>(</big><em>doctype</em>, <em>docname</em>, <em>event_name</em>, <em>method</em><big>)</big><a class="reference internal" href="_modules/webnotes/model/triggers.html#trigger_exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#webnotes.model.triggers.trigger_exists" title="Permalink to this definition">¶</a></dt>

  772. <dd><p>returns true if trigger exists</p>

  773. </dd></dl>

  774. 

  775. </div>

  776. </div>

  777. 

  778. 

  779.           </div>

  780.         </div>

  781.       </div>

  782.       <div class="sphinxsidebar">

  783.         <div class="sphinxsidebarwrapper">

  784.             <p class="logo"><a href="index.html">

  785.               <img class="logo" src="_static/wnflogo200.gif" alt="Logo"/>

  786.             </a></p>

  787.   <h3><a href="index.html">Table Of Contents</a></h3>

  788.   <ul>

  789. <li><a class="reference internal" href="#">model Package</a><ul>

  790. <li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">model</span></tt> Package</a></li>

  791. <li><a class="reference internal" href="#module-webnotes.model.code"><tt class="docutils literal"><span class="pre">code</span></tt> Module</a></li>

  792. <li><a class="reference internal" href="#module-webnotes.model.db_schema"><tt class="docutils literal"><span class="pre">db_schema</span></tt> Module</a></li>

  793. <li><a class="reference internal" href="#module-webnotes.model.doc"><tt class="docutils literal"><span class="pre">doc</span></tt> Module</a></li>

  794. <li><a class="reference internal" href="#module-webnotes.model.doclist"><tt class="docutils literal"><span class="pre">doclist</span></tt> Module</a></li>

  795. <li><a class="reference internal" href="#module-webnotes.model.doctype"><tt class="docutils literal"><span class="pre">doctype</span></tt> Module</a><ul>

  796. <li><a class="reference internal" href="#id2">DocType module</a></li>

  797. </ul>

  798. </li>

  799. <li><a class="reference internal" href="#module-webnotes.model.import_docs"><tt class="docutils literal"><span class="pre">import_docs</span></tt> Module</a></li>

  800. <li><a class="reference internal" href="#module-webnotes.model.meta"><tt class="docutils literal"><span class="pre">meta</span></tt> Module</a></li>

  801. <li><a class="reference internal" href="#module-webnotes.model.modules"><tt class="docutils literal"><span class="pre">modules</span></tt> Module</a></li>

  802. <li><a class="reference internal" href="#module-webnotes.model.triggers"><tt class="docutils literal"><span class="pre">triggers</span></tt> Module</a></li>

  803. </ul>

  804. </li>

  805. </ul>

  806. 

  807.   <h3>This Page</h3>

  808.   <ul class="this-page-menu">

  809.     <li><a href="_sources/webnotes.model.txt"

  810.            rel="nofollow">Show Source</a></li>

  811.   </ul>

  812. <div id="searchbox" style="display: none">

  813.   <h3>Quick search</h3>

  814.     <form class="search" action="search.html" method="get">

  815.       <input type="text" name="q" size="18" />

  816.       <input type="submit" value="Go" />

  817.       <input type="hidden" name="check_keywords" value="yes" />

  818.       <input type="hidden" name="area" value="default" />

  819.     </form>

  820.     <p class="searchtip" style="font-size: 90%">

  821.     Enter search terms or a module, class or function name.

  822.     </p>

  823. </div>

  824. <script type="text/javascript">$('#searchbox').show(0);</script>

  825.         </div>

  826.       </div>

  827.       <div class="clearer"></div>

  828.     </div>

  829.     <div class="related">

  830.       <h3>Navigation</h3>

  831.       <ul>

  832.         <li class="right" style="margin-right: 10px">

  833.           <a href="genindex.html" title="General Index"

  834.              >index</a></li>

  835.         <li class="right" >

  836.           <a href="py-modindex.html" title="Python Module Index"

  837.              >modules</a> |</li>

  838.         <li><a href="index.html">WNFramework v1.8 documentation</a> &raquo;</li> 

  839.       </ul>

  840.     </div>

  841.     <div class="footer">

  842.         &copy; Copyright 2011, Rushabh Mehta, Web Notes Technologies.

  843.       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.

  844.     </div>

  845.   </body>

  846. </html>