Skip to content
This repository has been archived by the owner on Apr 2, 2024. It is now read-only.

Commit

Permalink
Update extension compilation instructions
Browse files Browse the repository at this point in the history
Add text about dependencies on Rust and PostgreSQL headers.

Fixes #247
  • Loading branch information
cevian committed Sep 17, 2020
1 parent 4acf795 commit 0f5d0c1
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion extension/Readme.md
Expand Up @@ -7,7 +7,12 @@ cause it to perform better.

## Requirements ##

This extension requires Postgres version 12 or newer.
To run the extension:
- PostgreSQL version 12 or newer.

To compile the extension:
- Header files for PostgreSQL version 12 or newer. Headers are included in the `postgresql-server-dev-12` package in Debian or Ubuntu. For other platforms see the PostgreSQL [download page](https://www.postgresql.org/download/).
- [Rust compiler](https://www.rust-lang.org/tools/install)

## Installation ##

Expand All @@ -17,3 +22,8 @@ The extension is installed by default on the
To compile and install from source run: `make && make install`.

This extension will be created via `CREATE EXTENSION` automatically by the timescale-prometheus connector and should not be created manually.

## Common Compilation Issues ##

- `cargo: No such file or directory` means the [Rust compiler](https://www.rust-lang.org/tools/install) is not installed
- `postgres.h` not found means that you are missing the PostgreSQL header files. If using Debian or Ubuntu simply install the `postgresql-server-dev-12` package. For other platforms see the PostgreSQL [download page](https://www.postgresql.org/download/).

0 comments on commit 0f5d0c1

Please sign in to comment.