Skip to content

Commit fbe376f

Browse files
committed
Rename cleanup
1 parent 0ecd01b commit fbe376f

File tree

7 files changed

+41
-75
lines changed

7 files changed

+41
-75
lines changed

.github/actions/install-timescaledb/action.yml

Lines changed: 0 additions & 34 deletions
This file was deleted.

.github/workflows/code_checks.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,8 @@ jobs:
88
image: timescaledev/rust-builder:ubuntu-1.65
99

1010
steps:
11-
- name: Checkout Timescale Vector
11+
- name: Checkout
1212
uses: actions/checkout@v3
13-
# extension is small so we do the hacky thing.
14-
# - name: Run Cargo tests
15-
# run: cd pgvectorscale && cargo install --locked cargo-pgrx && cargo pgrx init && cargo pgrx test && cd ..
1613

1714
- name: Verify formatting
1815
run: cd pgvectorscale && cargo fmt --check

.github/workflows/deb-packager.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
TAG_DIR: pgvectorscale
3030

3131
steps:
32-
- name: Checkout Timescale Vector
32+
- name: Checkout pgvectorscale
3333
uses: actions/checkout@v3
3434

3535
- name: Install Linux Packages
@@ -46,10 +46,10 @@ jobs:
4646
pg-src-dir: ~/${{ env.PG_SRC_DIR }}
4747
pg-install-dir: ~/${{ env.PG_INSTALL_DIR }}
4848

49-
- name: Checkout Timescale Vector ${{ env.TAG }}
49+
- name: Checkout ${{ env.TAG }}
5050
uses: actions/checkout@v3
5151
with:
52-
repository: timescale/timescale-vector
52+
repository: timescale/pgvectorscale
5353
ref: '${{ env.TAG }}'
5454
path: ${{ env.TAG_DIR }}
5555

@@ -72,4 +72,4 @@ jobs:
7272
uses: actions/upload-artifact@v3
7373
with:
7474
name: vector-${{ env.TAG }}-pg${{ env.PG_VER }}
75-
path: pkgdump/timescale-vector-*${{ env.TAG }}*.deb
75+
path: pkgdump/pgvectorscale-*${{ env.TAG }}*.deb

.github/workflows/shellcheck.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
sudo apt-get update
2121
sudo apt-get install shellcheck
2222
23-
- name: Checkout Timescale Vector
23+
- name: Checkout
2424
uses: actions/checkout@v3
2525

2626
- name: Run shellcheck

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,42 @@
1-
Timescale Vector
1+
# pgvectorscale
22

33
A vector index for speeding up ANN search in `pgvector`.
44

5-
🔧 Tools Setup
5+
## 💾 Building and Installing pgvectorscale
66

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:
812
```shell
913
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
1014
```
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
1217

1318
```shell
1419
sudo apt-get install make gcc pkg-config clang postgresql-server-dev-16 libssl-dev
1520
```
1621

17-
Next you need cargo-pgx, which can be installed with
22+
Next you need cargo-pgrx, which can be installed with
1823
```shell
1924
cargo install --locked cargo-pgrx
2025
```
2126

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.
2328

24-
Finally, setup the pgx development environment with
29+
Finally, setup the pgrx development environment with
2530
```shell
2631
cargo pgrx init --pg16 pg_config
2732
```
2833

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
3235

3336
Download or clone this repository, and switch to the extension subdirectory, e.g.
3437
```shell
35-
git clone https://github.com/timescale/timescale-vector && \
36-
cd timescale-vector/pgvectorscale
38+
git clone https://github.com/timescale/pgvectorscale && \
39+
cd pgvectorscale/pgvectorscale
3740
```
3841

3942
Then run
@@ -47,11 +50,11 @@ To initialize the extension after installation, enter the following into psql:
4750
CREATE EXTENSION vectorscale;
4851
```
4952

50-
✏️ Get Involved
53+
## ✏️ Get Involved
5154

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.
5356

54-
🔨 Testing
57+
### 🔨 Testing
5558
See above for prerequisites and installation instructions.
5659

5760
You can run tests against a postgres version pg16 using
@@ -64,7 +67,7 @@ To run all tests run:
6467
cargo test -- --ignored && cargo pgrx test ${postgres_version}
6568
```
6669

67-
🐯 About Timescale
70+
### 🐯 About Timescale
6871

6972
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.
7073

