Skip to content

Commit 5ea02d0

Browse files
kesmit13kesmit13
committed
Prepare for v1.14.0 release
1 parent bb72bcd commit 5ea02d0

File tree

177 files changed

+996
-517
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

177 files changed

+996
-517
lines changed

‎docs/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 4cdb500dbb1e1c45612c8f14128c6598
3+
config: 8b72416d176e70a7fb81d9dcb349a992
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/_sources/api.rst.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ The :func:`connect` function is the primary entry point for the SingleStore
99
package. It connects to a SingleStore database using either
1010
`DB-API <https://peps.python.org/pep-0249/>`_ compliant parameters,
1111
or a connection string in the form of a URL.
12+
The :func:`vector_db` function gives you an interface for working with
13+
an API better for working with vector data.
1214
The :func:`create_engine` function is used with the SQLAlchemy package
1315
to create an SQLAlchemy engine for SingleStoreDB connections. This is
1416
primarily for use in environments where the connection parameters are
@@ -17,6 +19,7 @@ connections without specifying any parameters in the code itself.
1719
.. autosummary::
1820
:toctree: generated/
1921
connect
22+
vector_db
2023
create_engine
2124
Connection
2225
..........
@@ -34,6 +37,7 @@ used to create :class:`Cursor` objects for querying the database.
3437
Connection.is_connected
3538
Connection.enable_data_api
3639
Connection.disable_data_api
40+
Connection.vector_db
3741
The :attr:`Connection.show` attribute of the connection objects allow you to access various
3842
information about the server. The available operations are shown below.
3943
.. currentmodule:: singlestoredb.connection

‎docs/_sources/generated/singlestoredb.connection.Connection.rst.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
~Connection.messages
2424
~Connection.paramstyle
2525
~Connection.show
26+
~Connection.vector_db
2627
~Connection.encoding
2728
~Connection.globals
2829
~Connection.locals

‎docs/_sources/generated/singlestoredb.connection.Connection.vector_db.rst.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
singlestoredb.connection.Connection.vector\_db
2+
==============================================
3+
.. currentmodule:: singlestoredb.connection
4+
.. autoproperty:: Connection.vector_db

‎docs/_sources/generated/singlestoredb.vector_db.rst.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
singlestoredb.vector\_db
2+
========================
3+
.. currentmodule:: singlestoredb
4+
.. autofunction:: vector_db

‎docs/_static/documentation_options.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '1.13.1',
2+
VERSION: '1.14.0',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

