SQLite7

SQLite7 is a DB-API 2.0 style interface for SQLite databases backed directly by the SQLite C library, with both synchronous and asynchronous APIs.

This documentation is organized into four main sections:

• Tutorial teaches the core workflow for opening a database, creating tables, inserting data, and querying rows.

• Reference describes the classes, functions, constants, and exceptions provided by sqlite7.

• How-to guides show how to perform focused tasks such as binding placeholders, working with row factories, and using transactions.

• Explanation provides background on the native backend design and transaction behavior.

Tutorial

• Tutorial
  • Open a database
  • Create a table
  • Insert rows
  • Query rows
  • Use table helpers
  • Work with transactions
  • Close the database
  • Async example

Reference

• Module reference
  • Module functions
  • Module constants
  • Main classes
• Top-level helpers
  • open_db(path, **kwargs) / connect(path, **kwargs)
  • open_async(path, **kwargs) / connect_async(path, **kwargs)
• Database
  • Constructor
  • Query helpers
  • Example
• Table
  • Table.select(columns=None, where=None, params=None, group_by=None, having=None, order_by=None, limit=None, offset=None, distinct=False)
  • Table.all(...)
  • Table.get(where, params=None, columns=None, group_by=None, having=None, order_by=None, offset=None, distinct=False)
  • Table.insert(values, on_conflict='abort')
  • Table.insert_many(rows, on_conflict='abort', chunk_size=500)
  • Table.update(values, where, params=None, order_by=None, limit=None)
  • Table.delete(where, params=None, order_by=None, limit=None)
  • Table.upsert(values, conflict_columns, update_columns=None)
  • Table.count(where=None, params=None)
  • Table.exists(where=None, params=None)
  • Table.execute(sql, params=None)
  • Table.executemany(sql, seq_of_params)
  • Table.fetch_all(sql, params=None)
  • Table.fetch_one(sql, params=None)
  • Table.fetch_value(sql, params=None, default=None)
  • Table.transaction()
• Result Types
  • StatementResult
  • RowDict
• Exceptions
  • Base exceptions
  • SQLite-like subclasses
  • sqlite7-specific subclasses
  • Example
• SQLite Compatibility Exports
  • Example
• Conflict Policies
  • Example

How-to guides

• How to use placeholders to bind values in SQL queries
• How to create and use row factories
• How to use transactions

Explanation

• Transaction control
• How sqlite7 Works
• Features
• Best Practices
• Installation
• License