Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: explain different connection string formats in the docstring #1132

Merged
merged 9 commits into from
Oct 15, 2024
Merged

docs: explain different connection string formats in the docstring #1132

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9c164c5
feat: specify individual connection parameters
kanenorman Oct 10, 2024
29ebc1d
style: fix excessive line length
kanenorman Oct 11, 2024
967e269
test: correct env variables
kanenorman Oct 11, 2024
73e123c
docs: update PgvectorDocumentStore docstring
kanenorman Oct 11, 2024
713e3a8
style: reorder parameters
kanenorman Oct 11, 2024
dc4028c
style: reorder parameters
kanenorman Oct 11, 2024
8bbdbfd
Merge branch 'main' into postgres-connection-params
davidsbatista Oct 14, 2024
3ff1b01
revert: remove individual connection params
kanenorman Oct 14, 2024
1ca9004
docs: update postgres connection string docs
kanenorman Oct 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion integrations/pgvector/src/haystack_integrations/document_stores/pgvector/document_store.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,11 @@ def __init__(
A specific table to store Haystack documents will be created if it doesn't exist yet.

:param connection_string: The connection string to use to connect to the PostgreSQL database, defined as an
environment variable, e.g.: `PG_CONN_STR="postgresql://USER:PASSWORD@HOST:PORT/DB_NAME"`
environment variable. It can be provided in either URI format
e.g.: `PG_CONN_STR="postgresql://USER:PASSWORD@HOST:PORT/DB_NAME"`, or keyword/value format
e.g.: `PG_CONN_STR="host=HOST port=PORT dbname=DBNAME user=USER password=PASSWORD"`
See [PostgreSQL Documentation](https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING)
for more details.
:param table_name: The name of the table to use to store Haystack documents.
:param language: The language to be used to parse query and document content in keyword retrieval.
To see the list of available languages, you can run the following SQL query in your PostgreSQL database:
Expand Down