Skip to content

Commit 00727bf

Browse files
authored
Merge pull request #3 from nachoalonsoportillo/patch2
Several changes
2 parents 91813c9 + 390d135 commit 00727bf

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ urlFragment: azure-postgres-pgvector-python
1414

1515
# PostgreSQL + pgvector on Azure
1616

17-
This repository makes it easy to deploy a PostgreSQL Flexible Server to Azure with the [pgvector](https://pgvector.dev) extension installed. The pgvector extension provides a vector similarity search engine for PostgreSQL, allowing you to perform similarity searches on your data using vector embeddings.
17+
This repository makes it easy to deploy a PostgreSQL Flexible Server to Azure with the [pgvector](https://github.com/pgvector/pgvector) extension installed. The pgvector extension provides a vector similarity search engine for PostgreSQL, allowing you to perform similarity searches on your data using vector embeddings.
1818

19-
The repository contains infrastructure-as-code (Bicep) to deploy an Azure PostgreSQL Flexible Server with pgvector extension enabled, password authentication disabled, and Entra (Active Directory) authentication enabled. The repository also contains example Python scripts to demonstrate how to use pgvector.
19+
The repository contains infrastructure-as-code (Bicep) to deploy an Azure PostgreSQL Flexible Server with pgvector extension enabled, password authentication disabled, and Entra (Active Directory) authentication enabled. The repository also contains example Python scripts to demonstrate how to use pgvector.
2020

2121
Table of contents:
2222

@@ -30,8 +30,7 @@ Table of contents:
3030
## Opening this project
3131

3232
You have a few options for setting up this project.
33-
The easiest way to get started is GitHub Codespaces, since it will setup all the tools for you,
34-
but you can also [set it up locally](#local-environment) if desired.
33+
The easiest way to get started is GitHub Codespaces, since it will setup all the tools for you, but you can also [set it up locally](#local-environment) if desired.
3534

3635
### GitHub Codespaces
3736

@@ -45,9 +44,9 @@ Once the codespace opens (this may take several minutes), open a terminal window
4544

4645
A related option is VS Code Dev Containers, which will open the project in your local VS Code using the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers):
4746

48-
1. Start Docker Desktop (install it if not already installed)
47+
1. Start Docker Desktop (install it if not already installed).
4948
1. Open the project:
50-
[![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure-samples/azure-postgres-pgvector-python)
49+
[![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure-samples/azure-postgres-pgvector-python).
5150
1. In the VS Code window that opens, once the project files show up (this may take several minutes), open a terminal window.
5251

5352
### Local environment
@@ -101,7 +100,7 @@ Follow these steps to deploy a PostgreSQL Flexible Server to Azure with the pgve
101100

102101
This will create a new resource group, and create the PostgreSQL Flexible server inside that group.
103102

104-
1. Once the deployment is complete, run this command to copy the `azd` environment variables into your local `.env`:
103+
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`:
105104

106105
```shell
107106
azd env get-values > .env
@@ -113,11 +112,11 @@ Follow these steps to deploy a PostgreSQL Flexible Server to Azure with the pgve
113112
python examples/sqlalchemy_async.py
114113
```
115114

116-
Note that each of the script starts off with a `CREATE EXTENSION vector;` command, which will install the pgvector extension into the database. Once you run that once, you do not need to run it again.
115+
Note that each of the script starts off with a `CREATE EXTENSION vector;` command, which will install the pgvector extension into the database. Once you run that once in a given database, you do not need to run it again for that particular database.
117116

118117
## Example scripts
119118

120-
The `examples` folder contains example Python scripts that demonstrate how to use pgvector,based on the [pgvector sample code](https://github.com/pgvector/pgvector-python).
119+
The `examples` folder contains example Python scripts that demonstrate how to use pgvector, based on the [pgvector sample code](https://github.com/pgvector/pgvector-python).
121120

122121
| Script | Dependencies | Description |
123122
|--------|--------------|-------------|

0 commit comments

Comments
 (0)