PageRenderTime 42ms CodeModel.GetById 13ms RepoModel.GetById 0ms app.codeStats 0ms

/api/openlibrary/utils/solr.html

https://github.com/strogo/openlibrary.github.com
HTML | 165 lines | 153 code | 12 blank | 0 comment | 0 complexity | 882ee263e5136c69c68e611573a66029 MD5 | raw file
    

  1. 

  2. 

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

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

  5. 

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

  7.   <head>
    8. 

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

  9.     
    10. 

  10.     <title>solr &mdash; openlibrary v2.0 documentation</title>
    11. 

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

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

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

  14.       var DOCUMENTATION_OPTIONS = {
    15. 

  15.         URL_ROOT:    '../../../',
    16. 

  16.         VERSION:     '2.0',
    17. 

  17.         COLLAPSE_INDEX: false,
    18. 

  18.         FILE_SUFFIX: '.html',
    19. 

  19.         HAS_SOURCE:  true
    20. 

  20.       };
    21. 

  21.     </script>
    22. 

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

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

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

  25.     <link rel="top" title="openlibrary v2.0 documentation" href="../../../index.html" />
    26. 

  26.     <link rel="up" title="utils" href="index.html" />
    27. 

  27.     <link rel="next" title="infogami" href="../../infogami/index.html" />
    28. 

  28.     <link rel="prev" title="schema" href="schema.html" /> 
    29. 

  29.   </head>
    30. 

  30.   <body>
    31. 

  31.     <div class="related">
    32. 

  32.       <h3>Navigation</h3>
    33. 

  33.       <ul>
    34. 

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

  35.           <a href="../../../genindex.html" title="General Index"
    36. 

  36.              accesskey="I">index</a></li>
    37. 

  37.         <li class="right" >
    38. 

  38.           <a href="../../../py-modindex.html" title="Python Module Index"
    39. 

  39.              >modules</a> |</li>
    40. 

  40.         <li class="right" >
    41. 

  41.           <a href="../../infogami/index.html" title="infogami"
    42. 

  42.              accesskey="N">next</a> |</li>
    43. 

  43.         <li class="right" >
    44. 

  44.           <a href="schema.html" title="schema"
    45. 

  45.              accesskey="P">previous</a> |</li>
    46. 

  46.         <li><a href="../../../index.html">openlibrary v2.0 documentation</a> &raquo;</li>
    47. 

  47.           <li><a href="../../index.html" >API Documentation</a> &raquo;</li>
    48. 

  48.           <li><a href="../index.html" >openlibrary</a> &raquo;</li>
    49. 

  49.           <li><a href="index.html" accesskey="U">utils</a> &raquo;</li> 
    50. 

  50.       </ul>
    51. 

  51.     </div>  
    52. 

  52. 

  53.     <div class="document">
    54. 

  54.       <div class="documentwrapper">
    55. 

  55.         <div class="bodywrapper">
    56. 

  56.           <div class="body">
    57. 

  57.             
    58. 

  58.   <div class="section" id="module-openlibrary.utils.solr">
    59. 

  59. <span id="solr"></span><h1>solr<a class="headerlink" href="#module-openlibrary.utils.solr" title="Permalink to this headline"></a></h1>
    60. 

  60. <p>Python library for accessing Solr.</p>
    61. 

  61. <dl class="class">
    62. 

  62. <dt id="openlibrary.utils.solr.Solr">
    63. 

  63. <em class="property">class </em><tt class="descclassname">openlibrary.utils.solr.</tt><tt class="descname">Solr</tt><big>(</big><em>base_url</em><big>)</big><a class="headerlink" href="#openlibrary.utils.solr.Solr" title="Permalink to this definition"></a></dt>
    64. 

  64. <dd><dl class="method">
    65. 

  65. <dt id="openlibrary.utils.solr.Solr.escape">
    66. 

  66. <tt class="descname">escape</tt><big>(</big><em>query</em><big>)</big><a class="headerlink" href="#openlibrary.utils.solr.Solr.escape" title="Permalink to this definition"></a></dt>
    67. 

  67. <dd><p>Escape special characters in the query string</p>
    68. 

  68. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">solr</span> <span class="o">=</span> <span class="n">Solr</span><span class="p">(</span><span class="s">&quot;&quot;</span><span class="p">)</span>
    69. 

  69. <span class="gp">&gt;&gt;&gt; </span><span class="n">solr</span><span class="o">.</span><span class="n">escape</span><span class="p">(</span><span class="s">&quot;a[b]c&quot;</span><span class="p">)</span>
    70. 

  70. <span class="go">&#39;a\\[b\\]c&#39;</span>
    71. 

  71. </pre></div>
    72. 

  72. </div>
    73. 

  73. </dd></dl>
    74. 

  74. 

  75. <dl class="method">
    76. 

  76. <dt id="openlibrary.utils.solr.Solr.select">
    77. 

  77. <tt class="descname">select</tt><big>(</big><em>query</em>, <em>fields=None</em>, <em>facets=None</em>, <em>rows=None</em>, <em>start=None</em>, <em>doc_wrapper=None</em>, <em>facet_wrapper=None</em>, <em>**kw</em><big>)</big><a class="headerlink" href="#openlibrary.utils.solr.Solr.select" title="Permalink to this definition"></a></dt>
    78. 

  78. <dd><p>Execute a solr query.</p>
    79. 

  79. <p>query can be a string or a dicitonary. If query is a dictionary, query
    80. 

  80. is constucted by concatinating all the key-value pairs with AND condition.</p>
    81. 

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

  82. 

  83. </dd></dl>
    84. 

  84. 

  85. <dl class="function">
    86. 

  86. <dt id="openlibrary.utils.solr.urlencode">
    87. 

  87. <tt class="descclassname">openlibrary.utils.solr.</tt><tt class="descname">urlencode</tt><big>(</big><em>d</em>, <em>doseq=False</em><big>)</big><a class="headerlink" href="#openlibrary.utils.solr.urlencode" title="Permalink to this definition"></a></dt>
    88. 

  88. <dd><p>There is a bug in urllib when used with unicode data.</p>
    89. 

  89. <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">d</span> <span class="o">=</span> <span class="p">{</span><span class="s">&quot;q&quot;</span><span class="p">:</span> <span class="s">u&quot;</span><span class="se">\u0C05</span><span class="s">&quot;</span><span class="p">}</span>
    90. 

  90. <span class="gp">&gt;&gt;&gt; </span><span class="n">urllib</span><span class="o">.</span><span class="n">urlencode</span><span class="p">(</span><span class="n">d</span><span class="p">)</span>
    91. 

  91. <span class="go">&#39;q=%E0%B0%85&#39;</span>
    92. 

  92. <span class="gp">&gt;&gt;&gt; </span><span class="n">urllib</span><span class="o">.</span><span class="n">urlencode</span><span class="p">(</span><span class="n">d</span><span class="p">,</span> <span class="n">doseq</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
    93. 

  93. <span class="go">&#39;q=%3F&#39;</span>
    94. 

  94. </pre></div>
    95. 

  95. </div>
    96. 

  96. <p>This function encodes all the unicode strings in utf-8 before passing them to urllib.</p>
    97. 

  97. </dd></dl>
    98. 

  98. 

  99. </div>
    100. 

  100. 

  101. 

  102.           </div>
    103. 

  103.         </div>
    104. 

  104.       </div>
    105. 

  105.       <div class="sphinxsidebar">
    106. 

  106.         <div class="sphinxsidebarwrapper">
    107. 

  107.             <p class="logo"><a href="../../../index.html">
    108. 

  108.               <img class="logo" src="../../../_static/logo_OL-lg.png" alt="Logo"/>
    109. 

  109.             </a></p>
    110. 

  110.   <h4>Previous topic</h4>
    111. 

  111.   <p class="topless"><a href="schema.html"
    112. 

  112.                         title="previous chapter">schema</a></p>
    113. 

  113.   <h4>Next topic</h4>
    114. 

  114.   <p class="topless"><a href="../../infogami/index.html"
    115. 

  115.                         title="next chapter">infogami</a></p>
    116. 

  116.   <h3>This Page</h3>
    117. 

  117.   <ul class="this-page-menu">
    118. 

  118.     <li><a href="../../../_sources/api/openlibrary/utils/solr.txt"
    119. 

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

  120.   </ul>
    121. 

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

  122.   <h3>Quick search</h3>
    123. 

  123.     <form class="search" action="../../../search.html" method="get">
    124. 

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

  125.       <input type="submit" value="Go" />
    126. 

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

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

  128.     </form>
    129. 

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

  130.     Enter search terms or a module, class or function name.
    131. 

  131.     </p>
    132. 

  132. </div>
    133. 

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

  134.         </div>
    135. 

  135.       </div>
    136. 

  136.       <div class="clearer"></div>
    137. 

  137.     </div>
    138. 

  138.     <div class="related">
    139. 

  139.       <h3>Navigation</h3>
    140. 

  140.       <ul>
    141. 

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

  142.           <a href="../../../genindex.html" title="General Index"
    143. 

  143.              >index</a></li>
    144. 

  144.         <li class="right" >
    145. 

  145.           <a href="../../../py-modindex.html" title="Python Module Index"
    146. 

  146.              >modules</a> |</li>
    147. 

  147.         <li class="right" >
    148. 

  148.           <a href="../../infogami/index.html" title="infogami"
    149. 

  149.              >next</a> |</li>
    150. 

  150.         <li class="right" >
    151. 

  151.           <a href="schema.html" title="schema"
    152. 

  152.              >previous</a> |</li>
    153. 

  153.         <li><a href="../../../index.html">openlibrary v2.0 documentation</a> &raquo;</li>
    154. 

  154.           <li><a href="../../index.html" >API Documentation</a> &raquo;</li>
    155. 

  155.           <li><a href="../index.html" >openlibrary</a> &raquo;</li>
    156. 

  156.           <li><a href="index.html" >utils</a> &raquo;</li> 
    157. 

  157.       </ul>
    158. 

  158.     </div>
    159. 

  159.     <div class="footer">
    160. 

  160.         &copy; Copyright 2006-2011, Internet Archive.
    161. 

  161.       Last updated on Feb 27, 2011.
    162. 

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

  163.     </div>
    164. 

  164.   </body>
    165. 

  165. </html>
    166.