Skip to content

Generated docs for #549 #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: docstr-1
Choose a base branch
from
Open

Generated docs for #549 #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9e81093
Add generated API docs for spanner_dbapi module
c24t Nov 2, 2020
344543f
Add built HTML docs for 9e81093
c24t Nov 2, 2020
fc215e4
Add sphinx-quickstart-generated makefiles
c24t Nov 2, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Minimal makefile for Sphinx documentation
#

# You can set these variables from the command line, and also
# from the environment for the first two.
SPHINXOPTS ?=
SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build

# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

.PHONY: help Makefile

# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
4 changes: 4 additions & 0 deletions docs/_build/html/.buildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 12cdc5d0e42bbebda02cdf5255ea4e8a
tags: 645f666f9bcd5a90fca523b33c5a78b7
123 changes: 123 additions & 0 deletions docs/_build/html/README.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@


<!DOCTYPE html>

<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>&lt;no title&gt; &#8212; google-cloud-spanner-django 2.2.0a1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />

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


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>



<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<p>../README.rst</p>


</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">google-cloud-spanner-django</a></h1>



<p class="blurb">Django API Libraries for google-cloud-spanner</p>




<p>
<iframe src="https://ghbtns.com/github-btn.html?user=googleapis&repo=python-spanner-django&type=watch&count=true&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>





<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="connection-usage.html">DB API Connection</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api-reference.html">API Reference</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>








</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2020, Google.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

|
<a href="_sources/README.rst.txt"
rel="nofollow">Page source</a>
</div>


<a href="https://github.com/googleapis/python-spanner-django" class="github">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</a>



</body>
</html>
717 changes: 717 additions & 0 deletions docs/_build/html/_modules/base64.html
View file
Open in desktop

Large diffs are not rendered by default.

2,640 changes: 2,640 additions & 0 deletions docs/_build/html/_modules/datetime.html
View file
Open in desktop

Large diffs are not rendered by default.

386 changes: 386 additions & 0 deletions docs/_build/html/_modules/google/cloud/spanner_dbapi/connection.html
View file
Open in desktop

Large diffs are not rendered by default.

463 changes: 463 additions & 0 deletions docs/_build/html/_modules/google/cloud/spanner_dbapi/cursor.html
View file
Open in desktop

Large diffs are not rendered by default.

216 changes: 216 additions & 0 deletions docs/_build/html/_modules/google/cloud/spanner_dbapi/exceptions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@


<!DOCTYPE html>

<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>google.cloud.spanner_dbapi.exceptions &#8212; google-cloud-spanner-django 2.2.0a1 documentation</title>
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/alabaster.css" type="text/css" />
<script id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script src="../../../../_static/jquery.js"></script>
<script src="../../../../_static/underscore.js"></script>
<script src="../../../../_static/doctools.js"></script>
<script src="../../../../_static/language_data.js"></script>
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />

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


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head><body>



<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">


<div class="body" role="main">

<h1>Source code for google.cloud.spanner_dbapi.exceptions</h1><div class="highlight"><pre>
<span></span><span class="c1"># Copyright 2020 Google LLC</span>
<span class="c1">#</span>
<span class="c1"># Use of this source code is governed by a BSD-style</span>
<span class="c1"># license that can be found in the LICENSE file or at</span>
<span class="c1"># https://developers.google.com/open-source/licenses/bsd</span>

<span class="sd">&quot;&quot;&quot;Spanner DB API exceptions.&quot;&quot;&quot;</span>


<div class="viewcode-block" id="Warning"><a class="viewcode-back" href="../../../../spanner_dbapi.html#google.cloud.spanner_dbapi.exceptions.Warning">[docs]</a><span class="k">class</span> <span class="nc">Warning</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Important DB API warning.&quot;&quot;&quot;</span>

<span class="k">pass</span></div>


<div class="viewcode-block" id="Error"><a class="viewcode-back" href="../../../../spanner_dbapi.html#google.cloud.spanner_dbapi.exceptions.Error">[docs]</a><span class="k">class</span> <span class="nc">Error</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;The base class for all the DB API exceptions.</span>

<span class="sd"> Does not include :class:`Warning`.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">pass</span></div>