‎docs/api.html‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
<head>
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>API Reference &mdash; SingleStoreDB 1.13.1 documentation</title>
6+
<title>API Reference &mdash; SingleStoreDB 1.14.0 documentation</title>
77
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
99
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
1010
<!--[if lt IE 9]>
1111
<script src="_static/js/html5shiv.min.js"></script>
1212
<![endif]-->
13-
<script src="_static/documentation_options.js?v=2b23eb2b"></script>
13+
<script src="_static/documentation_options.js?v=01009efc"></script>
1414
<script src="_static/doctools.js?v=9a2dae69"></script>
1515
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="_static/js/theme.js"></script>
@@ -28,7 +28,7 @@
2828
SingleStoreDB
2929
</a>
3030
<div class="version">
31-
1.13.1
31+
1.14.0
3232
</div>
3333
<div role="search">
3434
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
@@ -46,6 +46,7 @@
4646
<li class="toctree-l1 current"><a class="current reference internal" href="#">API Reference</a><ul>
4747
<li class="toctree-l2"><a class="reference internal" href="#connections">Connections</a><ul>
4848
<li class="toctree-l3"><a class="reference internal" href="generated/singlestoredb.connect.html">singlestoredb.connect</a></li>
49+
<li class="toctree-l3"><a class="reference internal" href="generated/singlestoredb.vector_db.html">singlestoredb.vector_db</a></li>
4950
<li class="toctree-l3"><a class="reference internal" href="generated/singlestoredb.create_engine.html">singlestoredb.create_engine</a></li>
5051
<li class="toctree-l3"><a class="reference internal" href="#connection">Connection</a><ul>
5152
<li class="toctree-l4"><a class="reference internal" href="generated/singlestoredb.connection.Connection.html">Connection</a></li>
@@ -57,6 +58,7 @@
5758
<li class="toctree-l4"><a class="reference internal" href="generated/singlestoredb.connection.Connection.is_connected.html">Connection.is_connected</a></li>
5859
<li class="toctree-l4"><a class="reference internal" href="generated/singlestoredb.connection.Connection.enable_data_api.html">Connection.enable_data_api</a></li>
5960
<li class="toctree-l4"><a class="reference internal" href="generated/singlestoredb.connection.Connection.disable_data_api.html">Connection.disable_data_api</a></li>
61+
<li class="toctree-l4"><a class="reference internal" href="generated/singlestoredb.connection.Connection.vector_db.html">Connection.vector_db</a></li>
6062
<li class="toctree-l4"><a class="reference internal" href="generated/singlestoredb.connection.ShowAccessor.aggregates.html">Connection.show.aggregates</a></li>
6163
<li class="toctree-l4"><a class="reference internal" href="generated/singlestoredb.connection.ShowAccessor.columns.html">Connection.show.columns</a></li>
6264
<li class="toctree-l4"><a class="reference internal" href="generated/singlestoredb.connection.ShowAccessor.create_aggregate.html">Connection.show.create_aggregate</a></li>
@@ -284,6 +286,8 @@
284286
package. It connects to a SingleStore database using either
285287
<a class="reference external" href="https://peps.python.org/pep-0249/">DB-API</a> compliant parameters,
286288
or a connection string in the form of a URL.</p>
289+
<p>The <a class="reference internal" href="generated/singlestoredb.vector_db.html#singlestoredb.vector_db" title="singlestoredb.vector_db"><code class="xref py py-func docutils literal notranslate"><span class="pre">vector_db()</span></code></a> function gives you an interface for working with
290+
an API better for working with vector data.</p>
287291
<p>The <a class="reference internal" href="generated/singlestoredb.create_engine.html#singlestoredb.create_engine" title="singlestoredb.create_engine"><code class="xref py py-func docutils literal notranslate"><span class="pre">create_engine()</span></code></a> function is used with the SQLAlchemy package
288292
to create an SQLAlchemy engine for SingleStoreDB connections. This is
289293
primarily for use in environments where the connection parameters are
@@ -294,7 +298,10 @@
294298
<tr class="row-odd"><td><p><a class="reference internal" href="generated/singlestoredb.connect.html#singlestoredb.connect" title="singlestoredb.connect"><code class="xref py py-obj docutils literal notranslate"><span class="pre">connect</span></code></a>([host, user, password, port, ...])</p></td>
295299
<td><p>Return a SingleStoreDB connection.</p></td>
296300
</tr>
297-
<tr class="row-even"><td><p><a class="reference internal" href="generated/singlestoredb.create_engine.html#singlestoredb.create_engine" title="singlestoredb.create_engine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_engine</span></code></a>(*args, **kwargs)</p></td>
301+
<tr class="row-even"><td><p><a class="reference internal" href="generated/singlestoredb.vector_db.html#singlestoredb.vector_db" title="singlestoredb.vector_db"><code class="xref py py-obj docutils literal notranslate"><span class="pre">vector_db</span></code></a>([host, user, password, port, ...])</p></td>
302+
<td><p>Return a vectorstore API connection.</p></td>
303+
</tr>
304+
<tr class="row-odd"><td><p><a class="reference internal" href="generated/singlestoredb.create_engine.html#singlestoredb.create_engine" title="singlestoredb.create_engine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">create_engine</span></code></a>(*args, **kwargs)</p></td>
298305
<td><p>Create an SQLAlchemy engine for SingleStoreDB.</p></td>
299306
</tr>
300307
</tbody>
@@ -332,6 +339,9 @@ <h3>Connection<a class="headerlink" href="#connection" title="Link to this headi
332339
<tr class="row-odd"><td><p><a class="reference internal" href="generated/singlestoredb.connection.Connection.disable_data_api.html#singlestoredb.connection.Connection.disable_data_api" title="singlestoredb.connection.Connection.disable_data_api"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Connection.disable_data_api</span></code></a>()</p></td>
333340
<td><p>Disable the data API.</p></td>
334341
</tr>
342+
<tr class="row-even"><td><p><a class="reference internal" href="generated/singlestoredb.connection.Connection.vector_db.html#singlestoredb.connection.Connection.vector_db" title="singlestoredb.connection.Connection.vector_db"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Connection.vector_db</span></code></a></p></td>
343+
<td><p>Get vectorstore API accessor</p></td>
344+
</tr>
335345
</tbody>
336346
</table>
337347
<p>The <code class="xref py py-attr docutils literal notranslate"><span class="pre">Connection.show</span></code> attribute of the connection objects allow you to access various

