APSW 3.51.3.0 documentation

APSW 3.51.3.0 released 13 March 2026

• About
  • What APSW does
  • Dependencies
  • Hosting
  • Mailing lists/contacts
  • Issue tracking
  • Backwards compatibility
  • APSW and SQLite versions
  • Python versions
• Tips
  • SQLite is different
  • Types
  • Runtime Python objects
  • Transactions
  • Queries
  • Bindings
  • Query Patterns
  • Diagnostics
  • Managing and updating your schema
  • Parsing SQL
  • Busy handling
  • Database schema
  • Write Ahead Logging
  • Customizing Connections
  • Customizing Cursors
  • URI names
  • Memory databases
• Example/Tour
  • Checking APSW and SQLite versions
  • Best Practice
  • Logging
  • Opening the database
  • Executing SQL
  • Why you use bindings to provide values
  • Bindings (sequence)
  • Bindings (dict)
  • Transactions
  • executemany
  • Pragmas
  • Tracing execution
  • Tracing returned rows
  • Defining scalar functions
  • Defining aggregate functions
  • Defining window functions
  • Defining collations (sorting)
  • Accessing results by column name
  • Type conversion into/out of database
  • Runtime Python objects
  • Query limiting
  • Query details
  • Blob I/O
  • Backup an open database
  • Authorizer (control what SQL can do)
  • Progress handler
  • File Control
  • Commit hook
  • Update hook
  • Virtual tables
  • VFS - Virtual File System
  • Limits
  • Shell
  • Statistics
  • Tracing
  • System and SQLite resource usage in a block
  • SQL statement tracing in a block
  • Formatting query results table
  • Caching
  • The CARRAY extension
  • Cleanup
• Installation and customization
  • PyPI (recommended)
  • Linux/BSD provided
  • Source
  • Building and customization
  • Pyodide
  • Advice for packagers
  • Testing
• Extensions
  • CARRAY
  • Session
  • Math functions
  • Percentile (media)
  • FTS5
  • ICU
  • RTree
  • Geopoly
• Best Practice
  • Explanation
  • API
• APSW Module
  • Type Annotations
  • API Reference
  • SQLite constants
• Connections to a database
  • Connection class
  • PreUpdate class
• Cursors (executing SQL)
  • Cursor class
• Blob Input/Output
  • zeroblob class
  • Blob class
• Backup
  • Important details
  • Backup class
• JSON Example/Tour
  • Quick start
  • SQLite JSON functions
  • Customising conversion
  • Cleanup
• JSON (Javascript Object Notation)
  • What is JSON?
  • JSON5
  • Using JSON
  • JSONB
  • Notes
  • JSON as a SQLite value type
  • JSONB API
• Full Text Search Example/Tour
  • Is FTS5 available?
  • Content setup
  • Create/open search table
  • Table structure and statistics
  • Content
  • Searching with SQL.
  • Search method
  • Query correction and suggestion
  • Working with tokens
  • Key Tokens and More Like
  • Autocomplete
  • Auxiliary functions
  • Query parsing and manipulation
  • Tokenizers
  • apsw.fts5.UnicodeWordsTokenizer
  • apsw.fts5.SimplifyTokenizer
  • Your own tokenizer
  • Your own tokenizer, part 2
  • apsw.fts5.RegexTokenizer
  • apsw.fts5.RegexPreTokenizer
  • HTML tokenizer
  • JSON tokenizer
  • Synonym tokenizer
  • Stopwords tokenizer
  • Transform tokenizer
  • Cleanup
• Full text search
  • Key Concepts
  • Tokenizer order and parameters
  • Recommendations
  • Available tokenizers
  • Third party libraries
  • Available auxiliary functions
  • Command line tools
  • FTS5 module
  • FTS5 Query module
  • FTS5 Auxiliary functions module
  • FTS5Tokenizer class
  • FTS5ExtensionApi class
• Unicode Text Handling
  • unicode_version
  • category()
  • is_extended_pictographic()
  • is_regional_indicator()
  • casefold()
  • strip()
  • split_lines()
  • expand_tabs()
  • grapheme_length()
  • grapheme_substr()
  • grapheme_endswith()
  • grapheme_startswith()
  • grapheme_find()
  • text_width()
  • text_width_substr()
  • guess_paragraphs()
  • Justify
  • text_wrap()
  • codepoint_name()
  • version_added()
  • version_dates
  • grapheme_next_break()
  • grapheme_next()
  • grapheme_iter()
  • grapheme_iter_with_offsets()
  • grapheme_iter_with_offsets_filtered()
  • word_next_break()
  • word_default_categories
  • word_next()
  • word_iter()
  • word_iter_with_offsets()
  • sentence_next_break()
  • sentence_next()
  • sentence_iter()
  • sentence_iter_with_offsets()
  • line_break_next_break()
  • line_break_next()
  • line_break_iter()
  • line_break_iter_with_offsets()
• Session Example/Tour
  • Is Session available?
  • Initial database setup
  • Monitoring changes
  • SQL equivalent of a changeset
  • Patchsets and Changesets
  • Inverting - undo, redo
  • Applying changesets
  • Synchronising changes made by two users
  • ChangesetBuilder
  • Streaming
  • Rebasing
  • Table diff
  • Cleanup
• Session extension
  • Availability
  • Usage Overview
  • Extension configuration
  • Session class
  • TableChange class
  • Changeset class
  • ChangesetBuilder class
  • Rebaser class
• Virtual Tables
  • IndexInfo class
  • VTModule class
  • VTTable class
  • VTCursor class
• Virtual File System (VFS)
  • Exceptions and errors
  • VFSFcntlPragma class
  • VFS class
  • VFSFile class
  • URIFilename class
• Shell
  • Notes
  • Command Line Usage
  • Programmatic Usage
  • Commands
  • Shell class
• Various interesting and useful bits of functionality
  • Pretty printing
  • Logging and tracebacks
  • Virtual Tables
  • Query limiting, tracing and performance
  • Database storage usage
  • Accessing result rows by column name
  • Converting types into and out of SQLite
  • Detailed Query Information
  • API Reference
• Async Example/Tour
  • Basics
  • Functions and callbacks
  • Cancellation
  • Timeouts
  • Worker thread
  • Virtual tables
  • Tracing in a block
  • Resource usage in a block
  • Blob
  • Backup
  • Full Text Search
  • Session
• Concurrency & Async
  • How SQLite concurrency works
  • How Python concurrency works
  • How APSW works
  • Async usage
  • apsw.aio module
  • Async Performance
• Exceptions and Errors
  • Chaining
  • Unraisable
  • Exception Classes
• Execution and tracing
  • Execution model
  • Multi-threading
  • Re-entrancy
  • 64 bit
  • Statement Cache
  • Tracing
  • APSW Trace
• SQLite extra
  • vec1
  • Dependencies
  • Marking
  • Programs
  • Extensions
  • Command line
  • Shell
  • API
• DBAPI notes
  • Module Interface
  • Connection Objects
  • Cursor Objects
  • Type objects
  • Optional DB API Extensions
• sqlite3 module differences
  • What APSW does better
  • What sqlite3 does better
• Benchmarking
  • speedtest
• Copyright and License
• Change History
  • APSW changes by version
  • Renaming
• Module Index
• Index