Skip to content

Commit a292041

Browse files
mikeldkingRogerHYang
authored andcommitted
docs(sessions): add note about pg extra (#5620)
* docs(sessions): add note about pg extra * add note
1 parent 2a250a4 commit a292041

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

MIGRATION.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
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.
1010

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

4346
SQLite example
47+
4448
```shell
4549
export PHOENIX_SQL_DATABASE_URL=sqlite:////phoenix.db
4650
```
4751

4852
PostgreSQL example
53+
4954
```shell
5055
export PHOENIX_SQL_DATABASE_URL=postgresql://localhost:5432/postgres?username=postgres&password=postgres
51-
````
56+
```
5257

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

0 commit comments

Comments
 (0)