litepolis-database-default 0.0.1

The default database module for LitePolis that compatible with Polis

LitePolis Database Default

This is the default database module that compatible with Polis.

Quick Start

1. Install the module:

litepolis-cli add-deps litepolis-database-default

2. Configure database connection:

# ~/.litepolis/litepolis.config
[litepolis_database_default]
database_url: "postgresql://user:pass@localhost:5432/litepolis"
# database_url: "starrocks://<User>:<Password>@<Host>:<Port>/<Catalog>.<Database>"

3. Basic usage:

from litepolis_database_default import DatabaseActor

user = DatabaseActor.create_user({
    "email": "[e-mail]",
    "auth_token": "auth_token",
})

conv = DatabaseActor.create_conversation({
    "title": "Test Conversation",
    "description": "This is a test conversation."
})

Data Schema

Users (users)

CREATE TABLE users (
    id SERIAL PRIMARY KEY,
    email VARCHAR(255) UNIQUE NOT NULL,
    auth_token TEXT NOT NULL,
    is_admin BOOLEAN DEFAULT false,
    created TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
    modified TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
);

Conversations (conversations)

CREATE TABLE conversations (
    id SERIAL PRIMARY KEY,
    title TEXT NOT NULL,
    description TEXT,
    is_archived BOOLEAN DEFAULT false,
    created TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP,
    modified TIMESTAMP WITH TIME ZONE DEFAULT CURRENT_TIMESTAMP
);

License

MIT Licensed. See LICENSE for details.