‎docs/generated/singlestoredb.auth.get_jwt.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
<head>
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>singlestoredb.auth.get_jwt &mdash; SingleStoreDB 1.13.1 documentation</title>
6+
<title>singlestoredb.auth.get_jwt &mdash; SingleStoreDB 1.14.0 documentation</title>
77
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
1010
<!--[if lt IE 9]>
1111
<script src="../_static/js/html5shiv.min.js"></script>
1212
<![endif]-->
13-
<script src="../_static/documentation_options.js?v=2b23eb2b"></script>
13+
<script src="../_static/documentation_options.js?v=01009efc"></script>
1414
<script src="../_static/doctools.js?v=9a2dae69"></script>
1515
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../_static/js/theme.js"></script>
@@ -28,7 +28,7 @@
2828
SingleStoreDB
2929
</a>
3030
<div class="version">
31-
1.13.1
31+
1.14.0
3232
</div>
3333
<div role="search">
3434
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">

‎docs/generated/singlestoredb.connect.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@
33
<head>
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>singlestoredb.connect &mdash; SingleStoreDB 1.13.1 documentation</title>
6+
<title>singlestoredb.connect &mdash; SingleStoreDB 1.14.0 documentation</title>
77
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
1010
<!--[if lt IE 9]>
1111
<script src="../_static/js/html5shiv.min.js"></script>
1212
<![endif]-->
13-
<script src="../_static/documentation_options.js?v=2b23eb2b"></script>
13+
<script src="../_static/documentation_options.js?v=01009efc"></script>
1414
<script src="../_static/doctools.js?v=9a2dae69"></script>
1515
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../_static/js/theme.js"></script>
1717
<link rel="index" title="Index" href="../genindex.html" />
1818
<link rel="search" title="Search" href="../search.html" />
19-
<link rel="next" title="singlestoredb.create_engine" href="singlestoredb.create_engine.html" />
19+
<link rel="next" title="singlestoredb.vector_db" href="singlestoredb.vector_db.html" />
2020
<link rel="prev" title="API Reference" href="../api.html" />
2121
</head>
2222
<body class="wy-body-for-nav">
@@ -28,7 +28,7 @@
2828
SingleStoreDB
2929
</a>
3030
<div class="version">
31-
1.13.1
31+
1.14.0
3232
</div>
3333
<div role="search">
3434
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -49,6 +49,7 @@
4949
<li class="toctree-l4"><a class="reference internal" href="#singlestoredb.connect"><code class="docutils literal notranslate"><span class="pre">connect()</span></code></a></li>
5050
</ul>
5151
</li>
52+
<li class="toctree-l3"><a class="reference internal" href="singlestoredb.vector_db.html">singlestoredb.vector_db</a></li>
5253
<li class="toctree-l3"><a class="reference internal" href="singlestoredb.create_engine.html">singlestoredb.create_engine</a></li>
5354
<li class="toctree-l3"><a class="reference internal" href="../api.html#connection">Connection</a></li>
5455
<li class="toctree-l3"><a class="reference internal" href="../api.html#cursor">Cursor</a></li>
@@ -204,7 +205,7 @@ <h1>singlestoredb.connect<a class="headerlink" href="#singlestoredb-connect" tit
204205
</div>
205206
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
206207
<a href="../api.html" class="btn btn-neutral float-left" title="API Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
207-
<a href="singlestoredb.create_engine.html" class="btn btn-neutral float-right" title="singlestoredb.create_engine" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
208+
<a href="singlestoredb.vector_db.html" class="btn btn-neutral float-right" title="singlestoredb.vector_db" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
208209
</div>
209210
<hr/>
210211
<div role="contentinfo">

