/usr/share/doc/python-sqlparse/html/api.html is in python-sqlparse 0.1.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>sqlparse – Parse SQL statements — python-sqlparse v0.1.3 documentation</title>
<link rel="stylesheet" href="_static/agogo.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '#',
VERSION: '0.1.3',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="python-sqlparse v0.1.3 documentation" href="index.html" />
<link rel="next" title="Analyzing the Parsed Statement" href="analyzing.html" />
<link rel="prev" title="Introduction" href="intro.html" />
</head>
<body>
<div class="header-wrapper">
<div class="header">
<h1><a href="index.html">python-sqlparse v0.1.3 documentation</a></h1>
<div class="rel">
<a href="genindex.html" title="General Index"
accesskey="I">index</a> |
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |
<a href="analyzing.html" title="Analyzing the Parsed Statement"
accesskey="N">next</a> |
<a href="intro.html" title="Introduction"
accesskey="P">previous</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="module-sqlparse">
<span id="sqlparse-parse-sql-statements"></span><h1><a class="reference internal" href="#module-sqlparse" title="sqlparse: Parse SQL statements."><tt class="xref py py-mod docutils literal"><span class="pre">sqlparse</span></tt></a> – Parse SQL statements<a class="headerlink" href="#module-sqlparse" title="Permalink to this headline">¶</a></h1>
<p>The <a class="reference internal" href="#module-sqlparse" title="sqlparse: Parse SQL statements."><tt class="xref py py-mod docutils literal"><span class="pre">sqlparse</span></tt></a> module provides the following functions on module-level.</p>
<dl class="function">
<dt id="sqlparse.split">
<tt class="descclassname">sqlparse.</tt><tt class="descname">split</tt><big>(</big><em>sql</em><big>)</big><a class="headerlink" href="#sqlparse.split" title="Permalink to this definition">¶</a></dt>
<dd><p>Split <em>sql</em> into single statements.</p>
<p>Returns a list of strings.</p>
</dd></dl>
<dl class="function">
<dt id="sqlparse.format">
<tt class="descclassname">sqlparse.</tt><tt class="descname">format</tt><big>(</big><em>sql</em>, <em>**options</em><big>)</big><a class="headerlink" href="#sqlparse.format" title="Permalink to this definition">¶</a></dt>
<dd><p>Format <em>sql</em> according to <em>options</em>.</p>
<p>Available options are documented in <a class="reference internal" href="#formatting"><em>Formatting of SQL Statements</em></a>.</p>
<p>Returns the formatted SQL statement as string.</p>
</dd></dl>
<dl class="function">
<dt id="sqlparse.parse">
<tt class="descclassname">sqlparse.</tt><tt class="descname">parse</tt><big>(</big><em>sql</em><big>)</big><a class="headerlink" href="#sqlparse.parse" title="Permalink to this definition">¶</a></dt>
<dd><p>Parse sql and return a list of statements.</p>
<p><em>sql</em> is a single string containting one or more SQL statements.</p>
<p>Returns a tuple of <a class="reference internal" href="analyzing.html#sqlparse.sql.Statement" title="sqlparse.sql.Statement"><tt class="xref py py-class docutils literal"><span class="pre">Statement</span></tt></a> instances.</p>
</dd></dl>
<div class="section" id="formatting-of-sql-statements">
<span id="formatting"></span><h2>Formatting of SQL Statements<a class="headerlink" href="#formatting-of-sql-statements" title="Permalink to this headline">¶</a></h2>
<p>The <a class="reference internal" href="#sqlparse.format" title="sqlparse.format"><tt class="xref py py-meth docutils literal"><span class="pre">format()</span></tt></a> function accepts the following keyword arguments.</p>
<dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">keyword_case</span></tt></dt>
<dd>Changes how keywords are formatted. Allowed values are “upper”, “lower”
and “capitalize”.</dd>
<dt><tt class="docutils literal"><span class="pre">identifier_case</span></tt></dt>
<dd>Changes how identifiers are formatted. Allowed values are “upper”, “lower”,
and “capitalize”.</dd>
<dt><tt class="docutils literal"><span class="pre">strip_comments</span></tt></dt>
<dd>If <tt class="xref docutils literal"><span class="pre">True</span></tt> comments are removed from the statements.</dd>
<dt><tt class="docutils literal"><span class="pre">reindent</span></tt></dt>
<dd>If <tt class="xref docutils literal"><span class="pre">True</span></tt> the indentations of the statements are changed.</dd>
<dt><tt class="docutils literal"><span class="pre">indent_tabs</span></tt></dt>
<dd>If <tt class="xref docutils literal"><span class="pre">True</span></tt> tabs instead of spaces are used for indentation.</dd>
<dt><tt class="docutils literal"><span class="pre">indent_width</span></tt></dt>
<dd>The width of the indentation, defaults to 2.</dd>
<dt><tt class="docutils literal"><span class="pre">output_format</span></tt></dt>
<dd>If given the output is additionally formatted to be used as a variable
in a programming language. Allowed values are “python” and “php”.</dd>
</dl>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sidebar">
<h3>Contents</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href=""><tt class="docutils literal"><span class="pre">sqlparse</span></tt> – Parse SQL statements</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#formatting-of-sql-statements">Formatting of SQL Statements</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="analyzing.html">Analyzing the Parsed Statement</a></li>
<li class="toctree-l1"><a class="reference internal" href="ui.html">User Interfaces</a></li>
<li class="toctree-l1"><a class="reference internal" href="changes.html">Changes in python-sqlparse</a></li>
</ul>
<h3 style="margin-top: 1.5em;">Search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer">
<div class="left">
<a href="genindex.html" title="General Index"
>index</a> |
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |
<a href="analyzing.html" title="Analyzing the Parsed Statement"
>next</a> |
<a href="intro.html" title="Introduction"
>previous</a>
<br/>
<a href="_sources/api.txt"
rel="nofollow">Show Source</a>
</div>
<div class="right">
© Copyright 2011, Andi Albrecht.<br/>
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
<div class="clearer"></div>
</div>
</div>
</body>
</html>
|