Skip to content

Commit

Permalink
docs(sessions): add note about pg extra (#5620)
Browse files Browse the repository at this point in the history
* docs(sessions): add note about pg extra

* add note
  • Loading branch information
mikeldking authored and RogerHYang committed Dec 9, 2024
1 parent 7f03551 commit 5da08f2
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@

This assumes the database up migration has been applied by the Phoenix application, i.e. the new table for sessions has been created. See Option II for how to manually apply the up migration.

> [!NOTE]
> If you are using a PostgreSQL database, you will have to have the postgres extras installed via `pip install arize-phoenix[pg]`.
```shell
python -m phoenix.db.migrations.data_migration_scripts.populate_project_sessions
```
Expand Down Expand Up @@ -41,14 +44,16 @@ python migrations/data_migration_scripts/populate_project_sessions.py
#### Environment Variables Used by the Script

SQLite example

```shell
export PHOENIX_SQL_DATABASE_URL=sqlite:////phoenix.db
```

PostgreSQL example

```shell
export PHOENIX_SQL_DATABASE_URL=postgresql://localhost:5432/postgres?username=postgres&password=postgres
````
```

Optionally for PostgreSQL, you can set the schema via the environment variable `PHOENIX_SQL_DATABASE_SCHEMA`.

Expand Down

0 comments on commit 5da08f2

Please sign in to comment.