sqbooster Documentation

sqbooster is a flexible Python library for database access with real typed tables, easy querying, and easy backend switching.

User Guide

• Getting Started
  • Installation
  • Quick Example
  • Concepts
  • Context Manager
• Tables
  • Creating Tables
  • Column Types
  • Column Constraints
  • Inserting Data
  • Updating Data
  • Deleting Data
  • Table Management
  • Raw SQL (SQLite/PostgreSQL only)
• Querying
  • Basic Queries
  • Filter Operators
  • Examples
  • Ordering
  • Selecting Columns
  • Pagination
  • Chaining
• Backends
  • SQLite (zero config)
  • PostgreSQL
  • JSON File
  • Pickle File
  • Redis
  • MongoDB
  • Backend Comparison
  • Switching Backends
  • Context Manager
• SimpleClient
  • Quick Start
  • Convenience Constructors
  • Type Mapping
  • Full API
• Serialization
  • Backend-level Serialization
  • Column-level Serialization
  • Migration Tips
• Key-Value API
  • Basic Operations
  • Auto-Commit
  • Pickle Mode
  • File-based Backends
  • KV + Tables Together

Examples

• Blog Engine Example
  • Full Source
  • What It Demonstrates
  • Running the Example
• Inventory System Example
  • Full Source
  • What It Demonstrates
• Cache System Example
  • Full Source
  • What It Demonstrates
• Backend Migration Example
  • Full Source
  • What It Demonstrates
• SimpleClient Blog
  • Full Source
  • What It Demonstrates
  • Running the Example
• SimpleClient Todo App
  • Full Source
  • What It Demonstrates
  • Running the Example
• SimpleClient Backend Switch
  • Full Source
  • What It Demonstrates
  • Running the Example
• SimpleClient Key-Value + Tables
  • Full Source
  • What It Demonstrates
  • Running the Example

API Reference

• sqbooster Package
  • sqlite()
  • postgresql()
  • json()
  • pickle()
  • redis()
  • mongo()
• Types
  • ColumnType
  • Integer
  • Text
  • Float
  • Boolean
  • Blob
  • Timestamp
  • Real
  • VARCHAR
  • JSON
  • Pickle
• Schema
  • Column
  • TableSchema
• Query
  • Query
  • InMemoryQuery
• SimpleClient
  • SimpleClient
• Backends
  • DatabaseBackend (ABC)
  • SQLiteBackend
  • PostgreSQLBackend
  • JSONFileDatabase
  • PickleFileDatabase
  • RedisDatabase
  • MongoDatabase

Project

• Changelog
• Contributing

Indices and tables

• Index

• Module Index

• Search Page