You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-16Lines changed: 19 additions & 16 deletions
Original file line number
Diff line number
Diff line change
@@ -1,39 +1,42 @@
1
-
Timescale Vector
1
+
# pgvectorscale
2
2
3
3
A vector index for speeding up ANN search in `pgvector`.
4
4
5
-
🔧 Tools Setup
5
+
## 💾 Building and Installing pgvectorscale
6
6
7
-
Building the extension requires valid rust, rustfmt, and clang installs, along with the postgres headers for whichever version of postgres you are running, and pgx. We recommend installing rust using the official instructions:
7
+
### From source
8
+
9
+
#### Prerequisites
10
+
11
+
Building the extension requires valid rust, along with the postgres headers for whichever version of postgres you are running, and pgrx. We recommend installing rust using the official instructions:
8
12
```shell
9
13
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
10
14
```
11
-
and build tools, the postgres headers, in the preferred manner for your system. You may also need to install OpenSSL. For Ubuntu you can follow the postgres install instructions then run
15
+
16
+
You should install the appropriate build tools and postgres headers in the preferred manner for your system. You may also need to install OpenSSL. For Ubuntu you can follow the postgres install instructions then run
12
17
13
18
```shell
14
19
sudo apt-get install make gcc pkg-config clang postgresql-server-dev-16 libssl-dev
15
20
```
16
21
17
-
Next you need cargo-pgx, which can be installed with
22
+
Next you need cargo-pgrx, which can be installed with
18
23
```shell
19
24
cargo install --locked cargo-pgrx
20
25
```
21
26
22
-
You must reinstall cargo-pgx whenever you update your Rust compiler, since cargo-pgx needs to be built with the same compiler as Timescale Vector.
27
+
You must reinstall cargo-pgrx whenever you update your Rust compiler, since cargo-pgrx needs to be built with the same compiler as pgvectorscale.
23
28
24
-
Finally, setup the pgx development environment with
29
+
Finally, setup the pgrx development environment with
25
30
```shell
26
31
cargo pgrx init --pg16 pg_config
27
32
```
28
33
29
-
Installing from source is also available on macOS and requires the same set of prerequisites and set up commands listed above.
30
-
31
-
💾 Building and Installing the extension
34
+
#### Building and installing the extension
32
35
33
36
Download or clone this repository, and switch to the extension subdirectory, e.g.
@@ -47,11 +50,11 @@ To initialize the extension after installation, enter the following into psql:
47
50
CREATE EXTENSION vectorscale;
48
51
```
49
52
50
-
✏️ Get Involved
53
+
## ✏️ Get Involved
51
54
52
-
The Timescale Vector project is still in it's early stage as we decide our priorities and what to implement. As such, now is a great time to help shape the project's direction! Have a look at the list of features we're thinking of working on and feel free to comment on the features, expand the list, or hop on the Discussions forum for more in-depth discussions.
55
+
The pgvectorscale project is still in it's early stage as we decide our priorities and what to implement. As such, now is a great time to help shape the project's direction! Have a look at the list of features we're thinking of working on and feel free to comment on the features, expand the list, or hop on the Discussions forum for more in-depth discussions.
53
56
54
-
🔨 Testing
57
+
### 🔨 Testing
55
58
See above for prerequisites and installation instructions.
56
59
57
60
You can run tests against a postgres version pg16 using
@@ -64,7 +67,7 @@ To run all tests run:
64
67
cargo test -- --ignored && cargo pgrx test${postgres_version}
65
68
```
66
69
67
-
🐯 About Timescale
70
+
### 🐯 About Timescale
68
71
69
72
TimescaleDB is a distributed time-series database built on PostgreSQL that scales to over 10 million of metrics per second, supports native compression, handles high cardinality, and offers native time-series capabilities, such as data retention policies, continuous aggregate views, downsampling, data gap-filling and interpolation.
0 commit comments