Skip to main content

Python function to extract all the rows from a SQLite database file concurrently with iterating over its bytes, without needing random access to the file

Project description

stream-sqlite CircleCI Test Coverage

Python function to extract all the rows from a SQLite database file concurrently with iterating over its bytes, without needing random access to the file.

Note that the SQLite file format is not designed to be streamed; the data is arranged in pages of a fixed number of bytes, and the information to identify a page often comes after the page in the stream (sometimes a great deal after). Therefore, pages are buffered in memory until they can be identified.

Installation

pip install stream-sqlite

Usage

from stream_sqlite import stream_sqlite
import httpx

# Iterable that yields the bytes of a sqlite file
def sqlite_bytes():
    with httpx.stream('GET', 'http://www.parlgov.org/static/stable/2020/parlgov-stable.db') as r:
        yield from r.iter_bytes(chunk_size=65_536)

# If there is a single table in the file, there will be exactly one iteration of the outer loop.
# If there are multiple tables, each can appear multiple times.
for table_name, pragma_table_info, rows in stream_sqlite(sqlite_bytes(), max_buffer_size=1_048_576):
    for row in rows:
        print(row)

Recommendations

If you have control over the SQLite file, VACUUM; should be run on it before streaming. In addition to minimising the size of the file, VACUUM; arranges the pages in a way that often reduces the buffering required when streaming. This is especially true if it was the target of intermingled INSERTs and/or DELETEs over multiple tables.

Also, indexes are not used for extracting the rows while streaming. If streaming is the only use case of the SQLite file, and you have control over it, indexes should be removed, and VACUUM; then run.

Some tests suggest that if the file is written in autovacuum mode, i.e. PRAGMA auto_vacuum = FULL;, then the pages are arranged in a way that reduces the buffering required when streaming. Your mileage may vary.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stream-sqlite-0.0.35.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

stream_sqlite-0.0.35-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file stream-sqlite-0.0.35.tar.gz.

File metadata

  • Download URL: stream-sqlite-0.0.35.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for stream-sqlite-0.0.35.tar.gz
Algorithm Hash digest
SHA256 70119f3a26662222697ea5e7ffad5366b6ee653f29196faf5f7df3eb781f3636
MD5 cb88247d56f13ebe192ea3e4c2abf2dc
BLAKE2b-256 b9999506694d5b988351a719b8d869bc6a0f27a00642a20abc02ee88560b98ee

See more details on using hashes here.

File details

Details for the file stream_sqlite-0.0.35-py3-none-any.whl.

File metadata

  • Download URL: stream_sqlite-0.0.35-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for stream_sqlite-0.0.35-py3-none-any.whl
Algorithm Hash digest
SHA256 40203f597d56b2991652c61569bfafa23f4bbf02348212f5c8a987783e7c6fdc
MD5 fb5e9924a2bb1fb4299a389f5491702b
BLAKE2b-256 a1e33d94c2527474b79372de3f98d693658c9bdac8b21b0cb9674055dfb6bf21

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page