‎docs/generated/singlestoredb.connection.Connection.autocommit.html‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
<head>
44
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>singlestoredb.connection.Connection.autocommit &mdash; SingleStoreDB 1.13.1 documentation</title>
6+
<title>singlestoredb.connection.Connection.autocommit &mdash; SingleStoreDB 1.14.0 documentation</title>
77
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
99
<link rel="stylesheet" href="../_static/custom.css" type="text/css" />
1010
<!--[if lt IE 9]>
1111
<script src="../_static/js/html5shiv.min.js"></script>
1212
<![endif]-->
13-
<script src="../_static/documentation_options.js?v=2b23eb2b"></script>
13+
<script src="../_static/documentation_options.js?v=01009efc"></script>
1414
<script src="../_static/doctools.js?v=9a2dae69"></script>
1515
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1616
<script src="../_static/js/theme.js"></script>
@@ -28,7 +28,7 @@
2828
SingleStoreDB
2929
</a>
3030
<div class="version">
31-
1.13.1
31+
1.14.0
3232
</div>
3333
<div role="search">
3434
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@@ -46,6 +46,7 @@
4646
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">API Reference</a><ul class="current">
4747
<li class="toctree-l2 current"><a class="reference internal" href="../api.html#connections">Connections</a><ul class="current">
4848
<li class="toctree-l3"><a class="reference internal" href="singlestoredb.connect.html">singlestoredb.connect</a></li>
49+
<li class="toctree-l3"><a class="reference internal" href="singlestoredb.vector_db.html">singlestoredb.vector_db</a></li>
4950
<li class="toctree-l3"><a class="reference internal" href="singlestoredb.create_engine.html">singlestoredb.create_engine</a></li>
5051
<li class="toctree-l3 current"><a class="reference internal" href="../api.html#connection">Connection</a><ul class="current">
5152
<li class="toctree-l4"><a class="reference internal" href="singlestoredb.connection.Connection.html">Connection</a></li>
@@ -57,6 +58,7 @@
5758
<li class="toctree-l4"><a class="reference internal" href="singlestoredb.connection.Connection.is_connected.html">Connection.is_connected</a></li>
5859
<li class="toctree-l4"><a class="reference internal" href="singlestoredb.connection.Connection.enable_data_api.html">Connection.enable_data_api</a></li>
5960
<li class="toctree-l4"><a class="reference internal" href="singlestoredb.connection.Connection.disable_data_api.html">Connection.disable_data_api</a></li>
61+
<li class="toctree-l4"><a class="reference internal" href="singlestoredb.connection.Connection.vector_db.html">Connection.vector_db</a></li>
6062
<li class="toctree-l4"><a class="reference internal" href="singlestoredb.connection.ShowAccessor.aggregates.html">Connection.show.aggregates</a></li>
6163
<li class="toctree-l4"><a class="reference internal" href="singlestoredb.connection.ShowAccessor.columns.html">Connection.show.columns</a></li>
6264
<li class="toctree-l4"><a class="reference internal" href="singlestoredb.connection.ShowAccessor.create_aggregate.html">Connection.show.create_aggregate</a></li>

0 commit comments

Comments
 (0)