|
1 | 1 | ## Test on GitPod |
2 | 2 | [](https://gitpod.io/#https://github.com/ChakshuGautam/postgres-tsdb-vector-docker) |
3 | 3 |
|
4 | | -## What is TimescaleDB? |
| 4 | +## Postgres |
5 | 5 |
|
6 | | -TimescaleDB is an open-source database designed to make SQL scalable |
7 | | -for time-series data. For more information, see |
8 | | -the [Timescale website](https://www.timescale.com). |
| 6 | +- [x] [PgVector](https://github.com/pgvector/pgvector) |
| 7 | +- [x] [TimescaleDB](https://github.com/timescale/timescaledb) |
9 | 8 |
|
10 | | -## How to use this image |
11 | | - |
12 | | -This image is based on the |
13 | | -official |
14 | | -[Postgres docker image](https://store.docker.com/images/postgres) so |
15 | | -the documentation for that image also applies here, including the |
16 | | -environment variables one can set, extensibility, etc. |
17 | | - |
18 | | -### Starting a TimescaleDB instance |
19 | | - |
20 | | -``` |
21 | | -$ docker run -d --name some-timescaledb -p 5432:5432 timescale/timescaledb:latest-pg13 |
22 | | -``` |
23 | | - |
24 | | -Then connect with an app or the `psql` client: |
25 | | - |
26 | | -``` |
27 | | -$ docker run -it --net=host --rm timescale/timescaledb:latest-pg13 psql -h localhost -U postgres |
28 | | -``` |
29 | | - |
30 | | -You can also connect your app via port `5432` on the host machine. |
31 | | - |
32 | | -If you are running your docker image for the first time, you can also set an environmental variable, `TIMESCALEDB_TELEMETRY`, to set the level of [telemetry](https://docs.timescale.com/using-timescaledb/telemetry) in the Timescale docker instance. For example, to turn off telemetry, run: |
33 | | - |
34 | | -``` |
35 | | -$ docker run -d --name some-timescaledb -p 5432:5432 --env TIMESCALEDB_TELEMETRY=off timescale/timescaledb:latest-pg13 |
36 | | -``` |
37 | | - |
38 | | -Note that if the cluster has previously been initialized, you should not use this environment variable to set the level of telemetry. Instead, follow the [instructions](https://docs.timescale.com/using-timescaledb/telemetry) in our docs to disable telemetry once a cluster is running. |
39 | | - |
40 | | -If you are interested in the latest development snapshot of timescaledb there is also a nightly build available under timescaledev/timescaledb:nightly-pg13 (for PG 12, 13 and 14). |
41 | | - |
42 | | -### Notes on timescaledb-tune |
43 | | - |
44 | | -We run `timescaledb-tune` automatically on container initialization. By default, |
45 | | -`timescaledb-tune` uses system calls to retrieve an instance's available CPU |
46 | | -and memory. In docker images, these system calls reflect the available resources |
47 | | -on the **host**. For cases where a container is allocated all available |
48 | | -resources on a host, this is fine. But many use cases involve limiting the |
49 | | -amount of resources a container (or the docker daemon) can have on the host. |
50 | | -Therefore, this image looks in the cgroups metadata to determine the |
51 | | -docker-defined limit sizes then passes those values to `timescaledb-tune`. |
52 | | - |
53 | | -To specify your own limits, use the `TS_TUNE_MEMORY` and `TS_TUNE_NUM_CPUS` |
54 | | -environment variables at runtime: |
55 | | - |
56 | | -``` |
57 | | -$ docker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password -e TS_TUNE_MEMORY=4GB -e TS_TUNE_NUM_CPUS=4 timescale/timescaledb:latest-pg13 |
58 | | -``` |
59 | | - |
60 | | -To specify a maximum number of [background workers](https://docs.timescale.com/timescaledb/latest/how-to-guides/configuration/about-configuration/#workers), use the `TS_TUNE_MAX_BG_WORKERS` environment variable: |
61 | | - |
62 | | -``` |
63 | | -$ docker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password -e TS_TUNE_MAX_BG_WORKERS=16 timescale/timescaledb:latest-pg13 |
64 | | -``` |
65 | | - |
66 | | -To specify a [maximum number of connections](https://www.postgresql.org/docs/current/runtime-config-connection.html), use the `TS_TUNE_MAX_CONNS` environment variable: |
67 | | - |
68 | | -``` |
69 | | -$ docker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password -e TS_TUNE_MAX_CONNS=200 timescale/timescaledb:latest-pg13 |
70 | | -``` |
71 | | - |
72 | | -To not run `timescaledb-tune` at all, use the `NO_TS_TUNE` environment variable: |
73 | | - |
74 | | -``` |
75 | | -$ docker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password -e NO_TS_TUNE=true timescale/timescaledb:latest-pg13 |
76 | | -``` |
0 commit comments