Merge branch 'main' into dependabot/pip/sqlmodel-0.0.22

Author: pamelafox

.env.azure

@@ -1,4 +1,5 @@
-# Use these values to connect to the Azure database from within the devcontainer
+# Set these values to connect to the Azure database
+# Use write_azure_env.sh or write_azure_env.ps1 to set these values
 POSTGRES_DATABASE="db"
 POSTGRES_HOST="YOUR-SERVER-NAME.postgres.database.azure.com"
 POSTGRES_SSL="require"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Azure Samples
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -100,10 +100,10 @@ Follow these steps to deploy a PostgreSQL Flexible Server to Azure with the pgve
 
     This will create a new resource group, and create the PostgreSQL Flexible server inside that group.
 
-1. The example Python scripts look for configuration variables from a `.env` file located in the directory from where you invoke the scripts. You can easily create a file with the correct variables for your PostgreSQL server by running this command that copies the `azd` environment variables into your local `.env`:
+1. The example Python scripts look for configuration variables from a `.env` file located in the directory from where you invoke the scripts. You can easily create a file with the correct variables for your PostgreSQL server by running this script that copies the necessary `azd` environment variables into your local `.env`:
 
     ```shell
-    azd env get-values > .env
+    ./write_azure_env.sh
     ```
 
 1. Now you may run the Python scripts in order to interact with the PostgreSQL server.

examples/asyncpg_items.py

@@ -23,6 +23,9 @@ async def async_main():
         POSTGRES_PASSWORD = os.environ["POSTGRES_PASSWORD"]
 
     DATABASE_URI = f"postgresql://{POSTGRES_USERNAME}:{POSTGRES_PASSWORD}@{POSTGRES_HOST}/{POSTGRES_DATABASE}"
+    # Specify SSL mode if needed
+    if POSTGRES_SSL := os.environ.get("POSTGRES_SSL"):
+        DATABASE_URI += f"?sslmode={POSTGRES_SSL}"
 
     conn = await asyncpg.connect(DATABASE_URI)
 

examples/sqlalchemy_async.py

@@ -21,6 +21,7 @@ class Item(Base):
     id: Mapped[int] = mapped_column(primary_key=True)
     embedding = mapped_column(Vector(3))
 
+
 # Define HNSW index to support vector similarity search through the vector_l2_ops access method (Euclidean distance). The SQL operator for Euclidean distance is written as <->.
 index = Index(
     "hnsw_index_for_euclidean_distance_similarity_search",
@@ -30,6 +31,7 @@ class Item(Base):
     postgresql_ops={"embedding": "vector_l2_ops"},
 )
 
+
 async def insert_objects(async_session: async_sessionmaker[AsyncSession]) -> None:
     async with async_session() as session:
         async with session.begin():

examples/sqlalchemy_items.py

@@ -17,6 +17,7 @@ class Item(Base):
     id: Mapped[int] = mapped_column(primary_key=True)
     embedding = mapped_column(Vector(3))
 
+
 # Define HNSW index to support vector similarity search through the vector_l2_ops access method (Euclidean distance). The SQL operator for Euclidean distance is written as <->.
 index = Index(
     "hnsw_index_for_euclidean_distance_similarity_search",

examples/sqlalchemy_movies.py

@@ -20,6 +20,7 @@ class Movie(Base):
     title: Mapped[str] = mapped_column()
     title_vector = mapped_column(Vector(1536))  # ada-002 is 1536-dimensional
 
+
 # Define HNSW index to support vector similarity search through the vector_cosine_ops access method (cosine distance). The SQL operator for cosine distance is written as <=>.
 index = Index(
     "hnsw_index_for_cosine_distance_similarity_search",
@@ -81,9 +82,8 @@ class Movie(Base):
 
     # Find the 5 most similar movies to "Winnie the Pooh"
     most_similars = session.scalars(
-        select(Movie).order_by(
-            Movie.title_vector.cosine_distance(target_movie.title_vector)
-        ).limit(5))
+        select(Movie).order_by(Movie.title_vector.cosine_distance(target_movie.title_vector)).limit(5)
+    )
     print(f"Five most similar movies to '{target_movie.title}':")
     for movie in most_similars:
         print(f"\t{movie.title}")

requirements.txt

@@ -1,7 +1,7 @@
-psycopg2==2.9.9
+psycopg2==2.9.10
 python-dotenv==1.0.1
-SQLAlchemy[asyncio]==2.0.31
-pgvector==0.3.0
+SQLAlchemy[asyncio]==2.0.37
+pgvector==0.3.5
 SQLModel==0.0.22
-asyncpg==0.29.0
+asyncpg==0.30.0
 azure-identity

write_azure_env.ps1

@@ -0,0 +1,13 @@
+# Clear the contents of the .env file
+Set-Content -Path .env -Value ""
+
+# Append new values to the .env file
+$postgresDatabase = azd env get-value POSTGRES_DATABASE
+$postgresHost = azd env get-value POSTGRES_HOST
+$postgresSSL = azd env get-value POSTGRES_SSL
+$postgresUsername = azd env get-value POSTGRES_USERNAME
+
+Add-Content -Path .env -Value "POSTGRES_DATABASE=$postgresDatabase"
+Add-Content -Path .env -Value "POSTGRES_HOST=$postgresHost"
+Add-Content -Path .env -Value "POSTGRES_SSL=$postgresSSL"
+Add-Content -Path .env -Value "POSTGRES_USERNAME=$postgresUsername"

write_azure_env.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Clear the contents of the .env file
+> .env
+
+# Append new values to the .env file
+echo "POSTGRES_DATABASE=$(azd env get-value POSTGRES_DATABASE)" >> .env
+echo "POSTGRES_HOST=$(azd env get-value POSTGRES_HOST)" >> .env
+echo "POSTGRES_SSL=$(azd env get-value POSTGRES_SSL)" >> .env
+echo "POSTGRES_USERNAME=$(azd env get-value POSTGRES_USERNAME)" >> .env