Documentation
Documentation Overview
Learn RelPyDB from guided onboarding to full API reference.
Choose a learning path
New users should start with Start Here, then run the 5-Minute Quickstart. The reference pages are useful after you understand the basic flow.
0. Start Here
The recommended entry point for new developers.
1. 5-Minute Quickstart
First table, insert, insert_many, query, save and load.
2. Full Tutorial
Build a small relational app with users, orders and support tickets.
3. Common Recipes
Copyable patterns for common tasks.
4. Why RelPyDB?
Understand the motivation behind the library.
5. RelPyDB vs Alternatives
Compare with dict/list, pandas, SQLite, DuckDB and SQLAlchemy.
6. Concepts
Tables, rows, schema, constraints and the query builder.
7. Tables and Schema
create_table, add_column, keys and constraints.
8. Data Operations
insert, insert_many, update and delete.
9. Querying
where, select, order_by, limit, offset and terminal methods.
10. Joins
Inner, left, right, full, cross and natural joins.
11. Grouping
group_by, aggregate and having.
12. Views
Named virtual query views.
13. Indexes
Single-column, composite, unique and encrypted indexes.
14. Exports
to_list, to_json, to_pandas, to_numpy, to_sql and print_table.
15. Persistence
save and load .relpy.json files.
16. Encryption
Encrypted columns and blind indexes.
17. Python Integration
Loops, functions, JSON, pandas, NumPy and tests.
18. Full Capability Checklist
Complete map of what RelPyDB can do.
19. Common Errors and Limitations
Expected failures and current alpha limits.
20. API Reference
Public API signatures and details.
21. Function Reference
Inputs, outputs, imports, examples and usage notes.
22. Examples
Ready-to-run scripts.
Recommended order for new users
- Start Here
- 5-Minute Quickstart
- Full Tutorial
- Common Recipes
- Tables and Schema
- Data Operations, especially
insert_many - Querying
- Joins and Grouping
- Exports and Persistence
- Encryption
- Function Reference