1. 5-Minute Quickstart

Quickstart in five minutes

This page is the shortest runnable path through RelPyDB. It creates a relational object, defines schema, inserts one row with insert, adds more rows with insert_many, queries rows, and saves the object to disk.

1. Install from GitHub.
2. Create a database object.
3. Create typed tables.
4. Insert dictionaries as rows with insert or insert_many.
5. Query with col and terminal methods.
6. Save and load the object.

Install from GitHub

python -m pip install git+https://github.com/mandelreouven2002/RelPyDB.git

For now, GitHub is the only supported installation method.

Complete first script

from relpy import RelPy, AutoNumber, col

# 1. Create an empty relational object.
db = RelPy()

# 2. Define a users table.
db.create_table("users")
db.add_column("users", "id", AutoNumber, is_primary_key=True)
db.add_column("users", "name", str, nullable=False)
db.add_column("users", "status", str, nullable=False, default="active")

# 3. Insert one row.
db.insert("users", {"name": "Alice"})

# 4. Insert many rows efficiently.
db.insert_many("users", [
    {"name": "Bob", "status": "inactive"},
    {"name": "Carol"},
    {"name": "Dana"},
])

# 5. Query rows.
active_users = (
    db.query("users")
      .where(col("status") == "active")
      .select("id", "name")
      .to_list()
)

print(active_users)

# 6. Save the relational object.
db.save("quickstart.relpy.json")

# 7. Load it again.
loaded_db = RelPy.load("quickstart.relpy.json")
print(loaded_db.to_list("users"))

[{"id": 1, "name": "Alice"}, {"id": 3, "name": "Carol"}, {"id": 4, "name": "Dana"}]
[{"id": 1, "name": "Alice", "status": "active"}, {"id": 2, "name": "Bob", "status": "inactive"}, {"id": 3, "name": "Carol", "status": "active"}, {"id": 4, "name": "Dana", "status": "active"}]

Why insert_many matters

Use insert when you add a single row. Use insert_many when you already have a list of dictionaries, such as JSON data, CSV rows, generated test data, or API results.

users_from_api = [
    {"name": "Alice"},
    {"name": "Bob"},
    {"name": "Carol"},
]

db.insert_many("users", users_from_api)

What each line means