Skip to main content

Python function to extract all the rows from a SQLite database, without loading the entire file into memory or disk

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. Typically used to extract rows while downloading, without loading the entire file to memory or disk.

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', 'https://www.example.com/my.sqlite') as r:
        yield from r.iter_bytes(chunk_size=65536)

# 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, table_info, rows in stream_sqlite(sqlite_bytes()):
    # Output of PRAGMA table_info
    print(table_info)

    for row in rows:
        print(row)

Limitations and recommendations

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 may come after the page in the stream. Therefore, pages are buffered in memory by the stream_sqlite function until they can be identified.

However, 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.

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.20.tar.gz (6.0 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.20-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: stream-sqlite-0.0.20.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.3

File hashes

Hashes for stream-sqlite-0.0.20.tar.gz
Algorithm Hash digest
SHA256 201efdf669f90339520f733c1aa2ef733e2f08c45f624cc1f4e922c1b5cc68be
MD5 257731aed2c5736dc77b3312d652237c
BLAKE2b-256 b17ffba9ed7c92d79e0ea4f06f3c380ea21b127a5c349e5a31119ea24788144f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: stream_sqlite-0.0.20-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.3

File hashes

Hashes for stream_sqlite-0.0.20-py3-none-any.whl
Algorithm Hash digest
SHA256 5bcc5db8da83fe7ebf69c1b24230d57b70d498b48ff79d50e862f5c2459335ad
MD5 bfc10ccb69fac97025359c4d2eb38606
BLAKE2b-256 f0ec4230f76991a87e1744073bd4ff54231765a2e2171301448ca55278ac00a7

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