<div class="viewcode-block" id="InterfaceError"><a class="viewcode-back" href="../../../../spanner_dbapi.html#google.cloud.spanner_dbapi.exceptions.InterfaceError">[docs]</a><span class="k">class</span> <span class="nc">InterfaceError</span><span class="p">(</span><span class="n">Error</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Error related to the database interface</span>
<span class="sd"> rather than the database itself.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">pass</span></div>


<div class="viewcode-block" id="DatabaseError"><a class="viewcode-back" href="../../../../spanner_dbapi.html#google.cloud.spanner_dbapi.exceptions.DatabaseError">[docs]</a><span class="k">class</span> <span class="nc">DatabaseError</span><span class="p">(</span><span class="n">Error</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Error related to the database.&quot;&quot;&quot;</span>

<span class="k">pass</span></div>


<div class="viewcode-block" id="DataError"><a class="viewcode-back" href="../../../../spanner_dbapi.html#google.cloud.spanner_dbapi.exceptions.DataError">[docs]</a><span class="k">class</span> <span class="nc">DataError</span><span class="p">(</span><span class="n">DatabaseError</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Error due to problems with the processed data like</span>
<span class="sd"> division by zero, numeric value out of range, etc.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">pass</span></div>


<div class="viewcode-block" id="OperationalError"><a class="viewcode-back" href="../../../../spanner_dbapi.html#google.cloud.spanner_dbapi.exceptions.OperationalError">[docs]</a><span class="k">class</span> <span class="nc">OperationalError</span><span class="p">(</span><span class="n">DatabaseError</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Error related to the database&#39;s operation, e.g. an</span>
<span class="sd"> unexpected disconnect, the data source name is not</span>
<span class="sd"> found, a transaction could not be processed, a</span>
<span class="sd"> memory allocation error, etc.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">pass</span></div>


<div class="viewcode-block" id="IntegrityError"><a class="viewcode-back" href="../../../../spanner_dbapi.html#google.cloud.spanner_dbapi.exceptions.IntegrityError">[docs]</a><span class="k">class</span> <span class="nc">IntegrityError</span><span class="p">(</span><span class="n">DatabaseError</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Error for cases of relational integrity of the database</span>
<span class="sd"> is affected, e.g. a foreign key check fails.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">pass</span></div>


<div class="viewcode-block" id="InternalError"><a class="viewcode-back" href="../../../../spanner_dbapi.html#google.cloud.spanner_dbapi.exceptions.InternalError">[docs]</a><span class="k">class</span> <span class="nc">InternalError</span><span class="p">(</span><span class="n">DatabaseError</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Internal database error, e.g. the cursor is not valid</span>
<span class="sd"> anymore, the transaction is out of sync, etc.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">pass</span></div>


<div class="viewcode-block" id="ProgrammingError"><a class="viewcode-back" href="../../../../spanner_dbapi.html#google.cloud.spanner_dbapi.exceptions.ProgrammingError">[docs]</a><span class="k">class</span> <span class="nc">ProgrammingError</span><span class="p">(</span><span class="n">DatabaseError</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Programming error, e.g. table not found or already</span>
<span class="sd"> exists, syntax error in the SQL statement, wrong</span>
<span class="sd"> number of parameters specified, etc.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">pass</span></div>


<div class="viewcode-block" id="NotSupportedError"><a class="viewcode-back" href="../../../../spanner_dbapi.html#google.cloud.spanner_dbapi.exceptions.NotSupportedError">[docs]</a><span class="k">class</span> <span class="nc">NotSupportedError</span><span class="p">(</span><span class="n">DatabaseError</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Error for case of a method or database API not</span>
<span class="sd"> supported by the database was used.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">pass</span></div>
</pre></div>

</div>

</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../../../index.html">google-cloud-spanner-django</a></h1>



<p class="blurb">Django API Libraries for google-cloud-spanner</p>




<p>
<iframe src="https://ghbtns.com/github-btn.html?user=googleapis&repo=python-spanner-django&type=watch&count=true&size=large&v=2"
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
</p>





<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../connection-usage.html">DB API Connection</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../api-reference.html">API Reference</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../../../index.html">Documentation overview</a><ul>
<li><a href="../../../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>








</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2020, Google.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.3.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>

</div>


<a href="https://github.com/googleapis/python-spanner-django" class="github">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub" class="github"/>
</a>



</body>
</html>
Loading