pgvectorscale/benches/distance.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
use criterion::{black_box, criterion_group, criterion_main, Criterion};
2-
use pgvectorscale::access_method::distance::{
2+
use vectorscale::access_method::distance::{
33
distance_cosine, distance_l2, distance_l2_optimized_for_few_dimensions,
44
distance_l2_unoptimized, distance_xor_optimized,
55
};

scripts/package-deb.sh

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ set -ex
77
OS_NAME="${3}"
88
BASEDIR="${2}"/pgvectorscale
99
DEBDIR="${PWD}"/pkgdump
10-
TIMESCALE_VECTOR_VERSION="${1}"
10+
PGVECTORSCALE_VERSION="${1}"
1111
PG_VERSIONS="${4}"
1212

1313
echo "$BASEDIR"
@@ -16,7 +16,7 @@ if [ ! -d "$DEBDIR" ]; then
1616
mkdir -p "${DEBDIR}"
1717
fi
1818

19-
DEB_VERSION=${TIMESCALE_VECTOR_VERSION}-${OS_NAME}
19+
DEB_VERSION=${PGVECTORSCALE_VERSION}-${OS_NAME}
2020

2121
# Show what we got to aid debugging.
2222
git log -1
@@ -30,15 +30,15 @@ cd "${BASEDIR}"
3030

3131
# deb-changelog(5)
3232
cat >"${BASEDIR}"/debian/changelog <<EOF
33-
timescale-vector (1:$DEB_VERSION) unused; urgency=medium
34-
* See https://github.com/timescale/timescale-vector/releases/tag/$TIMESCALE_VECTOR_VERSION
33+
pgvectorscale (1:$DEB_VERSION) unused; urgency=medium
34+
* See https://github.com/timescale/pgvectorscale/releases/tag/$PGVECTORSCALE_VERSION
3535
-- $maintainer $date
3636
EOF
3737
# deb-src-control(5)
3838
cat >"${BASEDIR}"/debian/control <<EOF
39-
Source: timescale-vector
39+
Source: pgvectorscale
4040
Maintainer: $maintainer
41-
Homepage: https://github.com/timescale/timescale-vector
41+
Homepage: https://github.com/timescale/pgvectorscale
4242
Rules-Requires-Root: no
4343
Section: vector
4444
Priority: extra
@@ -55,14 +55,14 @@ for pg in $PG_VERSIONS; do
5555
# cargo pgrx package
5656
cat >>"${BASEDIR}"/debian/control <<EOF
5757
58-
Package: timescale-vector-postgresql-$pg
58+
Package: pgvectorscale-postgresql-$pg
5959
Architecture: any
6060
Depends: postgresql-$pg
61-
Description: Timescale Vector Extension for Cloud
61+
Description: pgvectorscale for speeding up ANN search
6262
EOF
6363

64-
echo "target/release/pgvectorscale-pg$pg/$libdir/* usr/lib/postgresql/$pg/lib/" >"${BASEDIR}"/debian/timescale-vector-postgresql-"$pg".install
65-
echo "target/release/pgvectorscale-pg$pg/$sharedir/* usr/share/postgresql/$pg/" >>"${BASEDIR}"/debian/timescale-vector-postgresql-"$pg".install
64+
echo "target/release/pgvectorscale-pg$pg/$libdir/* usr/lib/postgresql/$pg/lib/" >"${BASEDIR}"/debian/pgvectorscale-postgresql-"$pg".install
65+
echo "target/release/pgvectorscale-pg$pg/$sharedir/* usr/share/postgresql/$pg/" >>"${BASEDIR}"/debian/pgvectorscale-postgresql-"$pg".install
6666
done
6767

6868
dpkg-buildpackage --build=binary --no-sign --post-clean
@@ -71,11 +71,11 @@ cd ..
7171

7272
# packagecloud.io doesn't support `.ddeb` files? Like `.udeb`, they're just
7373
# deb packages by another name, so:
74-
for i in timescale-vector*.ddeb; do
74+
for i in pgvectorscale*.ddeb; do
7575
# But it's only on Ubuntu that dpkg-buildpackage creates dbgsym packages
76-
# with the suffix `.ddeb`. On Debian, 'timescale-vector*.ddeb'
77-
# evaluates to 'timescale-vector*.ddeb' so there's nothing to do.
78-
[ "$i" = 'timescale-vector*.ddeb' ] || mv "$i" "${i%.ddeb}".deb
76+
# with the suffix `.ddeb`. On Debian, 'pgvectorscale*.ddeb'
77+
# evaluates to 'pgvectorscale*.ddeb' so there's nothing to do.
78+
[ "$i" = 'pgvectorscale*.ddeb' ] || mv "$i" "${i%.ddeb}".deb
7979
done
8080

81-
cp timescale-vector*.deb "$DEBDIR"
81+
cp pgvectorscale*.deb "$DEBDIR"

0 commit comments

Comments
 (0)