Skip to content

chore(docs): Highlight how to use Private IP in Engine class. #82

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

Merged
averikitsch merged 5 commits into from
Feb 20, 2025
Merged

chore(docs): Highlight how to use Private IP in Engine class. #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
27d8fba
chore(docs): Highlight how to use Private IP in Engine class.
dishaprakash Feb 20, 2025
b75465c
Update llama_index_doc_store.ipynb
dishaprakash Feb 20, 2025
beecfcf
Update llama_index_reader.ipynb
dishaprakash Feb 20, 2025
8a6b09b
Update llama_index_vector_store.ipynb
dishaprakash Feb 20, 2025
4641480
Update llama_index_quick_start.ipynb
dishaprakash Feb 20, 2025
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
5 changes: 4 additions & 1 deletion samples/llama_index_chat_store.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,9 @@
"Optionally, [built-in database authentication](https://cloud.google.com/sql/docs/postgres/built-in-authentication) using a username and password to access the Cloud SQL database can also be used. Just provide the optional `user` and `password` arguments to `PostgresEngine.from_instance()`:\n",
"\n",
"* `user` : Database user to use for built-in database authentication and login\n",
"* `password` : Database password to use for built-in database authentication and login.\n"
"* `password` : Database password to use for built-in database authentication and login.\n",
"\n",
"To connect to your Cloud SQL instance from this notebook, you will need to enable public IP on your instance. Alternatively, you can follow [these instructions](https://cloud.google.com/sql/docs/postgres/connect-to-instance-from-outside-vpc) to connect to an Cloud SQL for PostgreSQL instance with Private IP from outside your VPC. Learn more about [specifying IP types](https://github.com/GoogleCloudPlatform/cloud-sql-python-connector?tab=readme-ov-file#specifying-ip-address-type).\n"
]
},
{
Expand All @@ -197,6 +199,7 @@
" database=DATABASE,\n",
" user=USER,\n",
" password=PASSWORD,\n",
" ip_type=\"public\",\n",
")"
]
},
Expand Down
5 changes: 4 additions & 1 deletion samples/llama_index_doc_store.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,9 @@
"Optionally, [built-in database authentication](https://cloud.google.com/sql/docs/postgres/built-in-authentication) using a username and password to access the Cloud SQL database can also be used. Just provide the optional `user` and `password` arguments to `PostgresEngine.from_instance()`:\n",
"\n",
"* `user` : Database user to use for built-in database authentication and login\n",
"* `password` : Database password to use for built-in database authentication and login.\n"
"* `password` : Database password to use for built-in database authentication and login.\n",
"\n",
"To connect to your Cloud SQL instance from this notebook, you will need to enable public IP on your instance. Alternatively, you can follow [these instructions](https://cloud.google.com/sql/docs/postgres/connect-to-instance-from-outside-vpc) to connect to an Cloud SQL for PostgreSQL instance with Private IP from outside your VPC. Learn more about [specifying IP types](https://github.com/GoogleCloudPlatform/cloud-sql-python-connector?tab=readme-ov-file#specifying-ip-address-type).\n"
]
},
{
Expand Down Expand Up @@ -230,6 +232,7 @@
" database=DATABASE,\n",
" user=USER,\n",
" password=PASSWORD,\n",
" ip_type=\"public\",\n",
")"
]
},
Expand Down
6 changes: 5 additions & 1 deletion samples/llama_index_quick_start.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,10 @@
"id": "-CQgPON8dwSK"
},
"source": [
"First, create a connection to your Cloud SQL for PostgreSQL instance using the `PostgresEngine` class."
"First, create a connection to your Cloud SQL for PostgreSQL instance using the `PostgresEngine` class.",
"\n",
"\n",
"To connect to your Cloud SQL instance from this notebook, you will need to enable public IP on your instance. Alternatively, you can follow [these instructions](https://cloud.google.com/sql/docs/postgres/connect-to-instance-from-outside-vpc) to connect to an Cloud SQL for PostgreSQL instance with Private IP from outside your VPC. Learn more about [specifying IP types](https://github.com/GoogleCloudPlatform/cloud-sql-python-connector?tab=readme-ov-file#specifying-ip-address-type).\n"
]
},
{
Expand All @@ -589,6 +592,7 @@
" database=database_name,\n",
" user=user,\n",
" password=password,\n",
" ip_type=\"public\",\n",
")"
]
},
Expand Down
5 changes: 4 additions & 1 deletion samples/llama_index_reader.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,9 @@
"Optionally, [built-in database authentication](https://cloud.google.com/sql/docs/postgres/built-in-authentication) using a username and password to access the Cloud SQL database can also be used. Just provide the optional `user` and `password` arguments to `PostgresEngine.from_instance()`:\n",
"\n",
"* `user` : Database user to use for built-in database authentication and login\n",
"* `password` : Database password to use for built-in database authentication and login.\n"
"* `password` : Database password to use for built-in database authentication and login.\n",
"\n",
"To connect to your Cloud SQL instance from this notebook, you will need to enable public IP on your instance. Alternatively, you can follow [these instructions](https://cloud.google.com/sql/docs/postgres/connect-to-instance-from-outside-vpc) to connect to an Cloud SQL for PostgreSQL instance with Private IP from outside your VPC. Learn more about [specifying IP types](https://github.com/GoogleCloudPlatform/cloud-sql-python-connector?tab=readme-ov-file#specifying-ip-address-type).\n"
]
},
{
Expand All @@ -188,6 +190,7 @@
" database=DATABASE,\n",
" user=USER,\n",
" password=PASSWORD,\n",
" ip_type=\"public\",\n",
")"
]
},
Expand Down
5 changes: 4 additions & 1 deletion samples/llama_index_vector_store.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,9 @@
"Optionally, [built-in database authentication](https://cloud.google.com/sql/docs/postgres/built-in-authentication) using a username and password to access the Cloud SQL database can also be used. Just provide the optional `user` and `password` arguments to `PostgresEngine.from_instance()`:\n",
"\n",
"* `user` : Database user to use for built-in database authentication and login\n",
"* `password` : Database password to use for built-in database authentication and login.\n"
"* `password` : Database password to use for built-in database authentication and login.\n",
"\n",
"To connect to your Cloud SQL instance from this notebook, you will need to enable public IP on your instance. Alternatively, you can follow [these instructions](https://cloud.google.com/sql/docs/postgres/connect-to-instance-from-outside-vpc) to connect to an Cloud SQL for PostgreSQL instance with Private IP from outside your VPC. Learn more about [specifying IP types](https://github.com/GoogleCloudPlatform/cloud-sql-python-connector?tab=readme-ov-file#specifying-ip-address-type).\n"
]
},
{
Expand Down Expand Up @@ -230,6 +232,7 @@
" database=DATABASE,\n",
" user=USER,\n",
" password=PASSWORD,\n",
" ip_type=\"public\",\n",
")"
]
},
Expand Down