https://github.com/rqlite/pyrqlite
Python (DB-API 2.0) Client for rqlite, the lightweight, distributed database built on SQLite.
https://github.com/rqlite/pyrqlite
Last synced: 9 months ago
JSON representation
Python (DB-API 2.0) Client for rqlite, the lightweight, distributed database built on SQLite.
- Host: GitHub
- URL: https://github.com/rqlite/pyrqlite
- Owner: rqlite
- License: mit
- Created: 2016-02-24T02:25:32.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-26T12:26:30.000Z (over 1 year ago)
- Last Synced: 2024-04-26T13:37:13.717Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 195 KB
- Stars: 100
- Watchers: 4
- Forks: 24
- Open Issues: 9
-
Metadata Files:
- Readme: README.rst
- Changelog: ChangeLog.md
- License: LICENSE
Awesome Lists containing this project
README
-------------
pyrqlite
-------------
.. image:: https://circleci.com/gh/rqlite/pyrqlite.svg?style=svg
:target: https://circleci.com/gh/rqlite/pyrqlite
This package contains a pure-Python rqlite client library.
.. contents::
Requirements
-------------
* Python -- one of the following:
- CPython_ >= 2.7 or >= 3.3
* rqlite Server
Installation
------------
The last stable release is available on github and can be installed with ``pip``::
$ pip install git+https://github.com/rqlite/pyrqlite.git
You can also just clone the repo and install it from source::
$ git clone https://github.com/rqlite/pyrqlite.git
$ cd pyrqlite
$ python setup.py install
Finally (e.g. if ``pip`` is not available), a tarball can be downloaded
from GitHub and installed with Setuptools::
$ # X.Y.Z is the desired pyrqlite version (e.g. 2.2.1).
$ curl -L https://github.com/rqlite/pyrqlite/archive/refs/tags/vX.Y.Z.tar.gz | tar xz
$ cd pyrqlite*
$ python setup.py install
$ # The folder pyrqlite* can be safely removed now.
You mean need to run the installation process with ``root`` privileges.
Test Suite
----------
To run all the tests, execute the script ``setup.py``::
$ python setup.py test
pytest (https://pytest.org/) and pytest-cov are required to run the test
suite. They can both be installed with ``pip``
Example
-------
The following code creates a connection and executes some statements:
.. code:: python
import pyrqlite.dbapi2 as dbapi2
# Connect to the database
connection = dbapi2.connect(
host='localhost',
port=4001,
)
try:
with connection.cursor() as cursor:
cursor.execute('CREATE TABLE foo (id integer not null primary key, name text)')
cursor.executemany('INSERT INTO foo(name) VALUES(?)', seq_of_parameters=(('a',), ('b',)))
with connection.cursor() as cursor:
# Read a single record with qmark parameter style
sql = "SELECT `id`, `name` FROM `foo` WHERE `name`=?"
cursor.execute(sql, ('a',))
result = cursor.fetchone()
print(result)
# Read a single record with named parameter style
sql = "SELECT `id`, `name` FROM `foo` WHERE `name`=:name"
cursor.execute(sql, {'name': 'b'})
result = cursor.fetchone()
print(result)
finally:
connection.close()
.. code:: python
This example will print:
(1, 'a')
(2, 'b')
Paramstyle
-------------
Only qmark and named paramstyles (as defined in PEP 249) are supported.
Limitations
-------------
Transactions are not supported.
Resources
-------------
DB-API 2.0: http://www.python.org/dev/peps/pep-0249
License
-------------
pyrqlite is released under the MIT License. See LICENSE for more information.