Metadata-Version: 2.5
Name: fsspec-db
Version: 0.4.0
Summary: Database handling for fsspec filesystems
Project-URL: Repository, https://github.com/1kbgz/fsspec-db
Project-URL: Homepage, https://github.com/1kbgz/fsspec-db
Author-email: the fsspec-db authors <dev@1kbgz.com>
License: Apache-2.0
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Programming Language :: Rust
Requires-Python: >=3.11
Requires-Dist: fsspec
Requires-Dist: fsspec-rs<0.3,>=0.2.1
Requires-Dist: pyarrow
Provides-Extra: develop
Requires-Dist: build; extra == 'develop'
Requires-Dist: bump-my-version; extra == 'develop'
Requires-Dist: check-dist; extra == 'develop'
Requires-Dist: cibuildwheel; extra == 'develop'
Requires-Dist: codespell; extra == 'develop'
Requires-Dist: hatch-rs; extra == 'develop'
Requires-Dist: hatchling; extra == 'develop'
Requires-Dist: mdformat; extra == 'develop'
Requires-Dist: mdformat-myst; extra == 'develop'
Requires-Dist: mdformat-tables>=1; extra == 'develop'
Requires-Dist: pytest; extra == 'develop'
Requires-Dist: pytest-cov; extra == 'develop'
Requires-Dist: ruff; extra == 'develop'
Requires-Dist: twine; extra == 'develop'
Requires-Dist: ty; extra == 'develop'
Requires-Dist: uv; extra == 'develop'
Requires-Dist: wheel; extra == 'develop'
Requires-Dist: yardang; extra == 'develop'
Provides-Extra: docs
Requires-Dist: yardang; extra == 'docs'
Provides-Extra: duckdb
Requires-Dist: duckdb>=1.4; extra == 'duckdb'
Provides-Extra: integration
Requires-Dist: duckdb>=1.4; extra == 'integration'
Requires-Dist: pandas; extra == 'integration'
Requires-Dist: psycopg[binary]; extra == 'integration'
Requires-Dist: pymysql; extra == 'integration'
Requires-Dist: sqlalchemy>=2; extra == 'integration'
Provides-Extra: odbc
Requires-Dist: arrow-odbc>=9; extra == 'odbc'
Description-Content-Type: text/markdown

# fsspec-db

Browse SQL metadata and transfer table data through fsspec.

[![Build Status](https://github.com/1kbgz/fsspec-db/actions/workflows/build.yaml/badge.svg?branch=main&event=push)](https://github.com/1kbgz/fsspec-db/actions/workflows/build.yaml)
[![codecov](https://codecov.io/gh/1kbgz/fsspec-db/branch/main/graph/badge.svg)](https://codecov.io/gh/1kbgz/fsspec-db)
[![License](https://img.shields.io/github/license/1kbgz/fsspec-db)](https://github.com/1kbgz/fsspec-db)
[![PyPI](https://img.shields.io/pypi/v/fsspec-db.svg)](https://pypi.python.org/pypi/fsspec-db)

`fsspec-db` maps schemas, tables, views, and their metadata to filesystem paths.
Relation extensions select Arrow IPC, Parquet, CSV, or JSONL; SQL queries return
PyArrow tables. Native backends support SQLite, PostgreSQL, and MySQL. Python
adapters support DuckDB, SQLAlchemy, and ODBC.

## Start here

[Browse a SQLite database](docs/src/tutorial.md) creates a database and reads it
through metadata paths, SQL, and Parquet.

## How-to guides

[Read and write SQLite data](docs/src/sqlite.md),
[connect PostgreSQL or MySQL](docs/src/sql-backends.md), or
[connect Python database adapters](docs/src/adapter-backends.md).
[Manage tables and metadata caches](docs/src/how-to-manage.md) covers opt-in DDL,
refreshing introspection, and deferred writes.
[Store keyed records](docs/src/records.md) uses tables with a primary key as
`fsspec.get_mapper` stores.

## Reference and explanation

Consult [Paths and metadata](docs/src/paths.md),
[backend configuration and types](docs/src/backends.md),
[Python backend contracts](docs/src/python-backends.md), and the
[Python API](docs/src/api.md) for exact behavior.
Read [Why database objects have filesystem paths](docs/src/concepts.md) for the
mapping and its limits.

Database overwrite writes replace table contents. Use `"ab"` or `mode="append"`
to preserve existing rows.
